org.ametys.cms.clientsideelement.styles

Class Style

java.lang.Object

org.ametys.cms.clientsideelement.styles.Style

public class Style
extends Object

This class handle style for paragraphs

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_buttonCSSClass See constructor
protected I18nizableText	_buttonDescription See constructor
protected I18nizableText	_buttonLabel See constructor
protected String	_buttonLargeIcon See constructor
protected String	_buttonMediumIcon See constructor
protected String	_buttonSmallIcon See constructor
protected String	_inlineEditorRender See constructor

Constructor Summary

Constructors

Constructor and Description
Style(I18nizableText buttonLabel, I18nizableText buttonDescription, String buttonSmallIcon, String buttonMediumIcon, String buttonLargeIcon, String buttonCSSClass, String inlineEditorRender) Create a style for paragraphs

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getAsParameters() Transform the current para style as a map of parameters.
String	getButtonCSSClass() See constructor
I18nizableText	getButtonDescription() See constructor
I18nizableText	getButtonLabel() See constructor
String	getButtonLargeIcon() See constructor
String	getButtonMediumIcon() See constructor
String	getButtonSmallIcon() See constructor
String	getInlineEditorRender() See constructor
void	toSAX(ContentHandler contentHandler) SAX the current para style

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_buttonSmallIcon

protected String _buttonSmallIcon

See constructor

_buttonMediumIcon

protected String _buttonMediumIcon

See constructor

_buttonLargeIcon

protected String _buttonLargeIcon

See constructor

_buttonLabel

protected I18nizableText _buttonLabel

See constructor

_buttonDescription

protected I18nizableText _buttonDescription

See constructor

_buttonCSSClass

protected String _buttonCSSClass

See constructor

_inlineEditorRender

protected String _inlineEditorRender

See constructor

Constructor Detail

Style

public Style(I18nizableText buttonLabel,
             I18nizableText buttonDescription,
             String buttonSmallIcon,
             String buttonMediumIcon,
             String buttonLargeIcon,
             String buttonCSSClass,
             String inlineEditorRender)

Create a style for paragraphs

Parameters:

buttonLabel - Label of the backoffice button to apply this style

buttonDescription - Description of the backoffice button to apply this style

buttonSmallIcon - Image in 16x16 pixels (can be null) of the backoffice button to apply this style

buttonMediumIcon - Image in 32x32 pixels (can be null) of the backoffice button to apply this style

buttonLargeIcon - Image in 48x48 pixels (can be null) of the backoffice button to apply this style

buttonCSSClass - CSS class of the backoffice button to apply this style (used to give a preview appearance to the button) The CSS class has to be defined in the imported files (See HTMLEditorStyleExtensionPoint)

inlineEditorRender - Information necessary in the inline editor to "apply" the style. Can be a "tagname.classname" or just a "classname" depending on the element to style

Method Detail

getAsParameters

public Map<String,Object> getAsParameters()

Transform the current para style as a map of parameters. Parameters are :

• icon-small (optional)
• icon-medium (optional)
• icon-large (optional)
• label
• description
• cssclass (optional)
• inline-editor-render

Returns:

The non null map with parameters.

toSAX

public void toSAX(ContentHandler contentHandler)
           throws SAXException

SAX the current para style

Parameters:

contentHandler - Where to SAX

Throws:

SAXException - If an error occured

getButtonCSSClass

public String getButtonCSSClass()

See constructor

Returns:

the buttonCssClass.

getButtonDescription

public I18nizableText getButtonDescription()

See constructor

Returns:

the buttonDescription

getButtonSmallIcon

public String getButtonSmallIcon()

See constructor

Returns:

the buttonSmallIcon

getButtonMediumIcon

public String getButtonMediumIcon()

See constructor

Returns:

the buttonSmallIcon

getButtonLargeIcon

public String getButtonLargeIcon()

See constructor

Returns:

the buttonSmallIcon

getButtonLabel

public I18nizableText getButtonLabel()

See constructor

Returns:

the buttonLabel

getInlineEditorRender

public String getInlineEditorRender()

See constructor

Returns:

the inlineEditorRender