Interface RichTextConfigurationStyle
- All Known Implementing Classes:
StaticRichTextConfiguration.StaticRichTextConfigurationStyle
public interface RichTextConfigurationStyle
A style is a way to render a table, a link, an image, a paragraph, an ordered list or an unordered list.
-
Method Summary
Modifier and TypeMethodDescriptionGet the optional css to apply to the button.
The CSS file declaring this class has to be loaded separately.Get the style description.Get the style label.Get the optional image to set on the button.Get the optional image to set on the button.Get the optional image to set on the button.Optionally a style can specify a CSS class name to use.
The 'class' attribute has to be separately authorized and this particular value also.Optionally a style can specify a tag name to use.
-
Method Details
-
getTagName
Optionally a style can specify a tag name to use. For example, some 'paragraph' styles may use 'p' while another can use 'h1'.
Tag has to be authorized separately- Returns:
- The tag name. Can be null.
-
getClassName
Optionally a style can specify a CSS class name to use.
The 'class' attribute has to be separately authorized and this particular value also.- Returns:
- The class name. Can be null.
-
getButtonLabel
Get the style label. A short name for button text.- Returns:
- A non-null value
-
getButtonDescription
Get the style description. A long description for tips.- Returns:
- A non-null value
-
getButtonCSSClass
Get the optional css to apply to the button.
The CSS file declaring this class has to be loaded separately.- Returns:
- A class name. Can be null.
-
getButtonSmallIcon
Get the optional image to set on the button. Small is 16x16.- Returns:
- An image url. Can be null.
-
getButtonMediumIcon
Get the optional image to set on the button. Medium is 32x32.- Returns:
- An image url. Can be null.
-
getButtonLargeIcon
Get the optional image to set on the button. Large is 48x48.- Returns:
- An image url. Can be null.
-