IBasePortionFormat
public interface IBasePortionFormat
This class contains the text portion formatting properties. Unlike IPortionFormatEffectiveData, all properties of this class are writeable.
This class is used to return and manipulate text portion formatting properties defined for the particular portion. This means that no inheritance is applied when getting values so for the majority of cases you will get values meaning “undefined”.
In order to get the effective formatting parameter values including inherited you need to use IPortionFormat.getEffective method which returns a IPortionFormatEffectiveData instance.
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. |
| setFontBold(byte value) | Determines whether the font is bold. |
| getFontItalic() | Determines whether the font is itallic. |
| setFontItalic(byte value) | Determines whether the font is itallic. |
| getKumimoji() | Determines whether the numbers should ignore text eastern language-specific vertical text layout. |
| setKumimoji(byte value) | Determines whether the numbers should ignore text eastern language-specific vertical text layout. |
| getNormaliseHeight() | Determines whether the height of a text should be normalized. |
| setNormaliseHeight(byte value) | Determines whether the height of a text should be normalized. |
| getProofDisabled() | Determines whether the text shouldn’t be proofed. |
| setProofDisabled(byte value) | Determines whether the text shouldn’t be proofed. |
| getFontUnderline() | Returns or sets the text underline type. |
| setFontUnderline(byte value) | Returns or sets the text underline type. |
| getTextCapType() | Returns or sets the type of text capitalization. |
| setTextCapType(byte value) | Returns or sets the type of text capitalization. |
| getStrikethroughType() | Returns or sets the strikethrough type of a text. |
| setStrikethroughType(byte value) | Returns or sets the strikethrough type of a text. |
| isHardUnderlineLine() | Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text. |
| setHardUnderlineLine(byte value) | 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. |
| setHardUnderlineFill(byte value) | Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text. |
| getFontHeight() | Returns or sets the font height of a portion. |
| setFontHeight(float value) | Returns or sets the font height of a portion. |
| getLatinFont() | Returns or sets the Latin font info. |
| setLatinFont(IFontData value) | Returns or sets the Latin font info. |
| getEastAsianFont() | Returns or sets the East Asian font info. |
| setEastAsianFont(IFontData value) | Returns or sets the East Asian font info. |
| getComplexScriptFont() | Returns or sets the complex script font info. |
| setComplexScriptFont(IFontData value) | Returns or sets the complex script font info. |
| getSymbolFont() | Returns or sets the symbolic font info. |
| setSymbolFont(IFontData value) | Returns or sets the symbolic font info. |
| getEscapement() | Returns or sets the superscript or subscript text. |
| setEscapement(float value) | Returns or sets the superscript or subscript text. |
| getKerningMinimalSize() | Returns or sets the minimal font size, for which kerning should be switched on. |
| setKerningMinimalSize(float value) | Returns or sets the minimal font size, for which kerning should be switched on. |
| getLanguageId() | Returns or sets the Id of a proofing language. |
| setLanguageId(String value) | Returns or sets the Id of a proofing language. |
| getAlternativeLanguageId() | Returns or sets the Id of an alternative language. |
| setAlternativeLanguageId(String value) | Returns or sets the Id of an alternative language. |
| getSpacing() | Returns or sets the intercharacter spacing increment. |
| setSpacing(float value) | Returns or sets the intercharacter spacing increment. |
getLineFormat()
public abstract ILineFormat getLineFormat()
Returns the LineFormat properties for text outlining. No inheritance applied. Read-only ILineFormat.
Returns: ILineFormat
getFillFormat()
public abstract IFillFormat getFillFormat()
Returns the text FillFormat properties. No inheritance applied. Read-only IFillFormat.
Returns: IFillFormat
getEffectFormat()
public abstract IEffectFormat getEffectFormat()
Returns the text EffectFormat properties. No inheritance applied. Read-only IEffectFormat.
Returns: IEffectFormat
getHighlightColor()
public abstract IColorFormat getHighlightColor()
Returns the color used to highlight a text. No inheritance applied. Read-only IColorFormat.
Returns: IColorFormat
getUnderlineLineFormat()
public abstract ILineFormat getUnderlineLineFormat()
Returns the LineFormat properties used to outline underline line. No inheritance applied. Read-only ILineFormat.
Returns: ILineFormat
getUnderlineFillFormat()
public abstract IFillFormat getUnderlineFillFormat()
Returns the underline line FillFormat properties. No inheritance applied. Read-only IFillFormat.
Returns: IFillFormat
getFontBold()
public abstract byte getFontBold()
Determines whether the font is bold. No inheritance applied. Read/write NullableBool.
Returns: byte
setFontBold(byte value)
public abstract void setFontBold(byte value)
Determines whether the font is bold. No inheritance applied. Read/write NullableBool.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | byte |
getFontItalic()
public abstract byte getFontItalic()
Determines whether the font is itallic. No inheritance applied. Read/write NullableBool.
Returns: byte
setFontItalic(byte value)
public abstract void setFontItalic(byte value)
Determines whether the font is itallic. No inheritance applied. Read/write NullableBool.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | byte |
getKumimoji()
public abstract byte getKumimoji()
Determines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied. Read/write NullableBool.
Returns: byte
setKumimoji(byte value)
public abstract void setKumimoji(byte value)
Determines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied. Read/write NullableBool.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | byte |
getNormaliseHeight()
public abstract byte getNormaliseHeight()
Determines whether the height of a text should be normalized. No inheritance applied. Read/write NullableBool.
Returns: byte
setNormaliseHeight(byte value)
public abstract void setNormaliseHeight(byte value)
Determines whether the height of a text should be normalized. No inheritance applied. Read/write NullableBool.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | byte |
getProofDisabled()
public abstract byte getProofDisabled()
Determines whether the text shouldn’t be proofed. No inheritance applied. Read/write NullableBool.
Returns: byte
setProofDisabled(byte value)
public abstract void setProofDisabled(byte value)
Determines whether the text shouldn’t be proofed. No inheritance applied. Read/write NullableBool.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | byte |
getFontUnderline()
public abstract byte getFontUnderline()
Returns or sets the text underline type. No inheritance applied. Read/write TextUnderlineType.
Returns: byte
setFontUnderline(byte value)
public abstract void setFontUnderline(byte value)
Returns or sets the text underline type. No inheritance applied. Read/write TextUnderlineType.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | byte |
getTextCapType()
public abstract byte getTextCapType()
Returns or sets the type of text capitalization. No inheritance applied. Read/write TextCapType.
Returns: byte
setTextCapType(byte value)
public abstract void setTextCapType(byte value)
Returns or sets the type of text capitalization. No inheritance applied. Read/write TextCapType.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | byte |
getStrikethroughType()
public abstract byte getStrikethroughType()
Returns or sets the strikethrough type of a text. No inheritance applied. Read/write TextStrikethroughType.
Returns: byte
setStrikethroughType(byte value)
public abstract void setStrikethroughType(byte value)
Returns or sets the strikethrough type of a text. No inheritance applied. Read/write TextStrikethroughType.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | byte |
isHardUnderlineLine()
public abstract byte isHardUnderlineLine()
Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text. Read/write NullableBool.
Returns: byte
setHardUnderlineLine(byte value)
public abstract void setHardUnderlineLine(byte value)
Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text. Read/write NullableBool.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | byte |
isHardUnderlineFill()
public abstract byte isHardUnderlineFill()
Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text. Read/write NullableBool.
Returns: byte
setHardUnderlineFill(byte value)
public abstract void setHardUnderlineFill(byte value)
Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text. Read/write NullableBool.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | byte |
getFontHeight()
public abstract float getFontHeight()
Returns or sets the font height of a portion. Float.NaN means height is undefined and should be inherited from the Master. Read/write float.
Returns: float
setFontHeight(float value)
public abstract void setFontHeight(float value)
Returns or sets the font height of a portion. Float.NaN means height is undefined and should be inherited from the Master. Read/write float.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | float |
getLatinFont()
public abstract IFontData getLatinFont()
Returns or sets the Latin font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.
Returns: IFontData
setLatinFont(IFontData value)
public abstract void setLatinFont(IFontData value)
Returns or sets the Latin font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IFontData |
getEastAsianFont()
public abstract IFontData getEastAsianFont()
Returns or sets the East Asian font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.
Returns: IFontData
setEastAsianFont(IFontData value)
public abstract void setEastAsianFont(IFontData value)
Returns or sets the East Asian font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IFontData |
getComplexScriptFont()
public abstract IFontData getComplexScriptFont()
Returns or sets the complex script font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.
Returns: IFontData
setComplexScriptFont(IFontData value)
public abstract void setComplexScriptFont(IFontData value)
Returns or sets the complex script font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IFontData |
getSymbolFont()
public abstract IFontData getSymbolFont()
Returns or sets the symbolic font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.
Returns: IFontData
setSymbolFont(IFontData value)
public abstract void setSymbolFont(IFontData value)
Returns or sets the symbolic font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IFontData |
getEscapement()
public abstract float getEscapement()
Returns or sets the superscript or subscript text. Value from -100% (subscript) to 100% (superscript). Float.NaN means value is undefined and should be inherited from the Master. Read/write float.
Returns: float
setEscapement(float value)
public abstract void setEscapement(float value)
Returns or sets the superscript or subscript text. Value from -100% (subscript) to 100% (superscript). Float.NaN means value is undefined and should be inherited from the Master. Read/write float.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | float |
getKerningMinimalSize()
public abstract float getKerningMinimalSize()
Returns or sets the minimal font size, for which kerning should be switched on. Float.NaN means value is undefined and should be inherited from the Master. Read/write float.
Returns: float
setKerningMinimalSize(float value)
public abstract void setKerningMinimalSize(float value)
Returns or sets the minimal font size, for which kerning should be switched on. Float.NaN means value is undefined and should be inherited from the Master. Read/write float.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | float |
getLanguageId()
public abstract String getLanguageId()
Returns or sets the Id of a proofing language. Used for checking spelling and grammar. Read/write String.
Returns: java.lang.String
setLanguageId(String value)
public abstract void setLanguageId(String value)
Returns or sets the Id of a proofing language. Used for checking spelling and grammar. Read/write String.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
getAlternativeLanguageId()
public abstract String getAlternativeLanguageId()
Returns or sets the Id of an alternative language. Read/write String.
Returns: java.lang.String
setAlternativeLanguageId(String value)
public abstract void setAlternativeLanguageId(String value)
Returns or sets the Id of an alternative language. Read/write String.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
getSpacing()
public abstract float getSpacing()
Returns or sets the intercharacter spacing increment. Float.NaN means value is undefined and should be inherited from the Master. Read/write float.
Returns: float
setSpacing(float value)
public abstract void setSpacing(float value)
Returns or sets the intercharacter spacing increment. Float.NaN means value is undefined and should be inherited from the Master. Read/write float.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | float |