The text element factory is the abstract base class for all text element factory implementations. It provides common
properties shared among all text elements.
author: Thomas Morgner
setReservedLiteral(String reservedLiteral) Defines the defined reserved literal, which should be appended to the text to signal text, which was not completly
printed.
public void
setStrikethrough(Boolean strikethrough) Defines the state of the strike through flag for the font.
Applies the defined element style to the given stylesheet. This is a helper function to reduce the code size of the
implementors.
Parameters: style - the stlyesheet.
Returns the state of the bold flag for the font. This method may return null to indicate that that value should be
inherited from the parents.
the bold-flag.
Returns the state of the italic flag for the font. This method may return null to indicate that that value should
be inherited from the parents.
the italic-flag.
Returns the lineheight defined for the text element. The lineheight must be greater than the font size, or this
value will be ignored.
the line height.
Returns the defined maximum letter spacing for a text element. This property controls how the justify-alignment
distributes extra space on a line.
the maximum letter spacing or null, if undefined.
Returns the defined minimum letter spacing for a text element. This property controls how the justify-alignment
distributes extra space on a line and controls how much extra space is applied between the characters of a text.
the minimum letter spacing or null, if undefined.
Return optimum letter spacing for a text element. This property controls how the justify-alignment distributes
extra space on a line.
the optimum letter spacing or null, if undefined.
Returns the state of the strike through flag for the font. This method may return null to indicate that that value
should be inherited from the parents.
the strike-through-flag.
Returns, whether the text lines should be trimmed.
Boolean.TRUE, if the text should be trimmed, Boolean.FALSE if the text should never be trimmed or null, ifthe default should be applied.
Returns the state of the underline flag for the font. This method may return null to indicate that that value
should be inherited from the parents.
the underline-flag.
Returns how the layouter treats whitespaces in the text of a text-element.
the white space collapse constant or null, if undefined. See Also:WhitespaceCollapse
Defines the state of the bold flag for the font. This value may be set to null to indicate that that value should
be inherited from the parents.
Parameters: bold - the bold-flag.
Defines the font encoding used to write the text. This parameter is only used by some output targets and will be
ignored otherwise.
Parameters: encoding - the font encoding.
Defines the state of the italic flag for the font. This value may be set to null to indicate that that value should
be inherited from the parents.
Parameters: italic - the italic-flag.
Defines the lineheight defined for the text element. The lineheight must be greater than the font size, or this
value will be ignored.
Parameters: lineHeight - the line height.
setMaximumLetterSpacing
public void setMaximumLetterSpacing(Float maximumLetterSpacing)(Code)
Defines the maximum letter spacing for a text element. This property controls how the justify-alignment distributes
extra space on a line.
Parameters: maximumLetterSpacing - the maximum letter spacing.
setMinimumLetterSpacing
public void setMinimumLetterSpacing(Float minimumLetterSpacing)(Code)
Defines the minimum letter spacing for a text element. This property controls how the justify-alignment distributes
extra space on a line and controls how much extra space is applied between the characters of a text.
Parameters: minimumLetterSpacing - the minimum letter spacing or null, if undefined.
setOptimumLetterSpacing
public void setOptimumLetterSpacing(Float optimumLetterSpacing)(Code)
Defines the optimum letter spacing for a text element. This property controls how the justify-alignment distributes
extra space on a line.
Parameters: optimumLetterSpacing - the optimum letter spacing or null, if undefined.
setReservedLiteral
public void setReservedLiteral(String reservedLiteral)(Code)
Defines the defined reserved literal, which should be appended to the text to signal text, which was not completly
printed.
Parameters: reservedLiteral - the reserved literal.
setStrikethrough
public void setStrikethrough(Boolean strikethrough)(Code)
Defines the state of the strike through flag for the font. This value may be set to null to indicate that that
value should be inherited from the parents.
Parameters: strikethrough - the strikethrough-flag.
setTrimTextContent
public void setTrimTextContent(Boolean trimTextContent)(Code)
Defines, whether the text lines should be trimmed.
Parameters: trimTextContent - Boolean.TRUE, if the text should be trimmed, Boolean.FALSE if the text should never betrimmed or null, if the default should be applied.
Defines the state of the underline flag for the font. This value may be set to null to indicate that that value
should be inherited from the parents.
Parameters: underline - the underline-flag.
Defines the vertical text alignment for this element.
Parameters: verticalTextAlignment - the vertical text alignment property or null, if the property should not be defined.
Defines how to treat whitespaces in the text of a text-element.
Parameters: whitespaceCollapse - the white space collapse constant or null, if undefined. See Also:WhitespaceCollapse