de.hybris.platform.hmc.attribute

Class StringLayoutChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.attribute.AbstractAttributeEditorChip

de.hybris.platform.hmc.attribute.StringLayoutChip

All Implemented Interfaces:

Chip, EventCheckingChip, Serializable, Cloneable

Direct Known Subclasses:

AutomatedWorkflowActionTemplateClassEditorChip, CharacterEditorChip, CreditCardNumberEditorChip, DateEditorChip, JavaClassEditorChip, NumberEditorChip, StringEditorChip, TextAreaLayoutChip

public abstract class StringLayoutChip
extends AbstractAttributeEditorChip
implements EventCheckingChip

Editor using the layout of an string input fields. This is the base class for string and number editors.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	SET_VALUE Event string for transfering the 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
StringLayoutChip(DisplayState displayState, Chip parent) Constructor for creating a new string attribute chip for input of not inheritable values.
StringLayoutChip(DisplayState displayState, Chip parent, Object value)

Method Summary

Modifier and Type	Method and Description
protected Object	convertValue(Object vbject) Parses the given string value by calling parse(String) and checks missing values for mandatory attributes.
Set	getAcceptedEvents()
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
String	getQuotedStringValue()
String	getStringValue() Get the value of this chip as a string.
boolean	isAjaxUpdatable() Returns true if this editor chip is ajax updatable.
boolean	isAlignRight()
boolean	isDBEncrypted()
boolean	isEncoded()
protected abstract 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	setAlignRight(boolean alignRight)
void	setEncoded(boolean encoded)
void	setParameters(Map parameters) Sets the parameters which where provided by the xml configuration.
protected abstract String	toString(Object value) Returns the given value as String.

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

addAttributeValueChangeListener, checkValid, clearError, containsValidValue, convertAndSetValue, getAttributeChip, getAttributeDescriptor, getAttributeValueChangeListeners, getEditorType, 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

SET_VALUE

public static final String SET_VALUE

Event string for transfering the value.

See Also:

Constant Field Values

Constructor Detail

StringLayoutChip

public StringLayoutChip(DisplayState displayState,
                        Chip parent)

Constructor for creating a new string attribute chip for input of not inheritable values.

Parameters:

displayState - The current displaystate this chip belongs to.

parent - The composition parent chip.

StringLayoutChip

public StringLayoutChip(DisplayState displayState,
                        Chip parent,
                        Object value)

Method Detail

setEncoded

public void setEncoded(boolean encoded)

isEncoded

public boolean isEncoded()

Returns:

If the value of this input chip should be displayed in a password input field. Default value is FALSE.

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

getStringValue

public String getStringValue()

Get the value of this chip as a string. If no value is set an empty string will be returned.
Note: If you override this method, make sure to never return null! Some methods might not test for a null when using getStringValue().

Returns:

the value contained in this chip as a string.

isDBEncrypted

public boolean isDBEncrypted()

parse

protected abstract Object parse(String value)
                         throws ParseException

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

Throws:

ParseException

toString

protected abstract String toString(Object value)

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

convertValue

protected Object convertValue(Object vbject)
                       throws Exception

Parses the given string value by calling parse(String) and checks missing values for mandatory attributes.

Overrides:

convertValue in class AbstractAttributeEditorChip

Parameters:

vbject - the unconverted value

Returns:

the converted value

Throws:

Exception - on any conversion error

See Also:

AbstractAttributeEditorChip.getLastInvalidValue()

getAcceptedEvents

public Set getAcceptedEvents()

Specified by:

getAcceptedEvents in interface EventCheckingChip

processEvents

public void processEvents(Map events)

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

Specified by:

processEvents in interface Chip

getQuotedStringValue

public String getQuotedStringValue()

isAlignRight

public boolean isAlignRight()

Since:

2.20

setAlignRight

public void setAlignRight(boolean alignRight)

Since:

2.20

setParameters

public void setParameters(Map parameters)

Description copied from class: AbstractAttributeEditorChip

Sets the parameters which where provided by the xml configuration.

Overrides:

setParameters in class AbstractAttributeEditorChip

Parameters:

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

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