Package 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.AbstractPLInlineElement<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>, IPLInlineElement<IMPLTYPE>, IPLObject<IMPLTYPE>, IPLRenderableObject<IMPLTYPE>, IPLSplittableObject<IMPLTYPE,IMPLTYPE>, IPLVisitable

Direct Known Subclasses:

PLText

public abstract class AbstractPLText<IMPLTYPE extends AbstractPLText<IMPLTYPE>>
extends AbstractPLInlineElement<IMPLTYPE>
implements IPLHasHorizontalAlignment<IMPLTYPE>, IPLSplittableObject<IMPLTYPE,IMPLTYPE>

Render text

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static final float	DEFAULT_LINE_SPACING
static final int	DEFAULT_MAX_ROWS
static final boolean	DEFAULT_REPLACE_PLACEHOLDERS
protected com.helger.commons.collection.impl.ICommonsList<TextAndWidthSpec>	m_aPreparedLines
protected com.helger.commons.collection.impl.ICommonsList<TextAndWidthSpec>	m_aPreparedLinesUnmodified
protected float	m_fDescent
protected float	m_fTextHeight
protected int	m_nPreparedLineCountUnmodified

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

DEFAULT_MAX_SIZE, DEFAULT_MIN_SIZE

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

DEFAULT_BORDER

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

DEFAULT_FILL_COLOR

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

DEFAULT_HORZ_ALIGNMENT

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.IPLSplittableObject

DEFAULT_VERT_SPLITTABLE

Constructor Summary

Constructors

Constructor	Description
AbstractPLText(String sText, FontSpec aFontSpec)

Method Summary

Modifier and Type	Method	Description
com.helger.commons.state.EChange	beforeRender(PagePreRenderContext aCtx)	Called after the page was created but before the content stream is created.
com.helger.commons.collection.impl.ICommonsList<TextAndWidthSpec>	getAllPreparedLinesUnmodified()
static String	getCleanedPLText(String sText)
final float	getCustomAscentFirstLine()
protected final float	getDisplayHeightOfLineCount(int nLineCount, boolean bLineSpacingAlsoOnLastLine)
final FontSpec	getFontSpec()
final EHorzAlignment	getHorzAlign()
final float	getLineSpacing()
final int	getMaxRows()
int	getPreparedLineCountUnmodified()
final String	getText()
final boolean	hasNoText()
final boolean	hasText()
final boolean	isReplacePlaceholder()
final boolean	isVertSplittable()
protected void	onMarkAsNotPrepared()	PL objects need to overwrite this method to reset their preparation state.
protected SizeSpec	onPrepare(PreparationContext aCtx)	The abstract method that must be implemented by all subclasses.
protected void	onRender(PageRenderContext aCtx)	Abstract method to be implemented by subclasses.
IMPLTYPE	setBasicDataFrom(IMPLTYPE aSource)	For copying stuff internally.
final IMPLTYPE	setCustomAscentFirstLine(float fCustomAscentFirstLine)	Set a custom ascent to the first line
final IMPLTYPE	setHorzAlign(EHorzAlignment eHorzAlign)	Set the horizontal alignment of this element.
final IMPLTYPE	setLineSpacing(float fLineSpacing)	Set the line spacing to use.
final IMPLTYPE	setMaxRows(int nMaxRows)	Set the maximum number of rows to render.
final IMPLTYPE	setReplacePlaceholder(boolean bReplacePlaceholder)	Change whether placeholders should be replaced or not.
final IMPLTYPE	setVertSplittable(boolean bVertSplittable)	Change the vertical splitability of this object.
PLSplitResult	splitElementVert(float fElementWidth, float fAvailableHeight)	Split this element vertically into sub-elements according to the available height.
String	toString()

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

getBorder, getFillColor, getMargin, getMaxSize, getMinSize, getPadding, getRenderSize, setBorder, setFillColor, setMargin, setMaxSize, setMinSize, setPadding

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

getPrepareAvailableSize, getPreparedSize, getRenderSize, internalCheckAlreadyPrepared, internalCheckNotPrepared, internalMarkAsNotPrepared, internalMarkAsNotPreparedDontPropagate, internalMarkAsPrepared, isPrepared, onRenderSizeChange, prepare, render, visit

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

getDebugID, getID, onAfterSetID, setID

Methods inherited from class java.lang.Object

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

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

thisAsT

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

getID

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

getMaxHeight, getMaxSize, getMaxWidth, getMinHeight, getMinSize, getMinWidth, setExactHeight, setExactSize, setExactWidth, setMaxHeight, setMaxSize, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinSize, setMinWidth

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

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

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

getFillColor, hasFillColor, setFillColor

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

getIndentX

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

addMarginBottom, addMarginLeft, addMarginRight, addMarginTop, addMarginX, addMarginY, getMargin, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMarginXSum, getMarginYSum, setMargin, setMargin, setMargin, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMarginX, setMarginY

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

getOutlineBottom, getOutlineLeft, getOutlineRight, getOutlineTop, getOutlineXSum, getOutlineYSum

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

addPaddingBottom, addPaddingLeft, addPaddingRight, addPaddingTop, addPaddingX, addPaddingY, getPadding, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPaddingXSum, getPaddingYSum, setPadding, setPadding, setPadding, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPaddingX, setPaddingY

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

getAsSplittable, getDebugID, hasID

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

getPreparedHeight, getPreparedSize, getPreparedWidth, getRenderHeight, getRenderSize, getRenderWidth, isPrepared, prepare, render

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

internalCreateNewVertSplitObject

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

visit

Field Details

DEFAULT_LINE_SPACING

public static final float DEFAULT_LINE_SPACING

See Also:

• Constant Field Values

DEFAULT_MAX_ROWS

public static final int DEFAULT_MAX_ROWS

See Also:

• Constant Field Values

DEFAULT_REPLACE_PLACEHOLDERS

public static final boolean DEFAULT_REPLACE_PLACEHOLDERS

See Also:

• Constant Field Values

m_fTextHeight

protected float m_fTextHeight

m_fDescent

protected float m_fDescent

m_nPreparedLineCountUnmodified

protected int m_nPreparedLineCountUnmodified

m_aPreparedLinesUnmodified

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

m_aPreparedLines

protected com.helger.commons.collection.impl.ICommonsList<TextAndWidthSpec> m_aPreparedLines

Constructor Details

AbstractPLText

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

Method Details

getCleanedPLText

@Nonnull
public static String getCleanedPLText(@Nullable
 String sText)

setBasicDataFrom

@Nonnull
@OverridingMethodsMustInvokeSuper
public IMPLTYPE setBasicDataFrom(@Nonnull
 IMPLTYPE aSource)

Description copied from interface: IPLObject

For copying stuff internally. Must always call super method

Specified by:

setBasicDataFrom in interface IPLObject<IMPLTYPE extends AbstractPLText<IMPLTYPE>>

Overrides:

setBasicDataFrom in class AbstractPLInlineElement<IMPLTYPE extends AbstractPLText<IMPLTYPE>>

Parameters:

aSource - Source object to copy from. May not be null.

Returns:

this for chaining

getText

@Nonnull
public final String getText()

Returns:

The original text provided in the constructor, with newlines unified. Never null.

hasText

public final boolean hasText()

Returns:

true if the contained text has at least one character, false if it is empty.

hasNoText

public final boolean hasNoText()

Returns:

true if the text provided in the constructor contains no character, false otherwise.

getFontSpec

@Nonnull
public final FontSpec getFontSpec()

Returns:

The font specification to be used as provided in the constructor. Never null.

getLineSpacing

public final float getLineSpacing()

Returns:

The line height factor. Defaults to DEFAULT_LINE_SPACING which means 100%.

setLineSpacing

@Nonnull
public final IMPLTYPE setLineSpacing(@Nonnegative
 float fLineSpacing)

Set the line spacing to use. The line spacing is the distance between 2 consecutive lines. The line spacing is not considered if there is a single line of text.

Parameters:

fLineSpacing - A value of 1 means 100%, 1.05 means 105% etc. Must be > 0.

Returns:

this for chaining

getHorzAlign

@Nonnull
public final EHorzAlignment getHorzAlign()

Specified by:

getHorzAlign in interface IPLHasHorizontalAlignment<IMPLTYPE extends AbstractPLText<IMPLTYPE>>

Returns:

The horizontal alignment of this element. By default it is EHorzAlignment.DEFAULT. Never null. The horizontal alignment may only be applied to contained children!

setHorzAlign

@Nonnull
public final IMPLTYPE setHorzAlign(@Nonnull
 EHorzAlignment eHorzAlign)

Description copied from interface: IPLHasHorizontalAlignment

Set the horizontal alignment of this element. The horizontal alignment may only be applied to contained children!

Specified by:

setHorzAlign in interface IPLHasHorizontalAlignment<IMPLTYPE extends AbstractPLText<IMPLTYPE>>

Parameters:

eHorzAlign - The new horizontal alignment. May not be null.

Returns:

this

getMaxRows

@CheckForSigned
public final 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 meaning all rows are rendered.

setMaxRows

@Nonnull
public final 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 for chaining

isVertSplittable

public final boolean isVertSplittable()

Specified by:

isVertSplittable in interface IPLObject<IMPLTYPE extends AbstractPLText<IMPLTYPE>>

Specified by:

isVertSplittable in interface IPLSplittableObject<IMPLTYPE extends AbstractPLText<IMPLTYPE>,IMPLTYPE extends AbstractPLText<IMPLTYPE>>

Returns:

true if this element is splittable, false otherwise.

setVertSplittable

@Nonnull
public final IMPLTYPE setVertSplittable(boolean bVertSplittable)

Description copied from interface: IPLSplittableObject

Change the vertical splitability of this object.

Specified by:

setVertSplittable in interface IPLSplittableObject<IMPLTYPE extends AbstractPLText<IMPLTYPE>,IMPLTYPE extends AbstractPLText<IMPLTYPE>>

Parameters:

bVertSplittable - true if this element is splittable, false otherwise.

Returns:

this for chaining

isReplacePlaceholder

public final boolean isReplacePlaceholder()

Returns:

true if placeholders should be replaced, false otherwise. The default value is DEFAULT_REPLACE_PLACEHOLDERS so false.

setReplacePlaceholder

@Nonnull
public final IMPLTYPE setReplacePlaceholder(boolean bReplacePlaceholder)

Change whether placeholders should be replaced or not. Enabling this slows down the execution of rendering. Enable this only if absolutely necessary.

Parameters:

bReplacePlaceholder - true if placeholders should be replaced, false otherwise.

Returns:

this for chaining

getCustomAscentFirstLine

public final float getCustomAscentFirstLine()

Returns:

A custom ascent to the first line. Defaults to 0.

Since:

5.1.0

setCustomAscentFirstLine

@Nonnull
public final IMPLTYPE setCustomAscentFirstLine(float fCustomAscentFirstLine)

Set a custom ascent to the first line

Parameters:

fCustomAscentFirstLine - The value to use. 0 means no change.

Returns:

this for chaining

Since:

5.1.0

onPrepare

protected SizeSpec onPrepare(@Nonnull
 PreparationContext aCtx)

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.

onMarkAsNotPrepared

protected void onMarkAsNotPrepared()

Description copied from class: AbstractPLRenderableObject

PL objects need to overwrite this method to reset their preparation state. They also need to propagate this to their children!

Specified by:

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

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.impl.ICommonsList<TextAndWidthSpec> getAllPreparedLinesUnmodified()

getDisplayHeightOfLineCount

protected final float getDisplayHeightOfLineCount(@Nonnegative
 int nLineCount,
 boolean bLineSpacingAlsoOnLastLine)

splitElementVert

@Nullable
public PLSplitResult splitElementVert(float fElementWidth,
 float fAvailableHeight)

Description copied from interface: IPLSplittableObject

Split this element vertically into sub-elements according to the available height. Splitting is always done after preparation and must return prepared objects!

Specified by:

splitElementVert in interface IPLSplittableObject<IMPLTYPE extends AbstractPLText<IMPLTYPE>,IMPLTYPE extends AbstractPLText<IMPLTYPE>>

Parameters:

fElementWidth - The available width without outline of the element.

fAvailableHeight - The available height without outline of this element. Must be ≥ 0.

Returns:

null if splitting makes no sense.

beforeRender

@Nonnull
public com.helger.commons.state.EChange beforeRender(@Nonnull
 PagePreRenderContext aCtx)
                                              throws IOException

Description copied from interface: IPLRenderableObject

Called after the page was created but before the content stream is created. This is e.g. used for images to create their XObjects upfront.

Specified by:

beforeRender in interface IPLRenderableObject<IMPLTYPE extends AbstractPLText<IMPLTYPE>>

Parameters:

aCtx - The current page render context. Never null.

Returns:

EChange.CHANGED if something changed. May not be null.

Throws:

IOException - In case of a PDFBox error

onRender

protected void onRender(@Nonnull
 PageRenderContext aCtx)
                 throws IOException

Description copied from class: AbstractPLRenderableObject

Abstract method to be implemented by subclasses.

Specified by:

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

Parameters:

aCtx - Rendering context. Never null.

Throws:

IOException - In case of a PDFBox error

toString

public String toString()

Overrides:

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