de.hybris.platform.hmc.attribute

Class ReferenceMultiSelectEditorChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.attribute.AbstractAttributeEditorChip

de.hybris.platform.hmc.attribute.ReferenceMultiSelectEditorChip

All Implemented Interfaces:

Chip, Serializable, Cloneable

Direct Known Subclasses:

ImpExReferenceMultiSelectEditorChip

public class ReferenceMultiSelectEditorChip
extends AbstractAttributeEditorChip

Since:

2.20

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	PING
static String	SET_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
ReferenceMultiSelectEditorChip(DisplayState displayState, Chip parent, CollectionType type)

Method Summary

Modifier and Type	Method and Description
protected List	createPossibleEntries()
CollectionType	getCollectionType()
String	getDisplayString(Object item)
static String	getEditorType()
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
List	getPossibleEntries() Returns all the possible entries for this editor.
String	getSelectionOfAttributeQualifier() Returns the qualifier of the attribute in which the 'source items' of this editor are found (i.e.
int	getSize() Returns the size of the select box (the number of visible rows).
int	indexOf(Object item) Returns the index of the given item within the 'possible entries' list.
boolean	isAjaxUpdatable() Returns true if this editor chip is ajax updatable.
boolean	isItemSelected(Object item) Returns true if the given item is selected.
void	processEvents(Map events) Process the SET_VALUE event by which the selected values are added to this editor's collection value.
void	setCollectionType(CollectionType collectionType)
void	setPossibleEntries(List possibleEntries)
void	setSelectionOfAttributeQualifier(String selectionOfAttributeQualifier)
void	setSize(int size) Sets the size of the select box (the number of visible rows).

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

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

PING

public static final String PING

See Also:

Constant Field Values

Constructor Detail

ReferenceMultiSelectEditorChip

public ReferenceMultiSelectEditorChip(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 new value, must not be null.

Method Detail

processEvents

public void processEvents(Map events)

Process the SET_VALUE event by which the selected values are added to this editor's collection value.

getJSPURI

public String getJSPURI()

Description copied from interface: Chip

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

getCollectionType

public CollectionType getCollectionType()

setCollectionType

public void setCollectionType(CollectionType collectionType)

createPossibleEntries

protected List createPossibleEntries()

getPossibleEntries

public List getPossibleEntries()

Returns all the possible entries for this editor. If the 'selectionof' attribute of has been set then the given attribute of the enclosing item will be used to provide the possible entries. If the element type of this editor's collectiontype is an EnumerationMetaType then all existing EnumerationValues of this type will be returned as possible entries. If the element type is 'normal' composed type then all instances of this type will be possible entries.

Returns:

a collection of items which represent the possible (allowed) entries for this collection attribute editor.

setPossibleEntries

public void setPossibleEntries(List possibleEntries)

See Also:

getPossibleEntries()

indexOf

public int indexOf(Object item)

Returns the index of the given item within the 'possible entries' list. Is used to reference the items in the jsp's select box.

Parameters:

item - the Item for which to find the index

Returns:

the index of the given item within the 'possible entries' list.

getDisplayString

public String getDisplayString(Object item)

isItemSelected

public boolean isItemSelected(Object item)

Returns true if the given item is selected. I.e. the item is found in the collection which represents the value of this collection attribute editor.

Returns:

true if the given item is selected

getSize

public int getSize()

Returns the size of the select box (the number of visible rows).

Returns:

the size of the select box (the number of visible rows).

setSize

public void setSize(int size)

Sets the size of the select box (the number of visible rows).

Parameters:

size - The size to set.

getSelectionOfAttributeQualifier

public String getSelectionOfAttributeQualifier()

Returns the qualifier of the attribute in which the 'source items' of this editor are found (i.e. another attribute at this editor's enlosing item contains a collection of items which is the list of possible enries for this editor).

setSelectionOfAttributeQualifier

public void setSelectionOfAttributeQualifier(String selectionOfAttributeQualifier)

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

getEditorType

public static String getEditorType()