StructureTextState

Inheritance: java.lang.Object

public class StructureTextState

Represents text state settings for Text Structure Elements and TaggedContent (ITextElement, ITaggedContent)

Constructors

Constructor	Description
StructureTextState()	Default constructor

Methods

Method	Description
getFont()	Gets or sets the font of text.
setFont(Font value)	Gets or sets the font of text.
getFontSize()	Gets or sets font size of the text.
setFontSize(Float value)	Gets or sets font size of the text.
getFontStyle()	Gets or sets font style of the text.
setFontStyle(Integer value)	Gets or sets font style of the text.
getForegroundColor()	Gets or sets foreground color of the text.
setForegroundColor(Color value)	Gets or sets foreground color of the text.
getBackgroundColor()	Gets or sets background color of the text.
setBackgroundColor(Color value)	Gets or sets background color of the text.
getUnderline()	Gets or sets underline for the text.
setUnderline(Boolean value)	Gets or sets underline for the text.
getStrikeOut()	Gets or sets strikeout for the text.
setStrikeOut(Boolean value)	Gets or sets strikeout for the text.
getSuperscript()	Gets or sets superscript of the text.
setSuperscript(Boolean value)	Gets or sets superscript of the text.
getSubscript()	Gets or sets subscript of the text.
setSubscript(Boolean value)	Gets or sets subscript of the text.
getHorizontalScaling()	Gets or sets horizontal scaling of the text.
setHorizontalScaling(Float value)	Gets or sets horizontal scaling of the text.
getLineSpacing()	Gets or sets line spacing of the text.
setLineSpacing(Float value)	Gets or sets line spacing of the text.
getCharacterSpacing()	Gets or sets character spacing of the text.
setCharacterSpacing(Float value)	Gets or sets character spacing of the text.
getWordSpacing()	Gets or sets word spacing of the text.
setWordSpacing(Float value)	Gets or sets word spacing of the text.
getMarginInfo()	Gets or sets margin for block structure element.
setMarginInfo(MarginInfo value)	Gets or sets margin for block structure element.
update(StructureTextState structureTextState)	Update elements
createTextState()	Create Text State

StructureTextState()

public StructureTextState()

Default constructor

getFont()

public final Font getFont()

Gets or sets the font of text.

Can be null. Use null to inherit Font property from parent structure element.

Returns: Font - Font instance

setFont(Font value)

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.

Parameters:

Parameter	Type	Description
value	Font	Font instance

getFontSize()

public final Float[] getFontSize()

Gets or sets font size of the text.

Can be null. Use null to inherit FontSize property from parent structure element.

Returns: java.lang.Float[] - Float array

setFontSize(Float value)

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.

Parameters:

Parameter	Type	Description
value	java.lang.Float	Float value

getFontStyle()

public final Integer[] getFontStyle()

Gets or sets font style of the text.

Can be null. Use null to inherit FontStyle property from parent structure element.

Returns: java.lang.Integer[] - Integer array

setFontStyle(Integer value)

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.

Parameters:

Parameter	Type	Description
value	java.lang.Integer	FontStyle element value

getForegroundColor()

public final Color getForegroundColor()

Gets or sets foreground color of the text.

Can be null. Use null to inherit ForegroundColor property from parent structure element.

Returns: Color - Color instance

setForegroundColor(Color value)

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.

Parameters:

Parameter	Type	Description
value	Color	Color instance

getBackgroundColor()

public final Color getBackgroundColor()

Gets or sets background color of the text.

Can be null. Use null to inherit BackgroundColor property from parent structure element.

Returns: Color - Color instance

setBackgroundColor(Color value)

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.

Parameters:

Parameter	Type	Description
value	Color	Color instance

getUnderline()

public final Boolean[] getUnderline()

Gets or sets underline for the text.

Can be null. Use null to inherit Underline property from parent structure element.

Returns: java.lang.Boolean[] - Boolean array

setUnderline(Boolean value)

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.

Parameters:

Parameter	Type	Description
value	java.lang.Boolean	Boolean value

getStrikeOut()

public final Boolean[] getStrikeOut()

Gets or sets strikeout for the text.

Can be null. Use null to inherit StrikeOut property from parent structure element.

Returns: java.lang.Boolean[] - Boolean array

setStrikeOut(Boolean value)

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.

Parameters:

Parameter	Type	Description
value	java.lang.Boolean	Boolean value

getSuperscript()

public final Boolean[] getSuperscript()

Gets or sets superscript of the text.

Can be null. Use null to inherit Superscript property from parent structure element.

Returns: java.lang.Boolean[] - Boolean array

setSuperscript(Boolean value)

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.

Parameters:

Parameter	Type	Description
value	java.lang.Boolean	Boolean value

getSubscript()

public final Boolean[] getSubscript()

Gets or sets subscript of the text.

Can be null. Use null to inherit Subscript property from parent structure element.

Returns: java.lang.Boolean[] - Boolean array

setSubscript(Boolean value)

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.

Parameters:

Parameter	Type	Description
value	java.lang.Boolean	Boolean value

getHorizontalScaling()

public final Float[] getHorizontalScaling()

Gets or sets horizontal scaling of the text.

Can be null. Use null to inherit HorizontalScaling property from parent structure element.

Returns: java.lang.Float[] - Float array

setHorizontalScaling(Float value)

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.

Parameters:

Parameter	Type	Description
value	java.lang.Float	Float value

getLineSpacing()

public final Float[] getLineSpacing()

Gets or sets line spacing of the text.

Can be null. Use null to inherit LineSpacing property from parent structure element.

Returns: java.lang.Float[] - Float array

setLineSpacing(Float value)

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.

Parameters:

Parameter	Type	Description
value	java.lang.Float	Float value

getCharacterSpacing()

public final Float[] getCharacterSpacing()

Gets or sets character spacing of the text.

Can be null. Use null to inherit CharacterSpacing property from parent structure element.

Returns: java.lang.Float[] - Float array

setCharacterSpacing(Float value)

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.

Parameters:

Parameter	Type	Description
value	java.lang.Float	Float value

getWordSpacing()

public final Float[] getWordSpacing()

Gets or sets word spacing of the text.

Can be null. Use null to inherit WordSpacing property from parent structure element.

Returns: java.lang.Float[] - Float array

setWordSpacing(Float value)

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.

Parameters:

Parameter	Type	Description
value	java.lang.Float	Float value

getMarginInfo()

public final MarginInfo getMarginInfo()

Gets or sets margin for block structure element.

Returns: MarginInfo - MarginInfo instance

setMarginInfo(MarginInfo value)

public final void setMarginInfo(MarginInfo value)

Gets or sets margin for block structure element.

Parameters:

Parameter	Type	Description
value	MarginInfo	MarginInfo instance

update(StructureTextState structureTextState)

public final void update(StructureTextState structureTextState)

Update elements

Parameters:

Parameter	Type	Description
structureTextState	StructureTextState	StructureTextState instance

createTextState()

public final TextState createTextState()

Create Text State

Returns: TextState - TextState instance