de.hybris.platform.hmc.attribute

Class AllInstancesSelectEditorChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.attribute.AbstractAttributeEditorChip

de.hybris.platform.hmc.attribute.SelectLayoutChip

de.hybris.platform.hmc.attribute.AllInstancesSelectEditorChip

All Implemented Interfaces:

ItemAcceptor, Chip, Serializable, Cloneable

public class AllInstancesSelectEditorChip
extends SelectLayoutChip
implements ItemAcceptor

Internal use!

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	COPY
static String	CREATE
static String	OPEN_EDITOR
static String	OPEN_EDITOR_INTERNAL
static String	PASTE

Fields inherited from class de.hybris.platform.hmc.attribute.SelectLayoutChip

HIDE_NULL, noSelectionKey, 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
AllInstancesSelectEditorChip(DisplayState displayState, Chip parent, ComposedType type)
AllInstancesSelectEditorChip(DisplayState displayState, Chip parent, ComposedType type, Object value)

Method Summary

Modifier and Type	Method and Description
boolean	allowsMultipleSelection() Implementation of ItemAcceptor.allowsMultipleSelection() which returns false;
boolean	canCreate()
boolean	canPaste()
protected List	getAllValues() When implementing this method, make sure that you use reasonable local caching for your values.
protected ReferenceEditorNode	getEditorNode()
static String	getEditorType()
protected ComposedType	getItemType()
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
List	getMenuEntries() Here you can specify what Actions you are able to perform at the moment.
Object	getValue() Is overridden to prevent non-alive items to be accessed.
boolean	hasItem()
boolean	isElementReadable()
boolean	isElementWriteable()
boolean	isPartOf()
void	openEditor()
void	openEditor(boolean external)
void	processEvents(Map events) Processes the given map of events.
void	resetEntries() Removes cached values so that they will be rebuild the next time getAllValues() is called.
void	setInitialValue(Object initialValue) Superclass method overridden to set item type if none has been set (preventing exception in 'type safe' setValue(Object)..
void	setItemType(ComposedType type)
void	setSelectedItems(List items) Implementation of ItemAcceptor.setSelectedItems() which sets the value of this editor chip to the first item in the given list (which may be null).
void	setValue(Object value) Superclass method overridden to check correct object type.
protected String	toString(Object value) Returns the given value as String.

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

getCount, getHeight, getNoSelectionText, getSize, getStringValue, isAjaxUpdatable, isHideNull, isLocalized, isSelected, setHideNull, setLocalized, setNoSelectionKey, setParameters, setSize, setSubmitForm, setValue, submitForm

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

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

CREATE

public static final String CREATE

See Also:

Constant Field Values

COPY

public static final String COPY

See Also:

Constant Field Values

PASTE

public static final String PASTE

See Also:

Constant Field Values

OPEN_EDITOR

public static final String OPEN_EDITOR

See Also:

Constant Field Values

OPEN_EDITOR_INTERNAL

public static final String OPEN_EDITOR_INTERNAL

See Also:

Constant Field Values

Constructor Detail

AllInstancesSelectEditorChip

public AllInstancesSelectEditorChip(DisplayState displayState,
                                    Chip parent,
                                    ComposedType type,
                                    Object value)

AllInstancesSelectEditorChip

public AllInstancesSelectEditorChip(DisplayState displayState,
                                    Chip parent,
                                    ComposedType type)

Method Detail

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

Overrides:

getJSPURI in class SelectLayoutChip

getAllValues

protected List getAllValues()

Description copied from class: SelectLayoutChip

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

Specified by:

getAllValues in class SelectLayoutChip

resetEntries

public void resetEntries()

Removes cached values so that they will be rebuild the next time getAllValues() is called.

toString

protected String toString(Object value)

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

Specified by:

toString in class SelectLayoutChip

getEditorType

public static String getEditorType()

Returns:

the editor type of this chip.

hasItem

public boolean hasItem()

processEvents

public void processEvents(Map events)

Processes the given map of events.

Specified by:

processEvents in interface Chip

Overrides:

processEvents in class SelectLayoutChip

canPaste

public boolean canPaste()

isPartOf

public boolean isPartOf()

openEditor

public void openEditor()

openEditor

public void openEditor(boolean external)

Since:

3.00 (beta1)

getEditorNode

protected ReferenceEditorNode getEditorNode()

setItemType

public void setItemType(ComposedType type)

Parameters:

type -

getItemType

protected ComposedType getItemType()

setValue

public void setValue(Object value)

Superclass method overridden to check correct object type.

Overrides:

setValue in class AbstractAttributeEditorChip

setSelectedItems

public void setSelectedItems(List items)

Implementation of ItemAcceptor.setSelectedItems() which sets the value of this editor chip to the first item in the given list (which may be null).

Specified by:

setSelectedItems in interface ItemAcceptor

allowsMultipleSelection

public boolean allowsMultipleSelection()

Implementation of ItemAcceptor.allowsMultipleSelection() which returns false;

Specified by:

allowsMultipleSelection in interface ItemAcceptor

isElementReadable

public boolean isElementReadable()

Returns:

true if the referenced item is null or readable.

isElementWriteable

public boolean isElementWriteable()

Returns:

true if the referenced item is either null and createable or not null and writeable.

canCreate

public boolean canCreate()

getValue

public Object getValue()

Is overridden to prevent non-alive items to be accessed.

Overrides:

getValue in class AbstractAttributeEditorChip

setInitialValue

public void setInitialValue(Object initialValue)

Superclass method overridden to set item type if none has been set (preventing exception in 'type safe' setValue(Object)..

Overrides:

setInitialValue in class AbstractAttributeEditorChip

getMenuEntries

public List getMenuEntries()

Description copied from class: AbstractChip

Here you can specify what Actions you are able to perform at the moment. Should be overridden in sub classes.

Specified by:

getMenuEntries in interface Chip

Overrides:

getMenuEntries in class AbstractChip

Returns:

List of Actions;

Since:

2.30

See Also:

AbstractChip.getMenuEntries()