public class PortionFormatEffectiveData extends java.lang.Object implements IPortionFormatEffectiveData
Immutable object which contains text portion formatting properties.
Portion
class to return effective formatting values with inheritance applied.
Portion.createPortionFormatEffective()
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAlternativeLanguageId()
Returns or sets the Id of an alternative language.
|
java.lang.String |
getBookmarkId()
Returns or sets bookmark identifier.
|
IFontData |
getComplexScriptFont()
Returns or sets the complex script font info.
|
IFontData |
getEastAsianFont()
Returns or sets the East Asian font info.
|
IEffectFormatEffectiveData |
getEffectFormat()
Returns the text EffectFormat properties.
|
float |
getEscapement()
Returns or sets the superscript or subscript text.
|
IFillFormatEffectiveData |
getFillFormat()
Returns the text FillFormat properties.
|
boolean |
getFontBold()
Determines whether the font is bold.
|
float |
getFontHeight()
Returns or sets the font height of a portion.
|
boolean |
getFontItalic()
Determines whether the font is itallic.
|
byte |
getFontUnderline()
Returns or sets the text underline type.
|
java.lang.Integer |
getHighlightColor()
Returns the color used to highlight a text.
|
IHyperlink |
getHyperlinkClick()
Returns or sets the hyperlink defined for mouse click.
|
IHyperlink |
getHyperlinkMouseOver()
Returns or sets the hyperlink defined for mouse over.
|
float |
getKerningMinimalSize()
Returns or sets the minimal font size, for which kerning should be switched on.
|
boolean |
getKumimoji()
Determines whether the numbers should ignore text eastern language-specific vertical text layout.
|
java.lang.String |
getLanguageId()
Returns or sets the Id of a language.
|
IFontData |
getLatinFont()
Returns or sets the Latin font info.
|
ILineFormatEffectiveData |
getLineFormat()
Returns the LineFormat properties for text outlining.
|
boolean |
getNormaliseHeight()
Determines whether the height of a text should be normalized.
|
boolean |
getProofDisabled()
Determines whether the text shouldn't be proofed.
|
boolean |
getSmartTagClean()
Determines whether the smart tag should be cleaned.
|
float |
getSpacing()
Returns or sets the intercharacter spacing increment.
|
byte |
getStrikethroughType()
Returns or sets the strikethrough type of a text.
|
IFontData |
getSymbolFont()
Returns or sets the symbolic font info.
|
byte |
getTextCapType()
Returns or sets the type of text capitalization.
|
IFillFormatEffectiveData |
getUnderlineFillFormat()
Returns the underline line FillFormat properties.
|
ILineFormatEffectiveData |
getUnderlineLineFormat()
Returns the LineFormat properties used to outline underline line.
|
boolean |
isHardUnderlineFill()
Determines whether the underline style has own FillFormat properties or inherits it
from the FillFormat properties of the text.
|
boolean |
isHardUnderlineLine()
Determines whether the underline style has own LineFormat properties or inherits it
from the LineFormat properties of the text.
|
public final ILineFormatEffectiveData getLineFormat()
Returns the LineFormat properties for text outlining.
Read-only ILineFormatEffectiveData
.
getLineFormat
in interface IBasePortionFormatEffectiveData
public final IFillFormatEffectiveData getFillFormat()
Returns the text FillFormat properties.
Read-only IFillFormatEffectiveData
.
getFillFormat
in interface IBasePortionFormatEffectiveData
public final IEffectFormatEffectiveData getEffectFormat()
Returns the text EffectFormat properties.
Read-only IEffectFormatEffectiveData
.
getEffectFormat
in interface IBasePortionFormatEffectiveData
public final java.lang.Integer getHighlightColor()
Returns the color used to highlight a text.
Read-only Integer
.
getHighlightColor
in interface IBasePortionFormatEffectiveData
public final ILineFormatEffectiveData getUnderlineLineFormat()
Returns the LineFormat properties used to outline underline line.
Read-only ILineFormatEffectiveData
.
getUnderlineLineFormat
in interface IBasePortionFormatEffectiveData
public final IFillFormatEffectiveData getUnderlineFillFormat()
Returns the underline line FillFormat properties.
Read-only IFillFormatEffectiveData
.
getUnderlineFillFormat
in interface IBasePortionFormatEffectiveData
public final java.lang.String getBookmarkId()
Returns or sets bookmark identifier.
Read-only String
.
getBookmarkId
in interface IPortionFormatEffectiveData
public final IHyperlink getHyperlinkClick()
Returns or sets the hyperlink defined for mouse click.
Read-only IHyperlink
.
getHyperlinkClick
in interface IPortionFormatEffectiveData
public final IHyperlink getHyperlinkMouseOver()
Returns or sets the hyperlink defined for mouse over.
Read-only IHyperlink
.
getHyperlinkMouseOver
in interface IPortionFormatEffectiveData
public final boolean getFontBold()
Determines whether the font is bold.
Read-only boolean
.
getFontBold
in interface IBasePortionFormatEffectiveData
public final boolean getFontItalic()
Determines whether the font is itallic.
Read-only boolean
.
getFontItalic
in interface IBasePortionFormatEffectiveData
public final boolean getKumimoji()
Determines whether the numbers should ignore text eastern language-specific vertical text layout.
Read-only boolean
.
getKumimoji
in interface IBasePortionFormatEffectiveData
public final boolean getNormaliseHeight()
Determines whether the height of a text should be normalized.
Read-only boolean
.
getNormaliseHeight
in interface IBasePortionFormatEffectiveData
public final boolean getProofDisabled()
Determines whether the text shouldn't be proofed.
Read-only boolean
.
getProofDisabled
in interface IBasePortionFormatEffectiveData
public final byte getFontUnderline()
Returns or sets the text underline type.
Read-only TextUnderlineType
.
getFontUnderline
in interface IBasePortionFormatEffectiveData
public final byte getTextCapType()
Returns or sets the type of text capitalization.
Read-only TextCapType
.
getTextCapType
in interface IBasePortionFormatEffectiveData
public final byte getStrikethroughType()
Returns or sets the strikethrough type of a text.
Read-only TextStrikethroughType
.
getStrikethroughType
in interface IBasePortionFormatEffectiveData
public final boolean getSmartTagClean()
Determines whether the smart tag should be cleaned.
Read-only boolean
.
getSmartTagClean
in interface IBasePortionFormatEffectiveData
public final boolean isHardUnderlineLine()
Determines whether the underline style has own LineFormat properties or inherits it
from the LineFormat properties of the text.
Read-only boolean
.
isHardUnderlineLine
in interface IBasePortionFormatEffectiveData
public final boolean isHardUnderlineFill()
Determines whether the underline style has own FillFormat properties or inherits it
from the FillFormat properties of the text.
Read-only boolean
.
isHardUnderlineFill
in interface IBasePortionFormatEffectiveData
public final float getFontHeight()
Returns or sets the font height of a portion.
Read-only float
.
getFontHeight
in interface IBasePortionFormatEffectiveData
public final IFontData getLatinFont()
Returns or sets the Latin font info.
Read-only IFontData
.
getLatinFont
in interface IBasePortionFormatEffectiveData
public final IFontData getEastAsianFont()
Returns or sets the East Asian font info.
Read-only IFontData
.
getEastAsianFont
in interface IBasePortionFormatEffectiveData
public final IFontData getComplexScriptFont()
Returns or sets the complex script font info.
Read-only IFontData
.
getComplexScriptFont
in interface IBasePortionFormatEffectiveData
public final IFontData getSymbolFont()
Returns or sets the symbolic font info.
Read-only IFontData
.
getSymbolFont
in interface IBasePortionFormatEffectiveData
public final float getEscapement()
Returns or sets the superscript or subscript text.
Value from -100% (subscript) to 100% (superscript).
Read-only float
.
getEscapement
in interface IBasePortionFormatEffectiveData
public final float getKerningMinimalSize()
Returns or sets the minimal font size, for which kerning should be switched on.
Read-only float
.
getKerningMinimalSize
in interface IBasePortionFormatEffectiveData
public final java.lang.String getLanguageId()
Returns or sets the Id of a language.
Read-only String
.
getLanguageId
in interface IBasePortionFormatEffectiveData
public final java.lang.String getAlternativeLanguageId()
Returns or sets the Id of an alternative language.
Read-only String
.
getAlternativeLanguageId
in interface IBasePortionFormatEffectiveData
public final float getSpacing()
Returns or sets the intercharacter spacing increment.
Read-only float
.
getSpacing
in interface IBasePortionFormatEffectiveData
Copyright © 2004-2019 Aspose Pty Ltd. All Rights Reserved.