public class StructureTextState extends Object
Represents text state settings for Text Structure Elements and TaggedContent (ITextElement, ITaggedContent)
Constructor and Description |
---|
StructureTextState()
Default constructor
|
Modifier and Type | Method and Description |
---|---|
TextState |
createTextState()
Create Text State
|
Color |
getBackgroundColor()
Gets or sets background color of the text.
|
Float[] |
getCharacterSpacing()
Gets or sets character spacing of the text.
|
Font |
getFont()
Gets or sets the font of text.
|
Float[] |
getFontSize()
Gets or sets font size of the text.
|
Integer[] |
getFontStyle()
Gets or sets font style of the text.
|
Color |
getForegroundColor()
Gets or sets foreground color of the text.
|
Float[] |
getHorizontalScaling()
Gets or sets horizontal scaling of the text.
|
Float[] |
getLineSpacing()
Gets or sets line spacing of the text.
|
MarginInfo |
getMarginInfo()
Gets or sets margin for block structure element.
|
Boolean[] |
getStrikeOut()
Gets or sets strikeout for the text.
|
Boolean[] |
getSubscript()
Gets or sets subscript of the text.
|
Boolean[] |
getSuperscript()
Gets or sets superscript of the text.
|
Boolean[] |
getUnderline()
Gets or sets underline for the text.
|
Float[] |
getWordSpacing()
Gets or sets word spacing of the text.
|
void |
setBackgroundColor(Color value)
Gets or sets background color of the text.
|
void |
setCharacterSpacing(Float value)
Gets or sets character spacing of the text.
|
void |
setFont(Font value)
Gets or sets the font of text.
|
void |
setFontSize(Float value)
Gets or sets font size of the text.
|
void |
setFontStyle(Integer value)
Gets or sets font style of the text.
|
void |
setForegroundColor(Color value)
Gets or sets foreground color of the text.
|
void |
setHorizontalScaling(Float value)
Gets or sets horizontal scaling of the text.
|
void |
setLineSpacing(Float value)
Gets or sets line spacing of the text.
|
void |
setMarginInfo(MarginInfo value)
Gets or sets margin for block structure element.
|
void |
setStrikeOut(Boolean value)
Gets or sets strikeout for the text.
|
void |
setSubscript(Boolean value)
Gets or sets subscript of the text.
|
void |
setSuperscript(Boolean value)
Gets or sets superscript of the text.
|
void |
setUnderline(Boolean value)
Gets or sets underline for the text.
|
void |
setWordSpacing(Float value)
Gets or sets word spacing of the text.
|
void |
update(StructureTextState structureTextState)
Update elements
|
public final Font getFont()
Gets or sets the font of text.
Can be null. Use null to inherit Font
property from parent structure element.
public final void setFont(Font value)
Gets or sets the font of text.
Can be null. Use null to inherit Font
property from parent structure element.
value
- Font instancepublic final Float[] getFontSize()
Gets or sets font size of the text.
Can be null. Use null to inherit FontSize
property from parent structure element.
public final void setFontSize(Float value)
Gets or sets font size of the text.
Can be null. Use null to inherit FontSize
property from parent structure element.
value
- Float valuepublic final Integer[] getFontStyle()
Gets or sets font style of the text.
Can be null. Use null to inherit FontStyle
property from parent structure element.
public final void setFontStyle(Integer value)
Gets or sets font style of the text.
Can be null. Use null to inherit FontStyle
property from parent structure element.
value
- FontStyle element valuepublic final Color getForegroundColor()
Gets or sets foreground color of the text.
Can be null. Use null to inherit ForegroundColor
property from parent structure element.
public final void setForegroundColor(Color value)
Gets or sets foreground color of the text.
Can be null. Use null to inherit ForegroundColor
property from parent structure element.
value
- Color instancepublic final Color getBackgroundColor()
Gets or sets background color of the text.
Can be null. Use null to inherit BackgroundColor
property from parent structure element.
public final void setBackgroundColor(Color value)
Gets or sets background color of the text.
Can be null. Use null to inherit BackgroundColor
property from parent structure element.
value
- Color instancepublic final Boolean[] getUnderline()
Gets or sets underline for the text.
Can be null. Use null to inherit Underline
property from parent structure element.
public final void setUnderline(Boolean value)
Gets or sets underline for the text.
Can be null. Use null to inherit Underline
property from parent structure element.
value
- Boolean valuepublic final Boolean[] getStrikeOut()
Gets or sets strikeout for the text.
Can be null. Use null to inherit StrikeOut
property from parent structure element.
public final void setStrikeOut(Boolean value)
Gets or sets strikeout for the text.
Can be null. Use null to inherit StrikeOut
property from parent structure element.
value
- Boolean valuepublic final Boolean[] getSuperscript()
Gets or sets superscript of the text.
Can be null. Use null to inherit Superscript
property from parent structure element.
public final void setSuperscript(Boolean value)
Gets or sets superscript of the text.
Can be null. Use null to inherit Superscript
property from parent structure element.
value
- Boolean valuepublic final Boolean[] getSubscript()
Gets or sets subscript of the text.
Can be null. Use null to inherit Subscript
property from parent structure element.
public final void setSubscript(Boolean value)
Gets or sets subscript of the text.
Can be null. Use null to inherit Subscript
property from parent structure element.
value
- Boolean valuepublic final Float[] getHorizontalScaling()
Gets or sets horizontal scaling of the text.
Can be null. Use null to inherit HorizontalScaling
property from parent structure element.
public final void setHorizontalScaling(Float value)
Gets or sets horizontal scaling of the text.
Can be null. Use null to inherit HorizontalScaling
property from parent structure element.
value
- Float valuepublic final Float[] getLineSpacing()
Gets or sets line spacing of the text.
Can be null. Use null to inherit LineSpacing
property from parent structure element.
public final void setLineSpacing(Float value)
Gets or sets line spacing of the text.
Can be null. Use null to inherit LineSpacing
property from parent structure element.
value
- Float valuepublic final Float[] getCharacterSpacing()
Gets or sets character spacing of the text.
Can be null. Use null to inherit CharacterSpacing
property from parent structure element.
public final void setCharacterSpacing(Float value)
Gets or sets character spacing of the text.
Can be null. Use null to inherit CharacterSpacing
property from parent structure element.
value
- Float valuepublic final Float[] getWordSpacing()
Gets or sets word spacing of the text.
Can be null. Use null to inherit WordSpacing
property from parent structure element.
public final void setWordSpacing(Float value)
Gets or sets word spacing of the text.
Can be null. Use null to inherit WordSpacing
property from parent structure element.
value
- Float valuepublic final MarginInfo getMarginInfo()
Gets or sets margin for block structure element.
public final void setMarginInfo(MarginInfo value)
Gets or sets margin for block structure element.
value
- MarginInfo instancepublic final void update(StructureTextState structureTextState)
structureTextState
- StructureTextState instancepublic final TextState createTextState()