Class DefaultTextStyle
java.lang.Object
com.independentsoft.office.odf.styles.DefaultStyle
com.independentsoft.office.odf.styles.DefaultTextStyle
Represents default styles of the text style.
-
Field Summary
Fields inherited from class com.independentsoft.office.odf.styles.DefaultStyle
family -
Constructor Summary
ConstructorsConstructorDescriptionInitializes a new instance of the DefaultTextStyle class. -
Method Summary
Modifier and TypeMethodDescriptionclone()Creates a new object that is a deep copy of the current instance.Gets the country of a text.It is evaluated for [UNICODE] characters that are CJK characters.Gets the font of choice.Specifies whether a font defines glyphs according to the semantics of [UNICODE] or not.Gets the font family for a text.It is evaluated for [UNICODE] characters that are CJK characters.Specifies whether a font has a fixed or variable width.Gets the size of a font.It is evaluated for [UNICODE] characters that are CJK characters.Specifies whether to use normal or italic font face.Gets the font asian style type.Gets the weight of a font.It is evaluated for [UNICODE] characters that are CJK characters.Gets the generic Asian font family name.It is evaluated for [UNICODE] characters that are CJK characters.Gets the language of a text.It is evaluated for [UNICODE] characters that are CJK characters.Gets the background color for text sections.getColor()Gets the color of the text.Gets the country of a text.It is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.Gets the font of choice.Specifies whether a font defines glyphs according to the semantics of [UNICODE] or not.It is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.Gets the font family for a text.This attribute is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.Specifies whether a font has a fixed or variable width.Gets the size of a font.It is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.Specifies whether to use normal or italic font face.Gets the font complex style type.Gets the weight of a font.It is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.Gets the generic font family name.Gets the language of a text.It is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.Gets the country of a text.getFont()Gets the font of the text.Specifies whether a font defines glyphs according to the semantics of [UNICODE] or not.Gets the font family for a text.Specifies whether a font has a fixed or variable width.Specifies whether a font should be embossed, engraved, or neither.Gets the size of a font.Gets the font style name.Gets the font style type.Gets the font variant of the text.Gets the weight of a font.Gets the generic font family name.This attribute is evaluated for any [UNICODE] character other than CJK or complex text layout (CTL) characters.intGets the hyphenation push char count.intGets the hyphenation remain char count.Gets the language of a text.Gets the spacing between letters.Specifies whether lining through is applied to words only or to portions of text.Gets the relative font size change.It is evaluated for [UNICODE] characters that are CJK characters.Gets the relative font size change.It is evaluated for [UNICODE] characters that are CJK characters.Gets the relative font size change.It is evaluated for any [UNICODE] character other than CJK or complex text layout (CTL) characters.Gets the script type.Gets the text shadow style to use.Specifies whether to combine characters so that they are displayed within two lines.charGets the end character that is displayed after a portion of text.charGets the start character that is displayed before a portion of text.Gets the color that is used for line-through text.Gets the color that is used for line-through text.Gets the style for rendering a line-through text.Gets the text that is used for line-through.Gets the text style that is applied to text-line-through characters.Gets the width of a line-through line.Specifies whether text is positioned above or below the baseline and to specify the relative font height that is used for this text.intSpecifies an angle to which text is rotated.If more than one character is selected, the entire selection is rotated as a block.Specifies whether for rotated text the width of the text should be scaled to fit into the current line height or the width of the text should remain fixed, therefore changing the current line height.intGets the text scale.Gets the text transformation.Gets the color that is used to underline text.Gets the style for underlining text.Gets the type of underlining applied to a text.Gets the width of an underline.Specifies whether underlining is applied to words only or to portions of text.booleanChecks if is enable hyphenation.booleanSpecifies whether kerning between characters is enabled or disabled.booleanSpecifies whether text blinks.booleanSpacing between letters has value "normal".booleanSpecifies whether to display an outline of text or the text itself.voidsetAsianCountry(String asianCountry)Sets the country of a text.It is evaluated for [UNICODE] characters that are CJK characters.voidsetAsianFont(String asianFont)Sets the font of choice.voidsetAsianFontCharacterSet(String asianFontCharacterSet)Specifies whether a font defines glyphs according to the semantics of [UNICODE] or not.voidsetAsianFontFamily(String asianFontFamily)Sets the font family for a text.It is evaluated for [UNICODE] characters that are CJK characters.voidsetAsianFontPitch(FontPitch asianFontPitch)Specifies whether a font has a fixed or variable width.voidsetAsianFontSize(Size asianFontSize)Sets the size of a font.It is evaluated for [UNICODE] characters that are CJK characters.voidsetAsianFontStyle(String asianFontStyle)Specifies whether to use normal or italic font face.voidsetAsianFontStyleType(FontStyleType asianFontStyleType)Sets the font asian style type.voidsetAsianFontWeight(FontWeight asianFontWeight)Sets the weight of a font.It is evaluated for [UNICODE] characters that are CJK characters.voidsetAsianGenericFontFamily(GenericFontFamily asianGenericFontFamily)Sets the generic Asian font family name.It is evaluated for [UNICODE] characters that are CJK characters.voidsetAsianLanguage(String asianLanguage)Sets the language of a text.It is evaluated for [UNICODE] characters that are CJK characters.voidsetBackgroundColor(String backgroundColor)Sets the background color for text sections.voidSets the color of the text.voidsetComplexCountry(String complexCountry)Sets the country of a text.It is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.voidsetComplexFont(String complexFont)Sets the font of choice.voidsetComplexFontCharacterSet(String complexFontCharacterSet)Specifies whether a font defines glyphs according to the semantics of [UNICODE] or not.It is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.voidsetComplexFontFamily(String complexFontFamily)Sets the font family for a text.This attribute is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.voidsetComplexFontPitch(FontPitch complexFontPitch)Specifies whether a font has a fixed or variable width.voidsetComplexFontSize(Size complexFontSize)Sets the size of a font.It is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.voidsetComplexFontStyle(String complexFontStyle)Specifies whether to use normal or italic font face.voidsetComplexFontStyleType(FontStyleType complexFontStyleType)Sets the font complex style type.voidsetComplexFontWeight(FontWeight complexFontWeight)Sets the weight of a font.It is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.voidsetComplexGenericFontFamily(GenericFontFamily complexGenericFontFamily)Sets the generic font family name.voidsetComplexLanguage(String complexLanguage)Sets the language of a text.It is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.voidsetCountry(String country)Sets the country of a text.voidsetEnableHyphenation(boolean enableHyphenation)Sets the enable hyphenation.voidsetEnableLetterKerning(boolean enableLetterKerning)Specifies whether kerning between characters is enabled or disabled.voidsetEnableTextBlinking(boolean enableTextBlinking)Specifies whether text blinks.voidSets the font of the text.voidsetFontCharacterSet(String fontCharacterSet)Specifies whether a font defines glyphs according to the semantics of [UNICODE] or not.voidsetFontFamily(String fontFamily)Sets the font family for a text.voidsetFontPitch(FontPitch fontPitch)Specifies whether a font has a fixed or variable width.voidsetFontRelief(FontRelief fontRelief)Specifies whether a font should be embossed, engraved, or neither.voidsetFontSize(Size fontSize)Sets the size of a font.voidsetFontStyle(String fontStyle)Sets the font style name.voidsetFontStyleType(FontStyleType fontStyleType)Sets the font style type.voidsetFontVariant(FontVariant fontVariant)Sets the font variant of the text.voidsetFontWeight(FontWeight fontWeight)Sets the weight of a font.voidsetGenericFontFamily(GenericFontFamily genericFontFamily)Sets the generic font family name.This attribute is evaluated for any [UNICODE] character other than CJK or complex text layout (CTL) characters.voidsetHyphenationPushCharCount(int hyphenationPushCharCount)Sets the hyphenation push char count.voidsetHyphenationRemainCharCount(int hyphenationRemainCharCount)Sets the hyphenation remain char count.voidsetLanguage(String language)Sets the language of a text.voidsetLetterSpacing(Size letterSpacing)Sets the spacing between letters.voidsetLetterSpacingNormal(boolean isLetterSpacingNormal)Spacing between letters has value "normal".voidsetLineThroughWordMode(LineMode lineThroughWordMode)Specifies whether lining through is applied to words only or to portions of text.voidsetRelativeAsianFontSize(Size relativeAsianFontSize)Sets the relative font size change.It is evaluated for [UNICODE] characters that are CJK characters.voidsetRelativeComplexFontSize(Size relativeComplexFontSize)Sets the relative font size change.It is evaluated for [UNICODE] characters that are CJK characters.voidsetRelativeFontSize(Size relativeFontSize)Sets the relative font size change.It is evaluated for any [UNICODE] character other than CJK or complex text layout (CTL) characters.voidsetScriptType(ScriptType scriptType)Sets the script type.voidSets the text shadow style to use.voidsetTextCombine(TextCombine textCombine)Specifies whether to combine characters so that they are displayed within two lines.voidsetTextCombineEndChar(char textCombineEndChar)Sets the end character that is displayed after a portion of text.voidsetTextCombineStartChar(char textCombineStartChar)Sets the start character that is displayed before a portion of text.voidsetTextLineThrough(LineType textLineThrough)Sets the color that is used for line-through text.voidsetTextLineThroughColor(String textLineThroughColor)Sets the color that is used for line-through text.voidsetTextLineThroughStyle(LineStyle textLineThroughStyle)Sets the style for rendering a line-through text.voidsetTextLineThroughText(String textLineThroughText)Sets the text that is used for line-through.voidsetTextLineThroughTextStyle(String textLineThroughTextStyle)Sets the text style that is applied to text-line-through characters.voidsetTextLineThroughWidth(String textLineThroughWidth)Sets the width of a line-through line.voidsetTextOutline(boolean textOutline)Specifies whether to display an outline of text or the text itself.voidsetTextPosition(TextPosition textPosition)Specifies whether text is positioned above or below the baseline and to specify the relative font height that is used for this text.voidsetTextRotationAngle(int textRotationAngle)Specifies an angle to which text is rotated.If more than one character is selected, the entire selection is rotated as a block.voidsetTextRotationScale(TextRotationScale textRotationScale)Specifies whether for rotated text the width of the text should be scaled to fit into the current line height or the width of the text should remain fixed, therefore changing the current line height.voidsetTextScale(int textScale)Sets the text scale.voidsetTextTransformation(TextTransformation textTransformation)Sets the text transformation.voidsetUnderlineColor(String underlineColor)Sets the color that is used to underline text.voidsetUnderlineStyle(UnderlineStyle underlineStyle)Sets the style for underlining text.voidsetUnderlineType(UnderlineType underlineType)Sets the type of underlining applied to a text.voidsetUnderlineWidth(String underlineWidth)Sets the width of an underline.voidsetUnderlineWordMode(LineMode underlineWordMode)Specifies whether underlining is applied to words only or to portions of text.voidsetWindowFontColor(boolean useWindowFontColor)Specifies whether the window foreground color should be used as the foreground color for a light background color and white for a dark background color.toString()Converts the value of the current DefaultTextStyle object to its equivalent string representation.booleanSpecifies whether the window foreground color should be used as the foreground color for a light background color and white for a dark background color.Methods inherited from class com.independentsoft.office.odf.styles.DefaultStyle
getFamily, setFamily, toString
-
Constructor Details
-
DefaultTextStyle
public DefaultTextStyle()Initializes a new instance of the DefaultTextStyle class.
-
-
Method Details
-
clone
Creates a new object that is a deep copy of the current instance. -
toString
Converts the value of the current DefaultTextStyle object to its equivalent string representation.- Overrides:
toStringin classDefaultStyle- Returns:
- the string
-
getFontVariant
Gets the font variant of the text.- Returns:
- the font variant
-
setFontVariant
Sets the font variant of the text.- Parameters:
fontVariant- the new font variant
-
getTextTransformation
Gets the text transformation.- Returns:
- the text transformation
-
setTextTransformation
Sets the text transformation.- Parameters:
textTransformation- the new text transformation
-
getColor
Gets the color of the text.- Returns:
- the color
-
setColor
Sets the color of the text.- Parameters:
color- the new color
-
useWindowFontColor
public boolean useWindowFontColor()Specifies whether the window foreground color should be used as the foreground color for a light background color and white for a dark background color. The determination of what constitutes a light or dark color is implementation defined.- Returns:
- true, if successful
-
setWindowFontColor
public void setWindowFontColor(boolean useWindowFontColor)Specifies whether the window foreground color should be used as the foreground color for a light background color and white for a dark background color. The determination of what constitutes a light or dark color is implementation defined.- Parameters:
useWindowFontColor- the new window font color
-
isTextOutline
public boolean isTextOutline()Specifies whether to display an outline of text or the text itself.- Returns:
- true, if is text outline
-
setTextOutline
public void setTextOutline(boolean textOutline)Specifies whether to display an outline of text or the text itself.- Parameters:
textOutline- the new text outline
-
getTextLineThrough
Gets the color that is used for line-through text.- Returns:
- the text line through
-
setTextLineThrough
Sets the color that is used for line-through text.- Parameters:
textLineThrough- the new text line through
-
getTextLineThroughStyle
Gets the style for rendering a line-through text.- Returns:
- the text line through style
-
setTextLineThroughStyle
Sets the style for rendering a line-through text.- Parameters:
textLineThroughStyle- the new text line through style
-
getTextLineThroughWidth
Gets the width of a line-through line. The value bold specifies a line width that is calculated from the font sizes like an auto width, but is wider than an auto width.- Returns:
- the text line through width
-
setTextLineThroughWidth
Sets the width of a line-through line. The value bold specifies a line width that is calculated from the font sizes like an auto width, but is wider than an auto width.- Parameters:
textLineThroughWidth- the new text line through width
-
getTextLineThroughColor
Gets the color that is used for line-through text.- Returns:
- the text line through color
-
setTextLineThroughColor
Sets the color that is used for line-through text.- Parameters:
textLineThroughColor- the new text line through color
-
getTextLineThroughText
Gets the text that is used for line-through.- Returns:
- the text line through text
-
setTextLineThroughText
Sets the text that is used for line-through.- Parameters:
textLineThroughText- the new text line through text
-
getTextLineThroughTextStyle
Gets the text style that is applied to text-line-through characters. It is not applied to line-through lines. If the attribute appears in an automatic style, it may reference either an automatic text style or a common style. If the attribute appears in a common style, it may reference a common style only.- Returns:
- the text line through text style
-
setTextLineThroughTextStyle
Sets the text style that is applied to text-line-through characters. It is not applied to line-through lines. If the attribute appears in an automatic style, it may reference either an automatic text style or a common style. If the attribute appears in a common style, it may reference a common style only.- Parameters:
textLineThroughTextStyle- the new text line through text style
-
getTextPosition
Specifies whether text is positioned above or below the baseline and to specify the relative font height that is used for this text.- Returns:
- the text position
-
setTextPosition
Specifies whether text is positioned above or below the baseline and to specify the relative font height that is used for this text.- Parameters:
textPosition- the new text position
-
getFont
Gets the font of the text.- Returns:
- the font
-
setFont
Sets the font of the text.- Parameters:
font- the new font
-
getAsianFont
Gets the font of choice.- Returns:
- the asian font
-
setAsianFont
Sets the font of choice.- Parameters:
asianFont- the new asian font
-
getComplexFont
Gets the font of choice.- Returns:
- the complex font
-
setComplexFont
Sets the font of choice.- Parameters:
complexFont- the new complex font
-
getFontStyle
Gets the font style name.- Returns:
- the font style
-
setFontStyle
Sets the font style name.- Parameters:
fontStyle- the new font style
-
getAsianFontStyle
Specifies whether to use normal or italic font face. The defined values are: -italic: characters displayed in an italic font face. -normal: characters displayed in normal font face. -oblique: characters displayed in an oblique font face.- Returns:
- the asian font style
-
setAsianFontStyle
Specifies whether to use normal or italic font face. The defined values are: -italic: characters displayed in an italic font face. -normal: characters displayed in normal font face. -oblique: characters displayed in an oblique font face.- Parameters:
asianFontStyle- the new asian font style
-
getComplexFontStyle
Specifies whether to use normal or italic font face. The defined values are: -italic: characters displayed in an italic font face. -normal: characters displayed in normal font face. -oblique: characters displayed in an oblique font face.- Returns:
- the complex font style
-
setComplexFontStyle
Specifies whether to use normal or italic font face. The defined values are: -italic: characters displayed in an italic font face. -normal: characters displayed in normal font face. -oblique: characters displayed in an oblique font face.- Parameters:
complexFontStyle- the new complex font style
-
getFontSize
Gets the size of a font.- Returns:
- the font size
-
setFontSize
Sets the size of a font.- Parameters:
fontSize- the new font size
-
getAsianFontSize
Gets the size of a font.It is evaluated for [UNICODE] characters that are CJK characters.- Returns:
- the asian font size
-
setAsianFontSize
Sets the size of a font.It is evaluated for [UNICODE] characters that are CJK characters.- Parameters:
asianFontSize- the new asian font size
-
getComplexFontSize
Gets the size of a font.It is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.- Returns:
- the complex font size
-
setComplexFontSize
Sets the size of a font.It is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.- Parameters:
complexFontSize- the new complex font size
-
getRelativeFontSize
Gets the relative font size change.It is evaluated for any [UNICODE] character other than CJK or complex text layout (CTL) characters.- Returns:
- the relative font size
-
setRelativeFontSize
Sets the relative font size change.It is evaluated for any [UNICODE] character other than CJK or complex text layout (CTL) characters.- Parameters:
relativeFontSize- the new relative font size
-
getRelativeAsianFontSize
Gets the relative font size change.It is evaluated for [UNICODE] characters that are CJK characters.- Returns:
- the relative asian font size
-
setRelativeAsianFontSize
Sets the relative font size change.It is evaluated for [UNICODE] characters that are CJK characters.- Parameters:
relativeAsianFontSize- the new relative asian font size
-
getRelativeComplexFontSize
Gets the relative font size change.It is evaluated for [UNICODE] characters that are CJK characters.- Returns:
- the relative complex font size
-
setRelativeComplexFontSize
Sets the relative font size change.It is evaluated for [UNICODE] characters that are CJK characters.- Parameters:
relativeComplexFontSize- the new relative complex font size
-
getCountry
Gets the country of a text.- Returns:
- the country
-
setCountry
Sets the country of a text.- Parameters:
country- the new country
-
getAsianCountry
Gets the country of a text.It is evaluated for [UNICODE] characters that are CJK characters.- Returns:
- the asian country
-
setAsianCountry
Sets the country of a text.It is evaluated for [UNICODE] characters that are CJK characters.- Parameters:
asianCountry- the new asian country
-
getComplexCountry
Gets the country of a text.It is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.- Returns:
- the complex country
-
setComplexCountry
Sets the country of a text.It is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.- Parameters:
complexCountry- the new complex country
-
getLanguage
Gets the language of a text.- Returns:
- the language
-
setLanguage
Sets the language of a text.- Parameters:
language- the new language
-
getAsianLanguage
Gets the language of a text.It is evaluated for [UNICODE] characters that are CJK characters.- Returns:
- the asian language
-
setAsianLanguage
Sets the language of a text.It is evaluated for [UNICODE] characters that are CJK characters.- Parameters:
asianLanguage- the new asian language
-
getComplexLanguage
Gets the language of a text.It is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.- Returns:
- the complex language
-
setComplexLanguage
Sets the language of a text.It is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.- Parameters:
complexLanguage- the new complex language
-
getFontCharacterSet
Specifies whether a font defines glyphs according to the semantics of [UNICODE] or not.- Returns:
- the font character set
-
setFontCharacterSet
Specifies whether a font defines glyphs according to the semantics of [UNICODE] or not.- Parameters:
fontCharacterSet- the new font character set
-
getAsianFontCharacterSet
Specifies whether a font defines glyphs according to the semantics of [UNICODE] or not. It is evaluated for [UNICODE] characters that are CJK characters.- Returns:
- the asian font character set
-
setAsianFontCharacterSet
Specifies whether a font defines glyphs according to the semantics of [UNICODE] or not. It is evaluated for [UNICODE] characters that are CJK characters.- Parameters:
asianFontCharacterSet- the new asian font character set
-
getComplexFontCharacterSet
Specifies whether a font defines glyphs according to the semantics of [UNICODE] or not.It is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.- Returns:
- the complex font character set
-
setComplexFontCharacterSet
Specifies whether a font defines glyphs according to the semantics of [UNICODE] or not.It is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.- Parameters:
complexFontCharacterSet- the new complex font character set
-
getFontPitch
Specifies whether a font has a fixed or variable width. This attribute is evaluated for any [UNICODE] character other than CJK or complex text layout (CTL) characters.- Returns:
- the font pitch
-
setFontPitch
Specifies whether a font has a fixed or variable width. This attribute is evaluated for any [UNICODE] character other than CJK or complex text layout (CTL) characters.- Parameters:
fontPitch- the new font pitch
-
getAsianFontPitch
Specifies whether a font has a fixed or variable width. This attribute is evaluated for [UNICODE] characters that are CJK characters.- Returns:
- the asian font pitch
-
setAsianFontPitch
Specifies whether a font has a fixed or variable width. This attribute is evaluated for [UNICODE] characters that are CJK characters.- Parameters:
asianFontPitch- the new asian font pitch
-
getComplexFontPitch
Specifies whether a font has a fixed or variable width. This attribute is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.- Returns:
- the complex font pitch
-
setComplexFontPitch
Specifies whether a font has a fixed or variable width. This attribute is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.- Parameters:
complexFontPitch- the new complex font pitch
-
getFontFamily
Gets the font family for a text.- Returns:
- the font family
-
setFontFamily
Sets the font family for a text.- Parameters:
fontFamily- the new font family
-
getAsianFontFamily
Gets the font family for a text.It is evaluated for [UNICODE] characters that are CJK characters.- Returns:
- the asian font family
-
setAsianFontFamily
Sets the font family for a text.It is evaluated for [UNICODE] characters that are CJK characters.- Parameters:
asianFontFamily- the new asian font family
-
getComplexFontFamily
Gets the font family for a text.This attribute is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.- Returns:
- the complex font family
-
setComplexFontFamily
Sets the font family for a text.This attribute is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.- Parameters:
complexFontFamily- the new complex font family
-
getFontWeight
Gets the weight of a font.- Returns:
- the font weight
-
setFontWeight
Sets the weight of a font.- Parameters:
fontWeight- the new font weight
-
getAsianFontWeight
Gets the weight of a font.It is evaluated for [UNICODE] characters that are CJK characters.- Returns:
- the asian font weight
-
setAsianFontWeight
Sets the weight of a font.It is evaluated for [UNICODE] characters that are CJK characters.- Parameters:
asianFontWeight- the new asian font weight
-
getComplexFontWeight
Gets the weight of a font.It is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.- Returns:
- the complex font weight
-
setComplexFontWeight
Sets the weight of a font.It is evaluated for [UNICODE] characters that are complex text layout (CTL) characters.- Parameters:
complexFontWeight- the new complex font weight
-
getGenericFontFamily
Gets the generic font family name.This attribute is evaluated for any [UNICODE] character other than CJK or complex text layout (CTL) characters.- Returns:
- the generic font family
-
setGenericFontFamily
Sets the generic font family name.This attribute is evaluated for any [UNICODE] character other than CJK or complex text layout (CTL) characters.- Parameters:
genericFontFamily- the new generic font family
-
getAsianGenericFontFamily
Gets the generic Asian font family name.It is evaluated for [UNICODE] characters that are CJK characters.- Returns:
- the asian generic font family
-
setAsianGenericFontFamily
Sets the generic Asian font family name.It is evaluated for [UNICODE] characters that are CJK characters.- Parameters:
asianGenericFontFamily- the new asian generic font family
-
getComplexGenericFontFamily
Gets the generic font family name.- Returns:
- the complex generic font family
-
setComplexGenericFontFamily
Sets the generic font family name.- Parameters:
complexGenericFontFamily- the new complex generic font family
-
getFontStyleType
Gets the font style type.- Returns:
- the font style type
-
setFontStyleType
Sets the font style type.- Parameters:
fontStyleType- the new font style type
-
getAsianFontStyleType
Gets the font asian style type.- Returns:
- the asian font style type
-
setAsianFontStyleType
Sets the font asian style type.- Parameters:
asianFontStyleType- the new asian font style type
-
getComplexFontStyleType
Gets the font complex style type.- Returns:
- the complex font style type
-
setComplexFontStyleType
Sets the font complex style type.- Parameters:
complexFontStyleType- the new complex font style type
-
getBackgroundColor
Gets the background color for text sections. This can be transparent or a color.- Returns:
- the background color
-
setBackgroundColor
Sets the background color for text sections. This can be transparent or a color.- Parameters:
backgroundColor- the new background color
-
getShadow
Gets the text shadow style to use.- Returns:
- the shadow
-
setShadow
Sets the text shadow style to use.- Parameters:
shadow- the new shadow
-
getScriptType
Gets the script type. The attribute is evaluated for any [UNICODE] characters that are not CJK or complex text layout (CTL) characters.- Returns:
- the script type
-
setScriptType
Sets the script type. The attribute is evaluated for any [UNICODE] characters that are not CJK or complex text layout (CTL) characters.- Parameters:
scriptType- the new script type
-
getFontRelief
Specifies whether a font should be embossed, engraved, or neither.- Returns:
- the font relief
-
setFontRelief
Specifies whether a font should be embossed, engraved, or neither.- Parameters:
fontRelief- the new font relief
-
getUnderlineType
Gets the type of underlining applied to a text.- Returns:
- the underline type
-
setUnderlineType
Sets the type of underlining applied to a text.- Parameters:
underlineType- the new underline type
-
getUnderlineStyle
Gets the style for underlining text.- Returns:
- the underline style
-
setUnderlineStyle
Sets the style for underlining text.- Parameters:
underlineStyle- the new underline style
-
getUnderlineWordMode
Specifies whether underlining is applied to words only or to portions of text. If underlining is applied to text portions, the spaces between words and the words are underlined.- Returns:
- the underline word mode
-
setUnderlineWordMode
Specifies whether underlining is applied to words only or to portions of text. If underlining is applied to text portions, the spaces between words and the words are underlined.- Parameters:
underlineWordMode- the new underline word mode
-
getUnderlineWidth
Gets the width of an underline. The value bold specifies a line width that is calculated from the font sizes like an auto width, but is wider than an auto width. The defined values are: -auto: the width of an underline should be calculated from the font size of the text where the underline will appear. -bold: the width of an underline should be calculated from the font size of the text where the underline will appear but is wider than for the value of auto. -a value of type percent -a value of type positive integer -a value of type positive length- Returns:
- the underline width
-
setUnderlineWidth
Sets the width of an underline. The value bold specifies a line width that is calculated from the font sizes like an auto width, but is wider than an auto width. The defined values are: -auto: the width of an underline should be calculated from the font size of the text where the underline will appear. -bold: the width of an underline should be calculated from the font size of the text where the underline will appear but is wider than for the value of auto. -a value of type percent -a value of type positive integer -a value of type positive length- Parameters:
underlineWidth- the new underline width
-
getUnderlineColor
Gets the color that is used to underline text. The value of this attribute is either font-color or a color. The defined values are: -font-color: the current text color is used for underlining. -a value of type color: the color to be used for underlining.- Returns:
- the underline color
-
setUnderlineColor
Sets the color that is used to underline text. The value of this attribute is either font-color or a color. The defined values are: -font-color: the current text color is used for underlining. -a value of type color: the color to be used for underlining.- Parameters:
underlineColor- the new underline color
-
getLineThroughWordMode
Specifies whether lining through is applied to words only or to portions of text.- Returns:
- the line through word mode
-
setLineThroughWordMode
Specifies whether lining through is applied to words only or to portions of text.- Parameters:
lineThroughWordMode- the new line through word mode
-
isEnableLetterKerning
public boolean isEnableLetterKerning()Specifies whether kerning between characters is enabled or disabled.- Returns:
- true, if is enable letter kerning
-
setEnableLetterKerning
public void setEnableLetterKerning(boolean enableLetterKerning)Specifies whether kerning between characters is enabled or disabled.- Parameters:
enableLetterKerning- the new enable letter kerning
-
isEnableTextBlinking
public boolean isEnableTextBlinking()Specifies whether text blinks.- Returns:
- true, if is enable text blinking
-
setEnableTextBlinking
public void setEnableTextBlinking(boolean enableTextBlinking)Specifies whether text blinks.- Parameters:
enableTextBlinking- the new enable text blinking
-
getTextCombine
Specifies whether to combine characters so that they are displayed within two lines.- Returns:
- the text combine
-
setTextCombine
Specifies whether to combine characters so that they are displayed within two lines.- Parameters:
textCombine- the new text combine
-
getTextCombineStartChar
public char getTextCombineStartChar()Gets the start character that is displayed before a portion of text.- Returns:
- the text combine start char
-
setTextCombineStartChar
public void setTextCombineStartChar(char textCombineStartChar)Sets the start character that is displayed before a portion of text.- Parameters:
textCombineStartChar- the new text combine start char
-
getTextCombineEndChar
public char getTextCombineEndChar()Gets the end character that is displayed after a portion of text.- Returns:
- the text combine end char
-
setTextCombineEndChar
public void setTextCombineEndChar(char textCombineEndChar)Sets the end character that is displayed after a portion of text.- Parameters:
textCombineEndChar- the new text combine end char
-
getTextRotationAngle
public int getTextRotationAngle()Specifies an angle to which text is rotated.If more than one character is selected, the entire selection is rotated as a block. The defined values for are: -0 degrees -90 degrees -270 degrees -an angle. The value shall be one of 0deg, 90deg or 270deg, or any of its equivalents in rad or grad.- Returns:
- the text rotation angle
-
setTextRotationAngle
public void setTextRotationAngle(int textRotationAngle)Specifies an angle to which text is rotated.If more than one character is selected, the entire selection is rotated as a block. The defined values for are: -0 degrees -90 degrees -270 degrees -an angle. The value shall be one of 0deg, 90deg or 270deg, or any of its equivalents in rad or grad.- Parameters:
textRotationAngle- the new text rotation angle
-
getTextRotationScale
Specifies whether for rotated text the width of the text should be scaled to fit into the current line height or the width of the text should remain fixed, therefore changing the current line height.- Returns:
- the text rotation scale
-
setTextRotationScale
Specifies whether for rotated text the width of the text should be scaled to fit into the current line height or the width of the text should remain fixed, therefore changing the current line height.- Parameters:
textRotationScale- the new text rotation scale
-
isEnableHyphenation
public boolean isEnableHyphenation()Checks if is enable hyphenation.- Returns:
- true, if is enable hyphenation
-
setEnableHyphenation
public void setEnableHyphenation(boolean enableHyphenation)Sets the enable hyphenation.- Parameters:
enableHyphenation- the new enable hyphenation
-
getHyphenationRemainCharCount
public int getHyphenationRemainCharCount()Gets the hyphenation remain char count.- Returns:
- the hyphenation remain char count
-
setHyphenationRemainCharCount
public void setHyphenationRemainCharCount(int hyphenationRemainCharCount)Sets the hyphenation remain char count.- Parameters:
hyphenationRemainCharCount- the new hyphenation remain char count
-
getHyphenationPushCharCount
public int getHyphenationPushCharCount()Gets the hyphenation push char count.- Returns:
- the hyphenation push char count
-
setHyphenationPushCharCount
public void setHyphenationPushCharCount(int hyphenationPushCharCount)Sets the hyphenation push char count.- Parameters:
hyphenationPushCharCount- the new hyphenation push char count
-
isLetterSpacingNormal
public boolean isLetterSpacingNormal()Spacing between letters has value "normal".- Returns:
- true, if is letter spacing normal
-
setLetterSpacingNormal
public void setLetterSpacingNormal(boolean isLetterSpacingNormal)Spacing between letters has value "normal".- Parameters:
isLetterSpacingNormal- the new letter spacing normal
-
getLetterSpacing
Gets the spacing between letters.- Returns:
- the letter spacing
-
setLetterSpacing
Sets the spacing between letters.- Parameters:
letterSpacing- the new letter spacing
-
getTextScale
public int getTextScale()Gets the text scale.- Returns:
- the text scale
-
setTextScale
public void setTextScale(int textScale)Sets the text scale.- Parameters:
textScale- the new text scale
-