de.hybris.platform.hmc.attribute

Class MapTypeEditorChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.attribute.AbstractAttributeEditorChip

de.hybris.platform.hmc.attribute.MapTypeEditorChip

All Implemented Interfaces:

SpecialSaveChip, Chip, Serializable, Cloneable

public class MapTypeEditorChip
extends AbstractAttributeEditorChip
implements SpecialSaveChip

Editor for a map type.

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
MapTypeEditorChip(DisplayState displayState, Chip parent, MapType type)
MapTypeEditorChip(DisplayState displayState, Chip parent, MapType type, Map value)

Method Summary

Modifier and Type	Method and Description
void	checkValid() Gives the chip the possibility to check if its objects are still valid.
protected GenericMapTypeListChip	createListChip() Is called by initialize(MapType) to create the internally used GenericMapTypeListChip.
static String	getEditorType()
Object	getInitialValue()
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
GenericMapTypeListChip	getListChip()
int	getListEntryCount()
protected MapType	getType()
Object	getValue() Returns the content of this chip as a map type.
protected void	initialize(MapType mapType) Initializes the editor.
boolean	isAllSelected()
boolean	isEmpty()
boolean	isMultipleSelectionAllowed()
void	processEvents(Map events) Handles all incoming requests for this chip.
void	save()
void	setAdd(boolean canAdd)
void	setKeyName(String name)
void	setKeyWidth(int width)
protected void	setListChip(GenericMapTypeListChip listChip)
void	setRemove(boolean canRemove)
void	setValue(Object object) Sets the content of this chip.
void	setValueName(String name)
void	setWidth(int width)

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

addAttributeValueChangeListener, clearError, containsValidValue, convertAndSetValue, convertValue, getAttributeChip, getAttributeDescriptor, getAttributeValueChangeListeners, getFieldID, getHeight, getLastInvalidValue, getMaxLength, getParameters, getParentEditorChip, getProposedUniqueName, getWidth, isAjaxUpdatable, isChanged, isEditable, isInitialized, isOptional, notifyAttributeValueChangeListeners, removeAttributeValueChangeListener, setAttributeDescriptor, setEditable, setError, setFieldID, setHeight, setInitialValue, setMaxLength, setOptional, setParameters, setValidValue, 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, dispose, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getID, getJaloSession, getMenuEntries, getParent, getUniqueName, goFullScreen, isValid, leaveFullScreen, registerUniqueName, removeEventListener, render, translateFormFieldToEventName, translateFormFieldToEventValue

Constructor Detail

MapTypeEditorChip

public MapTypeEditorChip(DisplayState displayState,
                         Chip parent,
                         MapType type,
                         Map value)

MapTypeEditorChip

public MapTypeEditorChip(DisplayState displayState,
                         Chip parent,
                         MapType type)

Method Detail

initialize

protected void initialize(MapType mapType)

Initializes the editor.

• Set the specified MapType
• Calls createListChip to create the internal GenericMapTypeListChip instance
• Sets the width of the GenericMapTypeListChip to the value of getWidth()

Parameters:

mapType - the MapType the editor will display

Since:

2.20

createListChip

protected GenericMapTypeListChip createListChip()

Is called by initialize(MapType) to create the internally used GenericMapTypeListChip. Should be overriden in subclasses, if you want to use an subclass of GenericMapTypeListChip.

Returns:

the GenericMapTypeListChip used by this editor

Since:

2.20

getType

protected MapType getType()

Returns:

The type of the map.

checkValid

public void checkValid()

Description copied from class: AbstractChip

Gives the chip the possibility to check if its objects are still valid. If you override this method, call super.checkValid()

Specified by:

checkValid in interface Chip

Overrides:

checkValid in class AbstractAttributeEditorChip

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)

Specified by:

processEvents in interface Chip

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

getListChip

public GenericMapTypeListChip getListChip()

setListChip

protected void setListChip(GenericMapTypeListChip listChip)

Since:

2.20

setWidth

public void setWidth(int width)

Overrides:

setWidth in class AbstractAttributeEditorChip

getValue

public Object getValue()

Returns the content of this chip as a map type.

Overrides:

getValue in class AbstractAttributeEditorChip

setValue

public void setValue(Object object)

Sets the content of this chip. The given object has to be a Map or NULL.

Overrides:

setValue in class AbstractAttributeEditorChip

isEmpty

public boolean isEmpty()

isAllSelected

public boolean isAllSelected()

getListEntryCount

public int getListEntryCount()

isMultipleSelectionAllowed

public boolean isMultipleSelectionAllowed()

getEditorType

public static String getEditorType()

Returns:

the editor type of this chip.

getInitialValue

public Object getInitialValue()

Overrides:

getInitialValue in class AbstractAttributeEditorChip

setAdd

public void setAdd(boolean canAdd)

setRemove

public void setRemove(boolean canRemove)

setKeyWidth

public void setKeyWidth(int width)

setKeyName

public void setKeyName(String name)

setValueName

public void setValueName(String name)

save

public void save()

Specified by:

save in interface SpecialSaveChip

Since:

2.30