de.hybris.platform.hmc.generic

Class GenericReferenceListEditorChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.attribute.AbstractAttributeEditorChip

de.hybris.platform.hmc.generic.GenericReferenceListEditorChip

All Implemented Interfaces:

SpecialSaveChip, Chip, Serializable, Cloneable

Direct Known Subclasses:

ClassificationVariantListEditorChip, GenericResortableReferenceListEditorChip, ResultTypeAttributesChip, TypeAttributesChip, VersionAwareLanguageReferenceListChip

public class GenericReferenceListEditorChip
extends AbstractAttributeEditorChip
implements SpecialSaveChip

Editor for a collection reference displaying a GenericItemListChip for editing.

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

Method Summary

Modifier and Type	Method and Description
protected void	adjustElementType()
void	checkValid() Gives the chip the possibility to check if its objects are still valid.
boolean	containsValidValue()
protected Collection	convertEntryList(List entryList)
protected GenericItemListChip	createListChip(boolean resortable, ComposedType elementType, boolean isPartOf)
boolean	entriesEditable()
ReferenceEditorNode	getEditorNode()
static String	getEditorType()
Object	getInitialValue()
protected Item	getItem()
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
GenericItemListChip	getListChip()
Collection	getSelectedValues()
protected CollectionType	getType()
protected String	getTypeAttribute()
Object	getValue()
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.
protected void	refreshEntries()
void	save()
void	setEntriesEditable(boolean editable) If set to true the entries of this editor's listchip will be editable.
void	setInitialValue(Object initialValue)
void	setItemLayoutNode(ItemLayoutNode layoutNode) Sets the layoutdescriptor the listchip of this chip should use to render its content.
void	setParameters(Map map) Sets the parameters which where provided by the xml configuration.
void	setSelectedValues(Collection selected) Changes the currently selected values.
void	setTypeAttribute(String typeAttribute) This method must only be called from ReferenceCollectionEditorNode !!!!
void	setValue(Object object)
void	setWidth(int width)

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

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

GenericReferenceListEditorChip

public GenericReferenceListEditorChip(DisplayState displayState,
                                      Chip parent,
                                      CollectionType type,
                                      Collection initialValue,
                                      boolean isPartOf)

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.

isPartOf - True, if the edited attributedescriptor is partof.

GenericReferenceListEditorChip

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

GenericReferenceListEditorChip

public GenericReferenceListEditorChip(DisplayState displayState,
                                      Chip parent,
                                      CollectionType type,
                                      boolean isPartOf)

Parameters:

displayState - The current displaystate this chip belongs to.

parent - The composition parent chip.

type - the type of the collection

GenericReferenceListEditorChip

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

Parameters:

displayState - The current displaystate this chip belongs to.

parent - The composition parent chip.

type - the type of the collection

Method Detail

getItem

protected Item getItem()

getType

protected CollectionType getType()

Returns:

The type of the collection.

getListChip

public GenericItemListChip getListChip()

createListChip

protected GenericItemListChip createListChip(boolean resortable,
                                             ComposedType elementType,
                                             boolean isPartOf)

Parameters:

resortable -

elementType -

isPartOf -

Returns:

a GenericResortableItemListChip if resortable is true, otherwise a GenericItemListChip

Since:

2.20

setItemLayoutNode

public void setItemLayoutNode(ItemLayoutNode layoutNode)

Sets the layoutdescriptor the listchip of this chip should use to render its content.

convertEntryList

protected Collection convertEntryList(List entryList)

getValue

public Object getValue()

Overrides:

getValue in class AbstractAttributeEditorChip

getSelectedValues

public Collection getSelectedValues()

setValue

public void setValue(Object object)

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

save

public void save()

Specified by:

save in interface SpecialSaveChip

refreshEntries

protected void refreshEntries()

Since:

2.20

containsValidValue

public boolean containsValidValue()

Overrides:

containsValidValue in class AbstractAttributeEditorChip

getEditorNode

public ReferenceEditorNode getEditorNode()

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. Additionally if this editor has editable entries (see setEntriesEditable(boolean)) this method returns true if any of the contained editors have been changed.

Overrides:

isChanged in class AbstractAttributeEditorChip

Returns:

true if the value of this editor has been changed.

Since:

2.00

setWidth

public void setWidth(int width)

Overrides:

setWidth in class AbstractAttributeEditorChip

getInitialValue

public Object getInitialValue()

Overrides:

getInitialValue in class AbstractAttributeEditorChip

setEntriesEditable

public void setEntriesEditable(boolean editable)

If set to true the entries of this editor's listchip will be editable.

Parameters:

editable - If set to true the entries of this editor's listchip will be editable.

Since:

2.20

entriesEditable

public boolean entriesEditable()

Returns:

true if the entries are editable

Since:

2.20

setTypeAttribute

public void setTypeAttribute(String typeAttribute)

This method must only be called from ReferenceCollectionEditorNode !!!!

Since:

2.20

getTypeAttribute

protected String getTypeAttribute()

Since:

2.20

adjustElementType

protected void adjustElementType()

Since:

2.20

setInitialValue

public void setInitialValue(Object initialValue)

Overrides:

setInitialValue in class AbstractAttributeEditorChip

setParameters

public void setParameters(Map map)

Description copied from class: AbstractAttributeEditorChip

Sets the parameters which where provided by the xml configuration.

Overrides:

setParameters in class AbstractAttributeEditorChip

Parameters:

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