Package com.ebasetech.xi.api.controls
Interface TextStyleProperties
- All Known Subinterfaces:
AddRowButtonProperties
,ArticleControl
,AsideControl
,BasicBlockControl
,BootstrapColumnControl
,BootstrapContainerControl
,BootstrapRowControl
,ButtonColumnControl
,ButtonColumnProperties
,ButtonControl
,ButtonControlProperties
,CellStyleProperties
,ColumnStyleProperties
,EbaseButtonControlProperties
,EditorInputProperties
,FieldColumnControl
,FieldHyperlinkProperties
,FileUploadControl
,FileUploadTextControl
,FinishButtonControl
,FooterControl
,FormHeaderProperties
,GridCellControl
,GridControl
,GroupAndPageTextProperties
,HeaderControl
,HeadingControl
,HyperlinkControl
,HyperlinkStateProperties
,ImageColumnControl
,IndividualTabStateProperties
,InfoProperties
,InitiateUploadControl
,ListControl
,ListHyperlinkControl
,ListItemControl
,ListPanelControl
,MainControl
,MenuStateProperties
,MessageStyleProperties
,NavControl
,NavigationBarStyleProperties
,NavigationRowProperties
,NextPageButtonControl
,PageNavigationButtonStyle
,PageNavigationPanel
,PanelControl
,PrevPageButtonControl
,RepeatingStyleProperties
,RepeatingTableControl
,RepeatingTableListControl
,RepeatingTableListRowControl
,RepeatingTableRowControl
,RestoreButtonControl
,SaveButtonControl
,SectionControl
,TabAllStateProperties
,TableCellStyleProperties
,TableColumnHeaderProperties
,TableColumnValuePatternProperties
,TableControlStyleProperties
,TableControlTextProperties
,TabSetContentPanelProperties
,TabSetControl
,TextControl
,TitleBarProperties
public interface TextStyleProperties
The
TextStyleProperties
interface represents common text styling properties. It is used to style all texts
that appear in controls.
- Since:
- V4.4
-
Method Summary
Modifier and Type Method Description java.lang.String
getLineHeight()
Line height.java.lang.String
getTextBold()
Text bold setting.java.lang.String
getTextColor()
Text color.java.lang.String
getTextDecoration()
Text decoration property (shown as Lines in the designer).java.lang.String
getTextFont()
List of text fonts.java.lang.String
getTextItalic()
Text italic setting.java.lang.String
getTextSize()
Text size.void
setLineHeight(java.lang.String lineHeight)
Sets the line height, this is equivalent to the CSS line-height property and any valid value for this CSS property can be used.void
setTextBold(java.lang.String textBold)
Sets the text bold setting.void
setTextColor(java.lang.String textColor)
Sets the text color, this is equivalent to the CSS color property and any valid value for this CSS property can be used.void
setTextDecoration(java.lang.String textDecoration)
Sets the text decoration property (shown as Lines in the designer).void
setTextFont(java.lang.String textFont)
Sets the list of text fonts, this is equivalent to the CSS font-family property and any valid value for this CSS property can be used.void
setTextItalic(java.lang.String textItalic)
Sets the text italic setting.void
setTextSize(java.lang.String textSize)
Sets the text size, this is equivalent to the CSS font-size property and any valid value for this CSS property can be used.
-
Method Details
-
getTextFont
java.lang.String getTextFont()List of text fonts. This is equivalent to the CSS font-family property, and any valid value for this CSS property can be used when setting a value.- Since:
- V4.4
- See Also:
setTextFont(String)
-
setTextFont
void setTextFont(java.lang.String textFont)Sets the list of text fonts, this is equivalent to the CSS font-family property and any valid value for this CSS property can be used. Setting this property tonull
removes any existing value. Note that any inherited value from a parent control may still apply.Examples:
controls.TEXT1.textFont = "sans-serif"; controls.TEXT1.setTextFont("Arial, Verdana");
- Since:
- V4.4
-
getTextColor
java.lang.String getTextColor()Text color. This is equivalent to the CSS color property, and any valid value for this CSS property can be used when setting a value.- Since:
- V4.4
- See Also:
setTextColor(String)
-
setTextColor
void setTextColor(java.lang.String textColor)Sets the text color, this is equivalent to the CSS color property and any valid value for this CSS property can be used. Setting this property tonull
removes any existing value. Note that any inherited value from a parent control may still apply.Examples:
controls.TEXT1.textColor = "#808080"; controls.TEXT1.setTextColor("green");
- Since:
- V4.4
-
getTextBold
java.lang.String getTextBold()Text bold setting. If configured the value will be one of the following:- Bold
- Normal
- Since:
- V4.4
- See Also:
setTextBold(String)
-
setTextBold
void setTextBold(java.lang.String textBold)Sets the text bold setting.Supported values:
Value Constant Bold ControlConstants.TEXT_BOLD Normal ControlConstants.TEXT_NORMAL Setting a value of
null
removes any existing value for the property. Note that any inherited value from a parent control may still apply.Examples:
controls.TEXT1.textBold = ControlConstants.TEXT_BOLD; controls.TEXT1.setTextBold(ControlConstants.TEXT_NORMAL);
- Since:
- V4.4
-
getTextItalic
java.lang.String getTextItalic()Text italic setting. If configured the value will be one of the following:- Italic
- Normal
- Oblique
- Since:
- V4.4
- See Also:
setTextItalic(String)
-
setTextItalic
void setTextItalic(java.lang.String textItalic)Sets the text italic setting.Supported values:
Value Constant Italic ControlConstants.TEXT_ITALIC Normal ControlConstants.TEXT_NORMAL Oblique ControlConstants.TEXT_OBLIQUE Setting a value of
null
removes any existing value for the property. Note that any inherited value from a parent control may still apply.Examples:
controls.TEXT1.textItalic = ControlConstants.TEXT_ITALIC; controls.TEXT1.setTextItalic(ControlConstants.TEXT_NORMAL);
- Since:
- V4.4
-
getTextDecoration
java.lang.String getTextDecoration()Text decoration property (shown as Lines in the designer). This is equivalent to the CSS text-decoration property. If configured the value will be one of the following:- none
- overline
- underline
- line-through
- Since:
- V4.4
- See Also:
setTextDecoration(String)
-
setTextDecoration
void setTextDecoration(java.lang.String textDecoration)Sets the text decoration property (shown as Lines in the designer). This is equivalent to the CSS text-decoration property.textDecoration
must be one of the following:Supported values:
Value Constant none ControlConstants.NONE overline ControlConstants.TEXT_OVERLINE underline ControlConstants.TEXT_UNDERLINE line-through ControlConstants.TEXT_LINE_THROUGH Setting a value of
null
removes any existing value for the property.Examples:
controls.TEXT1.textDecoration = ControlConstants.TEXT_UNDERLINE; controls.TEXT1.setTextDecoration(ControlConstants.TEXT_LINE_THROUGH);
- Since:
- V4.4
-
getTextSize
java.lang.String getTextSize()Text size. This is equivalent to the CSS font-size property, and any valid value for this CSS property can be used when setting a value.- Since:
- V4.4
- See Also:
setTextSize(String)
-
setTextSize
void setTextSize(java.lang.String textSize)Sets the text size, this is equivalent to the CSS font-size property and any valid value for this CSS property can be used. Setting this property tonull
removes any existing value. Note that any inherited value from a parent control may still apply.Examples:
controls.TEXT1.textSize = "12px"; controls.TEXT1.setTextSize("small");
- Since:
- V4.4
-
getLineHeight
java.lang.String getLineHeight()Line height. This is equivalent to the CSS line-height property, and any valid value for this CSS property can be used when setting a value.- Since:
- V4.4
- See Also:
setLineHeight(String)
-
setLineHeight
void setLineHeight(java.lang.String lineHeight)Sets the line height, this is equivalent to the CSS line-height property and any valid value for this CSS property can be used. Setting this property tonull
removes any existing value. Note that any inherited value from a parent control may still apply.Examples:
controls.TEXT1.lineHeight = "12px"; controls.TEXT1.setLineHeight("1.5em");
- Since:
- V4.4
-