org.ametys.core.ui.widgets.richtext

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 Type	Method and Description
String	getButtonCSSClass() Get the optional css to apply to the button. The CSS file declaring this class has to be loaded separately.
I18nizableText	getButtonDescription() Get the style description.
I18nizableText	getButtonLabel() Get the style label.
String	getButtonLargeIcon() Get the optional image to set on the button.
String	getButtonMediumIcon() Get the optional image to set on the button.
String	getButtonSmallIcon() Get the optional image to set on the button.
String	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.
String	getTagName() Optionally a style can specify a tag name to use.

Method Detail

getTagName

String 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

String 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

I18nizableText getButtonLabel()

Get the style label. A short name for button text.

Returns:

A non-null value

getButtonDescription

I18nizableText getButtonDescription()

Get the style description. A long description for tips.

Returns:

A non-null value

getButtonCSSClass

String 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

String getButtonSmallIcon()

Get the optional image to set on the button. Small is 16x16.

Returns:

An image url. Can be null.

getButtonMediumIcon

String getButtonMediumIcon()

Get the optional image to set on the button. Medium is 32x32.

Returns:

An image url. Can be null.

getButtonLargeIcon

String getButtonLargeIcon()

Get the optional image to set on the button. Large is 48x48.

Returns:

An image url. Can be null.