IBasePortionFormatEffectiveData

public interface IBasePortionFormatEffectiveData

Base interface for immutable objects which contain effective text portion formatting properties.

Methods

Method Description
getLineFormat() Returns the LineFormat properties for text outlining.
getFillFormat() Returns the text FillFormat properties.
getEffectFormat() Returns the text EffectFormat properties.
getHighlightColor() Returns the color used to highlight a text.
getUnderlineLineFormat() Returns the LineFormat properties used to outline underline line.
getUnderlineFillFormat() Returns the underline line FillFormat properties.
getFontBold() Determines whether the font is bold.
getFontItalic() Determines whether the font is itallic.
getKumimoji() Determines whether the numbers should ignore text eastern language-specific vertical text layout.
getNormaliseHeight() Determines whether the height of a text should be normalized.
getProofDisabled() Determines whether the text shouldn’t be proofed.
getFontUnderline() Returns the text underline type.
getTextCapType() Returns the type of text capitalization.
getStrikethroughType() Returns the strikethrough type of a text.
getSmartTagClean() Determines whether the smart tag should be cleaned.
isHardUnderlineLine() Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text.
isHardUnderlineFill() Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text.
getFontHeight() Returns the font height of a portion.
getLatinFont() Returns the Latin font info.
getEastAsianFont() Returns the East Asian font info.
getComplexScriptFont() Returns the complex script font info.
getSymbolFont() Returns the symbolic font info.
getEscapement() Returns the superscript or subscript text.
getKerningMinimalSize() Returns the minimal font size, for which kerning should be switched on.
getLanguageId() Returns the Id of a language.
getAlternativeLanguageId() Returns the Id of an alternative language.
getSpacing() Returns the intercharacter spacing increment.

getLineFormat()

public abstract ILineFormatEffectiveData getLineFormat()

Returns the LineFormat properties for text outlining. Read-only ILineFormatEffectiveData.

Returns: ILineFormatEffectiveData

getFillFormat()

public abstract IFillFormatEffectiveData getFillFormat()

Returns the text FillFormat properties. Read-only IFillFormatEffectiveData.

Returns: IFillFormatEffectiveData

getEffectFormat()

public abstract IEffectFormatEffectiveData getEffectFormat()

Returns the text EffectFormat properties. Read-only IEffectFormatEffectiveData.

Returns: IEffectFormatEffectiveData

getHighlightColor()

public abstract Integer getHighlightColor()

Returns the color used to highlight a text. Read-only java.lang.Integer.

Returns: java.lang.Integer

getUnderlineLineFormat()

public abstract ILineFormatEffectiveData getUnderlineLineFormat()

Returns the LineFormat properties used to outline underline line. Read-only ILineFormatEffectiveData.

Returns: ILineFormatEffectiveData

getUnderlineFillFormat()

public abstract IFillFormatEffectiveData getUnderlineFillFormat()

Returns the underline line FillFormat properties. Read-only IFillFormatEffectiveData.

Returns: IFillFormatEffectiveData

getFontBold()

public abstract boolean getFontBold()

Determines whether the font is bold. Read-only boolean.

Returns: boolean

getFontItalic()

public abstract boolean getFontItalic()

Determines whether the font is itallic. Read-only boolean.

Returns: boolean

getKumimoji()

public abstract boolean getKumimoji()

Determines whether the numbers should ignore text eastern language-specific vertical text layout. Read-only boolean.

Returns: boolean

getNormaliseHeight()

public abstract boolean getNormaliseHeight()

Determines whether the height of a text should be normalized. Read-only boolean.

Returns: boolean

getProofDisabled()

public abstract boolean getProofDisabled()

Determines whether the text shouldn’t be proofed. Read-only boolean.

Returns: boolean

getFontUnderline()

public abstract byte getFontUnderline()

Returns the text underline type. Read-only TextUnderlineType.

Returns: byte

getTextCapType()

public abstract byte getTextCapType()

Returns the type of text capitalization. Read-only TextCapType.

Returns: byte

getStrikethroughType()

public abstract byte getStrikethroughType()

Returns the strikethrough type of a text. Read-only TextStrikethroughType.

Returns: byte

getSmartTagClean()

public abstract boolean getSmartTagClean()

Determines whether the smart tag should be cleaned. Read-only boolean.

Returns: boolean

isHardUnderlineLine()

public abstract boolean isHardUnderlineLine()

Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text. Read-only boolean.

Returns: boolean

isHardUnderlineFill()

public abstract boolean isHardUnderlineFill()

Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text. Read-only boolean.

Returns: boolean

getFontHeight()

public abstract float getFontHeight()

Returns the font height of a portion. Read-only float.

Returns: float

getLatinFont()

public abstract IFontData getLatinFont()

Returns the Latin font info. Read-only IFontData.

Returns: IFontData

getEastAsianFont()

public abstract IFontData getEastAsianFont()

Returns the East Asian font info. Read-only IFontData.

Returns: IFontData

getComplexScriptFont()

public abstract IFontData getComplexScriptFont()

Returns the complex script font info. Read-only IFontData.

Returns: IFontData

getSymbolFont()

public abstract IFontData getSymbolFont()

Returns the symbolic font info. Read-only IFontData.

Returns: IFontData

getEscapement()

public abstract float getEscapement()

Returns the superscript or subscript text. Value from -100% (subscript) to 100% (superscript). Read-only float.

Returns: float

getKerningMinimalSize()

public abstract float getKerningMinimalSize()

Returns the minimal font size, for which kerning should be switched on. Read-only float.

Returns: float

getLanguageId()

public abstract String getLanguageId()

Returns the Id of a language. Read-only String.

Returns: java.lang.String

getAlternativeLanguageId()

public abstract String getAlternativeLanguageId()

Returns the Id of an alternative language. Read-only String.

Returns: java.lang.String

getSpacing()

public abstract float getSpacing()

Returns the intercharacter spacing increment. Read-only float.

Returns: float