de.hybris.platform.hmc.attribute

Class SelectLayoutChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.attribute.AbstractAttributeEditorChip

de.hybris.platform.hmc.attribute.SelectLayoutChip

All Implemented Interfaces:

Chip, Serializable, Cloneable

Direct Known Subclasses:

AllInstancesSelectEditorChip, AttributeDescriptorSelectEditorChip, EnumerationValueSelectEditorChip, LocalizableAttributeSelectChip.LanguageSelectEditorChip, SimpleSelectLayoutChip, StringSelectEditorChip

public abstract class SelectLayoutChip
extends AbstractAttributeEditorChip

This attribute chip implements a input field for a known set of valid values by a HTML select tag.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	HIDE_NULL
protected String	noSelectionKey
static String	SET_VALUE
protected List	theValues

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
SelectLayoutChip(DisplayState displayState, Chip parent) Constructor for creating a new select attribute chip.
SelectLayoutChip(DisplayState displayState, Chip parent, Object value)

Method Summary

Modifier and Type	Method and Description
protected abstract List	getAllValues() When implementing this method, make sure that you use reasonable local caching for your values.
int	getCount()
int	getHeight() OverridesAbstractAttributeEditorChip.getHeight() to return a different height than the default editor height.
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
String	getNoSelectionText()
int	getSize()
String	getStringValue(int pos)
boolean	isAjaxUpdatable() Returns true if this editor chip is ajax updatable.
boolean	isHideNull()
boolean	isLocalized()
boolean	isSelected(int pos)
void	processEvents(Map events) Handles all incoming requests for this chip.
void	setHideNull(boolean hideNull)
void	setLocalized(boolean value)
void	setNoSelectionKey(String key)
void	setParameters(Map parameters) Sets the parameters which where provided by the xml configuration.
void	setSize(int size)
void	setSubmitForm(boolean submitForm)
void	setValue(int pos)
boolean	submitForm()
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, convertValue, getAttributeChip, getAttributeDescriptor, getAttributeValueChangeListeners, getEditorType, getFieldID, 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

Field Detail

SET_VALUE

public static final String SET_VALUE

See Also:

Constant Field Values

HIDE_NULL

public static final String HIDE_NULL

Since:

2.20

See Also:

Constant Field Values

theValues

protected List theValues

noSelectionKey

protected String noSelectionKey

Constructor Detail

SelectLayoutChip

public SelectLayoutChip(DisplayState displayState,
                        Chip parent)

Constructor for creating a new select attribute chip.

Parameters:

displayState - The current displaystate this chip belongs to.

parent - The parent chip.

SelectLayoutChip

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

Method Detail

processEvents

public void processEvents(Map events)

Description copied from interface: Chip

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

getAllValues

protected abstract List getAllValues()

When implementing this method, make sure that you use reasonable local caching for your values. This method will be invoked several times!

setValue

public void setValue(int pos)

getJSPURI

public String getJSPURI()

Description copied from interface: Chip

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

setSubmitForm

public void setSubmitForm(boolean submitForm)

submitForm

public boolean submitForm()

Returns:

Indicates whether chip has to submit the form after change in select

setSize

public void setSize(int size)

getSize

public int getSize()

setLocalized

public void setLocalized(boolean value)

isLocalized

public boolean isLocalized()

toString

protected abstract String toString(Object value)

Returns the given value as String. It is save to assume that this value is one of the possible values.

getStringValue

public String getStringValue(int pos)

getCount

public int getCount()

isSelected

public boolean isSelected(int pos)

setNoSelectionKey

public void setNoSelectionKey(String key)

getNoSelectionText

public String getNoSelectionText()

getHeight

public int getHeight()

OverridesAbstractAttributeEditorChip.getHeight() to return a different height than the default editor height.

Overrides:

getHeight in class AbstractAttributeEditorChip

Returns:

the (desired) height of this chip.

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.

isHideNull

public boolean isHideNull()

Since:

2.20

setHideNull

public void setHideNull(boolean hideNull)

Since:

2.20

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