de.hybris.platform.hmc.attribute

Class WysiwygEditorChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.attribute.AbstractAttributeEditorChip

de.hybris.platform.hmc.attribute.StringLayoutChip

de.hybris.platform.hmc.attribute.TextAreaLayoutChip

de.hybris.platform.hmc.attribute.WysiwygEditorChip

All Implemented Interfaces:

Chip, EventCheckingChip, Serializable, Cloneable

Direct Known Subclasses:

ContentBlockWysiwygEditorChip, StyleWysiwygEditorChip

public class WysiwygEditorChip
extends TextAreaLayoutChip

Editor with word processing features.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONF
static String	DEFAULT_CSS
static String	DEFAULT_XML
static String	IS_CHANGED
static String	SCHEMA_URL

Fields inherited from class de.hybris.platform.hmc.attribute.TextAreaLayoutChip

SET_BASE64, SET_TEXTAREA

Fields inherited from class de.hybris.platform.hmc.attribute.StringLayoutChip

SET_VALUE

Fields inherited from class de.hybris.platform.hmc.attribute.AbstractAttributeEditorChip

CUSTOM, DEFAULT_HEIGHT

Fields inherited from class de.hybris.platform.hmc.webchips.AbstractChip

CHIP_KEY, FALSE, FRAME_KEY, SHOW_JSP_COMMENTS, TRUE, USE_SOCKET_NAMING

Fields inherited from interface de.hybris.platform.hmc.webchips.Chip

DISPLAY_EVENT, FILTERED_PREFIX

Constructor Summary

Constructors

Constructor and Description
WysiwygEditorChip(DisplayState displayState, Chip parent) Creates a new instance of WysiwygEditorChip

Method Summary

Modifier and Type	Method and Description
protected boolean	clipboardContainsItem()
boolean	clipboardContainsMedia()
String	createLink() Creates a link text that links/references to the given item.
Set	getAcceptedEvents()
Item	getClipboardItem()
String	getClipboardMediaUrl()
String	getConfig()
String	getDefaultConfig()
String	getDefaultStyleSheet()
String	getDisplayContent()
static String	getEditorType()
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
String	getStyleSheet()
String	getToolbarConfig()
String	getXmlFile()
boolean	isAjaxUpdatable() Returns true if this editor chip is ajax updatable.
protected Object	parse(String value) Parses the given String into an Object.
void	processEvents(Map events) Converts and sets the given string value by calling AbstractAttributeEditorChip.convertAndSetValue(Object) .
void	setConfig(String config)
void	setParameters(Map parameters) sets parameters from hmc.xml
void	setStyleSheet(String styleSheet) Sets the stylesheet URL which is used in the wysiwyg editor
void	setXmlFile(String xmlFile)
protected boolean	showButton(String buttonName) Overwrite this method to make some checks whether a button is shown or not.
protected String	toString(Object value) Returns the given value as String.

Methods inherited from class de.hybris.platform.hmc.attribute.TextAreaLayoutChip

getCols, getRows, isBase64, isExpanded, isMultiLine, isWrapping, setBase64, setCols, setExpanded, setRows, setWrapping

Methods inherited from class de.hybris.platform.hmc.attribute.StringLayoutChip

convertValue, getQuotedStringValue, getStringValue, isAlignRight, isDBEncrypted, isEncoded, setAlignRight, setEncoded

Methods inherited from class de.hybris.platform.hmc.attribute.AbstractAttributeEditorChip

addAttributeValueChangeListener, checkValid, clearError, containsValidValue, convertAndSetValue, getAttributeChip, getAttributeDescriptor, getAttributeValueChangeListeners, getFieldID, getHeight, getInitialValue, getLastInvalidValue, getMaxLength, getParameters, getParentEditorChip, getProposedUniqueName, getValue, getWidth, isChanged, isEditable, isInitialized, isOptional, notifyAttributeValueChangeListeners, removeAttributeValueChangeListener, setAttributeDescriptor, setEditable, setError, setFieldID, setHeight, setInitialValue, setMaxLength, setOptional, setValidValue, setValue, setWidth, valuesAreDifferent

Methods inherited from class de.hybris.platform.hmc.webchips.AbstractChip

addEventListener, clearInfoMessages, clone, containsDisplayEvent, createMenuEntriesForJS, dispose, errorQueueEmpty, getClipboard, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getFrame, getID, getInfoMessages, getJaloSession, getLocalizedString, getLocalizedString, getLogger, getMenuEntries, getNameSpace, getNameSpaceFor, getParent, getProposedUniqueNameFor, getRequestFocus, getSessionIdentifier, getStringValue, getUniqueName, getWindow, goFullScreen, hasVisibleContextMenuEntries, isButtonPushed, isButtonPushed, isErrorQueueEmpty, isValid, leaveFullScreen, notifyEventListeners, notifyEventListeners, postErrorMessage, postInfoMessage, postWindowEvent, refresh, refreshChild, registerUniqueName, removeEventListener, removeInfoMessage, render, render, setClipboard, setParent, setRequestFocus, setValid, setWindowStatus, translateFormFieldToEventName, translateFormFieldToEventValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.hmc.webchips.Chip

addEventListener, checkValid, dispose, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getID, getJaloSession, getMenuEntries, getParent, getUniqueName, goFullScreen, isValid, leaveFullScreen, registerUniqueName, removeEventListener, render, translateFormFieldToEventName, translateFormFieldToEventValue

Field Detail

SCHEMA_URL

public static final String SCHEMA_URL

Since:

2.10

See Also:

Constant Field Values

DEFAULT_CSS

public static final String DEFAULT_CSS

Since:

2.10

See Also:

Constant Field Values

DEFAULT_XML

public static final String DEFAULT_XML

Since:

2.10

See Also:

Constant Field Values

DEFAULT_CONF

public static final String DEFAULT_CONF

See Also:

Constant Field Values

IS_CHANGED

public static final String IS_CHANGED

Since:

2.30 beta

See Also:

Constant Field Values

Constructor Detail

WysiwygEditorChip

public WysiwygEditorChip(DisplayState displayState,
                         Chip parent)

Creates a new instance of WysiwygEditorChip

Method Detail

getEditorType

public static String getEditorType()

processEvents

public void processEvents(Map events)

Description copied from class: StringLayoutChip

Converts and sets the given string value by calling AbstractAttributeEditorChip.convertAndSetValue(Object) .

Specified by:

processEvents in interface Chip

Overrides:

processEvents in class TextAreaLayoutChip

getAcceptedEvents

public Set getAcceptedEvents()

Specified by:

getAcceptedEvents in interface EventCheckingChip

Overrides:

getAcceptedEvents in class TextAreaLayoutChip

setParameters

public void setParameters(Map parameters)

sets parameters from hmc.xml

Overrides:

setParameters in class TextAreaLayoutChip

Parameters:

parameters - the parameters which where provided by the xml configuration.

getJSPURI

public String getJSPURI()

Description copied from interface: Chip

Returns the URI of the JSP that this chip wants to use.

Specified by:

getJSPURI in interface Chip

Overrides:

getJSPURI in class TextAreaLayoutChip

showButton

protected boolean showButton(String buttonName)

Overwrite this method to make some checks whether a button is shown or not.

Parameters:

buttonName - the name of the button to show

Returns:

true if the button should be displayed, false otherwise.

Since:

2.20

getStyleSheet

public String getStyleSheet()

setStyleSheet

public void setStyleSheet(String styleSheet)

Sets the stylesheet URL which is used in the wysiwyg editor

getXmlFile

public String getXmlFile()

Since:

2.10

setXmlFile

public void setXmlFile(String xmlFile)

Since:

2.10

getConfig

public String getConfig()

setConfig

public void setConfig(String config)

parse

protected Object parse(String value)
                throws ParseException

Description copied from class: StringLayoutChip

Parses the given String into an Object. The Object has to be of the type this chip represents.

Specified by:

parse in class StringLayoutChip

Throws:

ParseException

toString

protected String toString(Object value)

Description copied from class: StringLayoutChip

Returns the given value as String. It is save to assume that this value is the current value.

Specified by:

toString in class StringLayoutChip

getClipboardItem

public Item getClipboardItem()

Since:

2.10

clipboardContainsMedia

public boolean clipboardContainsMedia()

Since:

2.10

getClipboardMediaUrl

public String getClipboardMediaUrl()

Since:

2.10

clipboardContainsItem

protected boolean clipboardContainsItem()

Returns:

true if an item is contained in the clipboard

Since:

2.20 (was private before)

getDefaultConfig

public String getDefaultConfig()

Since:

2.10

getDefaultStyleSheet

public String getDefaultStyleSheet()

Since:

2.10

isAjaxUpdatable

public boolean isAjaxUpdatable()

Description copied from class: AbstractAttributeEditorChip

Returns true if this editor chip is ajax updatable. This is used in LocalizableAttributeChip to indicate that the editorchip's jsp only uses the usual form input elements and no other special functionality to update its values (like the wysiwyg editor which uses the 'onsubmit' handler to update its value).

Overrides:

isAjaxUpdatable in class StringLayoutChip

getDisplayContent

public String getDisplayContent()

Since:

3.0u1

createLink

public String createLink()

Creates a link text that links/references to the given item.

Returns:

The link text that references to the clipboard item

See Also:

Utilities.createLink(de.hybris.platform.jalo.SessionContext, Item)

getToolbarConfig

public String getToolbarConfig()