com.jalios.jcms.wysiwyg

Class WysiwygRenderingHints

java.lang.Object

com.jalios.jcms.wysiwyg.WysiwygRenderingHints

public class WysiwygRenderingHints
extends java.lang.Object

Provides hints used during wysiwyg/JHTML rendering.

Since:

jcms-10.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REVISION

Constructor Summary

Constructors

Constructor and Description
WysiwygRenderingHints() Creates a new WikiRenderingHints with the default values.
WysiwygRenderingHints(java.lang.String css) Creates a new WysiwygRenderingHints with the specified values

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAttribute(java.lang.String name) Get a rendering attribute.
java.util.Map<java.lang.String,java.lang.Object>	getAttributeMap() Returns the attributeMap used to store extra rendering options.
java.lang.String	getCss() Returns the css class(es) used during the rendering.
Data	getData() Retrieves the Data for which rendering is performed.
java.lang.String	getField() Retrieves the name of the data field for which rendering is performed.
boolean	isEditable() Returns whether the field is editable.
void	setAttribute(java.lang.String name, java.lang.Object value) Set a rendering attribute.
void	setAttributeMap(java.util.Map<java.lang.String,java.lang.Object> attributeMap) Set the attributeMap used to store extra rendering options.
void	setCss(java.lang.String css) Set the css to use in the surrounding html div/span generated by the rendering.
void	setData(Data data) Set the Data for which rendering is performed.
void	setEditable(boolean editable) Set whether the field is editable.
void	setField(java.lang.String field) Set the name of the data field for which rendering is performed.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

Constructor Detail

WysiwygRenderingHints

public WysiwygRenderingHints()

Creates a new WikiRenderingHints with the default values.

WysiwygRenderingHints

public WysiwygRenderingHints(java.lang.String css)

Creates a new WysiwygRenderingHints with the specified values

Parameters:

css - the name of the CSS class to use

Method Detail

setCss

public void setCss(java.lang.String css)

Set the css to use in the surrounding html div/span generated by the rendering.
Default value is empty string "".

Parameters:

css - one or more css class.

getCss

public java.lang.String getCss()

Returns the css class(es) used during the rendering.

Returns:

the css class as one string,

setData

public void setData(Data data)

Set the Data for which rendering is performed.

Parameters:

data - the data to set

getData

public Data getData()

Retrieves the Data for which rendering is performed.

Returns:

the data, may return null

setField

public void setField(java.lang.String field)

Set the name of the data field for which rendering is performed.

Parameters:

field - the name of the field being rendered

getField

public java.lang.String getField()

Retrieves the name of the data field for which rendering is performed.

Returns:

the name of the field being rendered, may return null

setEditable

public void setEditable(boolean editable)

Set whether the field is editable.

Parameters:

editable - whether the field is editable

isEditable

public boolean isEditable()

Returns whether the field is editable.

Returns:

whether the field is editable

getAttributeMap

public java.util.Map<java.lang.String,java.lang.Object> getAttributeMap()

Returns the attributeMap used to store extra rendering options.

Returns:

the attributeMap.

setAttributeMap

public void setAttributeMap(java.util.Map<java.lang.String,java.lang.Object> attributeMap)

Set the attributeMap used to store extra rendering options.

Parameters:

attributeMap - the attributeMap.

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)

Set a rendering attribute.

Parameters:

name - the attribute's key.

value - the attribute's value.

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Get a rendering attribute.

Parameters:

name - the attribute's name.

Returns:

the attribute's value.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object