de.hybris.platform.hmc.generic

Class GenericListEditorChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.attribute.AbstractAttributeEditorChip

de.hybris.platform.hmc.generic.GenericListEditorChip

All Implemented Interfaces:

SpecialSaveChip, Chip, Serializable, Cloneable

Direct Known Subclasses:

GenericResortableListEditorChip

public class GenericListEditorChip
extends AbstractAttributeEditorChip
implements SpecialSaveChip

Editor for a collection displaying a GenericListChip for editing. This chip has large amounts of code in common with GenericReferenceListEditorChip. Unfortunately it cannot be superclass since GenericReferenceListEditorChip contains a GenericItemListChip which is a subclass of ItemListChip.

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
GenericListEditorChip(DisplayState displayState, Chip parent, CollectionType type)
GenericListEditorChip(DisplayState displayState, Chip parent, CollectionType type, boolean resortable)
GenericListEditorChip(DisplayState displayState, Chip parent, CollectionType type, Collection initialValue)
GenericListEditorChip(DisplayState displayState, Chip parent, CollectionType type, Collection initialValue, boolean resortable)

Method Summary

Modifier and Type	Method and Description
void	checkValid() Gives the chip the possibility to check if its objects are still valid.
protected Collection	convertListEntries(List listEntries)
static String	getEditorType()
Object	getInitialValue()
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
GenericListChip	getListChip()
Collection	getSelectedValues()
protected CollectionType	getType()
Object	getValue() Returns the content of this chip as a collection.
boolean	isChanged() Overrides AbstractAttributeEditorChip.isChanged() to treat initial null values as being equal to empty collections
void	processEvents(Map events) Handles all incoming requests for this chip.
void	save()
void	setSelectedValues(Collection selected) Changes the currently selected values.
void	setValue(Object object) Sets the content of this chip.
void	setWidth(int width) Overrides AbstractAttributeEditorChip.setWidth(int) to set the correct width in the listeditor.

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, 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

GenericListEditorChip

public GenericListEditorChip(DisplayState displayState,
                             Chip parent,
                             CollectionType type,
                             Collection initialValue)

Parameters:

displayState - The current displaystate this chip belongs to.

parent - The composition parent chip.

type - the type of the collection

initialValue - the initial value. Must not be null or empty.

GenericListEditorChip

public GenericListEditorChip(DisplayState displayState,
                             Chip parent,
                             CollectionType type,
                             Collection initialValue,
                             boolean resortable)

GenericListEditorChip

public GenericListEditorChip(DisplayState displayState,
                             Chip parent,
                             CollectionType type)

Parameters:

displayState - The current displaystate this chip belongs to.

parent - The composition parent chip.

type - the type of the collection

GenericListEditorChip

public GenericListEditorChip(DisplayState displayState,
                             Chip parent,
                             CollectionType type,
                             boolean resortable)

Parameters:

displayState - The current displaystate this chip belongs to.

parent - The composition parent chip.

type - the type of the collection

Method Detail

getType

protected CollectionType getType()

Returns:

The type of the collection.

getListChip

public GenericListChip getListChip()

setWidth

public void setWidth(int width)

Overrides AbstractAttributeEditorChip.setWidth(int) to set the correct width in the listeditor.

Overrides:

setWidth in class AbstractAttributeEditorChip

See Also:

AbstractAttributeEditorChip.setWidth(int)

getValue

public Object getValue()

Returns the content of this chip as a collection.

Overrides:

getValue in class AbstractAttributeEditorChip

convertListEntries

protected Collection convertListEntries(List listEntries)

getSelectedValues

public Collection getSelectedValues()

setValue

public void setValue(Object object)

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

Overrides:

setValue in class AbstractAttributeEditorChip

setSelectedValues

public void setSelectedValues(Collection selected)
                       throws JaloInvalidParameterException

Changes the currently selected values.

Parameters:

selected -

Throws:

JaloInvalidParameterException - if one of the new selected values is not contained within the list.

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

getEditorType

public static String getEditorType()

Returns:

the editor type of this chip.

isChanged

public boolean isChanged()

Overrides AbstractAttributeEditorChip.isChanged() to treat initial null values as being equal to empty collections

Overrides:

isChanged in class AbstractAttributeEditorChip

Returns:

true if the value of this editor has been changed.

Since:

2.00

getInitialValue

public Object getInitialValue()

Overrides:

getInitialValue in class AbstractAttributeEditorChip

save

public void save()

Specified by:

save in interface SpecialSaveChip

Since:

2.20