com.helger.pdflayout.element.text

Class AbstractPLText<IMPLTYPE extends AbstractPLText<IMPLTYPE>>

java.lang.Object

com.helger.pdflayout.base.AbstractPLObject<IMPLTYPE>

com.helger.pdflayout.base.AbstractPLRenderableObject<IMPLTYPE>

com.helger.pdflayout.base.AbstractPLElement<IMPLTYPE>

com.helger.pdflayout.base.AbstractPLAlignedElement<IMPLTYPE>

com.helger.pdflayout.element.text.AbstractPLText<IMPLTYPE>

Type Parameters:

IMPLTYPE - Implementation type

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>, IPLElement<IMPLTYPE>, IPLHasBorder<IMPLTYPE>, IPLHasFillColor<IMPLTYPE>, IPLHasHorizontalAlignment<IMPLTYPE>, IPLHasMargin<IMPLTYPE>, IPLHasMarginBorderPadding<IMPLTYPE>, IPLHasOutline, IPLHasPadding<IMPLTYPE>, IPLHasVerticalAlignment<IMPLTYPE>, IPLObject<IMPLTYPE>, IPLRenderableObject<IMPLTYPE>

Direct Known Subclasses:

PLText, PLTextSplittable

public abstract class AbstractPLText<IMPLTYPE extends AbstractPLText<IMPLTYPE>>
extends AbstractPLAlignedElement<IMPLTYPE>

Render text

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_ROWS
static boolean	DEFAULT_TOP_DOWN
protected List<TextAndWidthSpec>	m_aPreparedLines
protected com.helger.commons.collection.ext.ICommonsList<TextAndWidthSpec>	m_aPreparedLinesUnmodified
protected float	m_fLineHeight
protected int	m_nPreparedLineCountUnmodified

Fields inherited from interface com.helger.pdflayout.base.IPLHasHorizontalAlignment

DEFAULT_HORZ_ALIGNMENT

Fields inherited from interface com.helger.pdflayout.base.IPLHasVerticalAlignment

DEFAULT_VERT_ALIGNMENT

Fields inherited from interface com.helger.pdflayout.base.IPLRenderableObject

DEFAULT_MAX_SIZE, DEFAULT_MIN_SIZE

Fields inherited from interface com.helger.pdflayout.base.IPLHasMargin

DEFAULT_MARGIN

Fields inherited from interface com.helger.pdflayout.base.IPLHasPadding

DEFAULT_PADDING

Fields inherited from interface com.helger.pdflayout.base.IPLHasBorder

DEFAULT_BORDER

Fields inherited from interface com.helger.pdflayout.base.IPLHasFillColor

DEFAULT_FILL_COLOR

Constructor Summary

Constructors

Constructor and Description
AbstractPLText(String sText, FontSpec aFontSpec)

Method Summary

Modifier and Type	Method and Description
com.helger.commons.collection.ext.ICommonsList<TextAndWidthSpec>	getAllPreparedLinesUnmodified()
PLElementWithSize	getCopy(float fElementWidth, List<TextAndWidthSpec> aLines, boolean bSplittableCopy)
protected float	getDisplayHeightOfLines(int nLineCount)
FontSpec	getFontSpec()
int	getMaxRows()
int	getPreparedLineCountUnmodified()
String	getText()
protected String	getTextToDraw(String sText, RenderingContext aCtx) Get the text to draw, in case it is different from the stored text (e.g.
boolean	hasNoText()
boolean	hasText()
boolean	isTopDown()
protected void	onPerform(RenderingContext aCtx) Abstract method to be implemented by subclasses.
protected SizeSpec	onPrepare(PreparationContext aCtx) The abstract method that must be implemented by all subclasses.
IMPLTYPE	setBasicDataFrom(AbstractPLText<?> aSource)
IMPLTYPE	setMaxRows(int nMaxRows) Set the maximum number of rows to render.
IMPLTYPE	setTopDown(boolean bTopDown) Set the rendering direction: top-down or bottom-up.
String	toString()

Methods inherited from class com.helger.pdflayout.base.AbstractPLAlignedElement

getHorzAlign, getVertAlign, setBasicDataFrom, setHorzAlign, setVertAlign

Methods inherited from class com.helger.pdflayout.base.AbstractPLElement

getBorder, getFillColor, getMargin, getPadding, setBasicDataFrom, setBorder, setFillColor, setMargin, setPadding

Methods inherited from class com.helger.pdflayout.base.AbstractPLRenderableObject

getMaxSize, getMinSize, getPreparedSize, internalCheckNotPrepared, internalMarkAsNotPrepared, internalMarkAsPrepared, isPrepared, onPerformFillAndBorder, perform, prepare, setMaxSize, setMinSize

Methods inherited from class com.helger.pdflayout.base.AbstractPLObject

getDebugID, getID, setBasicDataFrom, setID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.pdflayout.base.IPLObject

getAsSplittable, getDebugID, isSplittable

Methods inherited from interface com.helger.commons.id.IHasID

getComparatorID, getID

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

Methods inherited from interface com.helger.pdflayout.base.IPLRenderableObject

doPageSetup, getMaxSize, getMinSize, getPreparedSize, isPrepared, perform, prepare, setExactSize, setMaxSize, setMinSize

Methods inherited from interface com.helger.pdflayout.base.IPLHasMarginBorderPadding

getFullBottom, getFullLeft, getFullRight, getFullTop, getFullXSum, getFullYSum, getMarginAndBorderBottom, getMarginAndBorderLeft, getMarginAndBorderRight, getMarginAndBorderTop, getMarginAndBorderXSum, getMarginAndBorderYSum

Methods inherited from interface com.helger.pdflayout.base.IPLHasMargin

getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMarginXSum, getMarginYSum, setMargin, setMargin, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop

Methods inherited from interface com.helger.pdflayout.base.IPLHasPadding

getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPaddingXSum, getPaddingYSum, setPadding, setPadding, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop

Methods inherited from interface com.helger.pdflayout.base.IPLHasBorder

getBorderBottomWidth, getBorderLeftWidth, getBorderRightWidth, getBorderTopWidth, getBorderXSumWidth, getBorderYSumWidth, setBorder, setBorder, setBorder, setBorderBottom, setBorderLeft, setBorderRight, setBorderTop

Methods inherited from interface com.helger.pdflayout.base.IPLHasFillColor

hasFillColor

Field Detail

DEFAULT_TOP_DOWN

public static final boolean DEFAULT_TOP_DOWN

See Also:

Constant Field Values

DEFAULT_MAX_ROWS

public static final int DEFAULT_MAX_ROWS

See Also:

Constant Field Values

m_nPreparedLineCountUnmodified

protected int m_nPreparedLineCountUnmodified

m_aPreparedLinesUnmodified

protected com.helger.commons.collection.ext.ICommonsList<TextAndWidthSpec> m_aPreparedLinesUnmodified

m_aPreparedLines

@CodingStyleguideUnaware
protected List<TextAndWidthSpec> m_aPreparedLines

m_fLineHeight

protected float m_fLineHeight

Constructor Detail

AbstractPLText

public AbstractPLText(@Nullable
                      String sText,
                      @Nonnull
                      FontSpec aFontSpec)

Method Detail

getText

@Nonnull
public String getText()

hasText

public boolean hasText()

hasNoText

public boolean hasNoText()

getFontSpec

@Nonnull
public FontSpec getFontSpec()

setBasicDataFrom

@Nonnull
 @OverridingMethodsMustInvokeSuper
public IMPLTYPE setBasicDataFrom(@Nonnull
                                                                               AbstractPLText<?> aSource)

isTopDown

public boolean isTopDown()

Returns:

true if the text is rendered from top to bottom, or false if the text is rendered from bottom to top. The default value is DEFAULT_TOP_DOWN.

setTopDown

@Nonnull
public IMPLTYPE setTopDown(boolean bTopDown)

Set the rendering direction: top-down or bottom-up.

Parameters:

bTopDown - true to render top-down, false to render bottom-up.

Returns:

this

getMaxRows

@CheckForSigned
public int getMaxRows()

Returns:

The maximum number of rows to be rendered. If this value is ≤ 0 than all rows are rendered. The default value is DEFAULT_MAX_ROWS.

setMaxRows

@Nonnull
public IMPLTYPE setMaxRows(int nMaxRows)

Set the maximum number of rows to render.

Parameters:

nMaxRows - Maximum number of rows. If ≤ 0 than all lines are rendered.

Returns:

this

onPrepare

protected SizeSpec onPrepare(@Nonnull
                             PreparationContext aCtx)
                      throws IOException

Description copied from class: AbstractPLRenderableObject

The abstract method that must be implemented by all subclasses. It is ensured that this method is called only once per instance!

Specified by:

onPrepare in class AbstractPLRenderableObject<IMPLTYPE extends AbstractPLText<IMPLTYPE>>

Parameters:

aCtx - Preparation context. Never null.

Returns:

The size of the rendered element without padding, border and margin. May not be null.

Throws:

IOException - on error

getPreparedLineCountUnmodified

@Nonnegative
public int getPreparedLineCountUnmodified()

Returns:

The total number of prepared lines, not taking the maxRows into consideration. Always ≥ 0.

getAllPreparedLinesUnmodified

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.ext.ICommonsList<TextAndWidthSpec> getAllPreparedLinesUnmodified()

getTextToDraw

@Nonnull
 @OverrideOnDemand
protected String getTextToDraw(@Nonnull
                                                             String sText,
                                                             @Nonnull
                                                             RenderingContext aCtx)

Get the text to draw, in case it is different from the stored text (e.g. for page numbers in PLTextWithPlaceholders)

Parameters:

sText - Original text. Never null.

aCtx - The current rendering context. Never null.

Returns:

The real text to draw. May not be null.

onPerform

protected void onPerform(@Nonnull
                         RenderingContext aCtx)
                  throws IOException

Description copied from class: AbstractPLRenderableObject

Abstract method to be implemented by subclasses.

Specified by:

onPerform in class AbstractPLRenderableObject<IMPLTYPE extends AbstractPLText<IMPLTYPE>>

Parameters:

aCtx - Rendering context

Throws:

IOException - In case of a PDFBox error

getDisplayHeightOfLines

protected final float getDisplayHeightOfLines(@Nonnegative
                                              int nLineCount)

getCopy

@Nonnull
public PLElementWithSize getCopy(float fElementWidth,
                                           @Nonnull @Nonempty
                                           List<TextAndWidthSpec> aLines,
                                           boolean bSplittableCopy)

toString

public String toString()

Overrides:

toString in class AbstractPLAlignedElement<IMPLTYPE extends AbstractPLText<IMPLTYPE>>