de.hybris.platform.hmc.attribute

Class DiffTextDisplayChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.attribute.AbstractAttributeEditorChip

de.hybris.platform.hmc.attribute.DiffTextDisplayChip

All Implemented Interfaces:

DiffDisplayChip, Chip, Serializable, Cloneable

public class DiffTextDisplayChip
extends AbstractAttributeEditorChip
implements DiffDisplayChip

Displays a readonly editor where difference between new and old value can be displayed. Currently it only presents a new value. It has potential capabilities to present in more convenient way changes between old and new value. If needed more advanced difference presentation override the markDiffs() method with own html representative result.

Since:

2.10

See Also:

Serialized Form

Field Summary

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
DiffTextDisplayChip(DisplayState arg0, Chip arg1)
DiffTextDisplayChip(DisplayState arg0, Chip arg1, Object arg2)

Method Summary

Modifier and Type	Method and Description
Object	getDiff() Returns the value to make a diff to.
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
String	getOldValueEditorType()
String	getStringWithMarks()
Object	getValue() If isMarkDiff() returns true a diff value will returned.
boolean	isAjaxUpdatable() Returns true if this editor chip is ajax updatable.
boolean	isMarkDiff() If getDiff() returns something different from null, this method returns true
boolean	isStringEditor() Is the old value displayed by a textarea editor.
boolean	isTextAreaEditor() Is the old value displayed by a textarea editor.
boolean	isWysiwygEditor() Is the old value displayed by a wysiwyg editor.
protected String	markDiffs() In order to provide a richer difference between old and new value.
void	processEvents(Map arg0) Handles all incoming requests for this chip.
void	setDiff(Object diff) Set the value to make a diff to.
void	setOldValueEditorType(String oldValueEditorType)

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

addAttributeValueChangeListener, checkValid, clearError, containsValidValue, convertAndSetValue, convertValue, getAttributeChip, getAttributeDescriptor, getAttributeValueChangeListeners, getEditorType, getFieldID, getHeight, getInitialValue, getLastInvalidValue, getMaxLength, getParameters, getParentEditorChip, getProposedUniqueName, getWidth, isChanged, isEditable, isInitialized, isOptional, notifyAttributeValueChangeListeners, removeAttributeValueChangeListener, setAttributeDescriptor, setEditable, setError, setFieldID, setHeight, setInitialValue, setMaxLength, setOptional, setParameters, 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

Constructor Detail

DiffTextDisplayChip

public DiffTextDisplayChip(DisplayState arg0,
                           Chip arg1)

DiffTextDisplayChip

public DiffTextDisplayChip(DisplayState arg0,
                           Chip arg1,
                           Object arg2)

Method Detail

isMarkDiff

public boolean isMarkDiff()

If getDiff() returns something different from null, this method returns true

Returns:

Returns the markDiff.

processEvents

public void processEvents(Map arg0)

Description copied from interface: Chip

Handles all incoming requests for this chip. Map contains name (String) and value (List of Strings)

Specified by:

processEvents in interface Chip

See Also:

Chip.processEvents(java.util.Map)

setDiff

public void setDiff(Object diff)

Set the value to make a diff to.

Specified by:

setDiff in interface DiffDisplayChip

getDiff

public Object getDiff()

Returns the value to make a diff to.

Specified by:

getDiff in interface DiffDisplayChip

getValue

public Object getValue()

If isMarkDiff() returns true a diff value will returned. Otherwise the value as it is.

Overrides:

getValue in class AbstractAttributeEditorChip

See Also:

AbstractAttributeEditorChip.getValue()

getStringWithMarks

public String getStringWithMarks()

markDiffs

protected String markDiffs()
                    throws IOException

In order to provide a richer difference between old and new value. Override this method and provide web frontend representation of differences as required.

Throws:

IOException

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

See Also:

Chip.getJSPURI()

setOldValueEditorType

public void setOldValueEditorType(String oldValueEditorType)

Specified by:

setOldValueEditorType in interface DiffDisplayChip

See Also:

DiffDisplayChip.setOldValueEditorType(java.lang.String)

getOldValueEditorType

public String getOldValueEditorType()

Specified by:

getOldValueEditorType in interface DiffDisplayChip

See Also:

DiffDisplayChip.getOldValueEditorType()

isWysiwygEditor

public boolean isWysiwygEditor()

Is the old value displayed by a wysiwyg editor.

isTextAreaEditor

public boolean isTextAreaEditor()

Is the old value displayed by a textarea editor.

isStringEditor

public boolean isStringEditor()

Is the old value displayed by a textarea editor.

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 AbstractAttributeEditorChip