de.hybris.platform.hmc

Class AbstractSelectToolbarActionChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.AbstractToolbarActionChip

de.hybris.platform.hmc.AbstractSelectToolbarActionChip

All Implemented Interfaces:

Chip, EventCheckingChip, Serializable, Cloneable

Direct Known Subclasses:

AttributeSelectToolbarActionChip, CatalogToolbarActionChip, LanguageSelectToolbarActionChip, RefreshIntervalToolbarActionChip, SavedQuerySelectToolbarActionChip, StringSelectToolbarActionChip, TypeSelectToolbarActionChip

public abstract class AbstractSelectToolbarActionChip
extends AbstractToolbarActionChip

Represents a selectable list of values (usually visualized as a select box) within a toolbar (e.g. in an instance of AbstractToolbarChip).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractSelectToolbarActionChip.Entry
static class	AbstractSelectToolbarActionChip.EntryComparator Default comparator for Entries.

Nested classes/interfaces inherited from class de.hybris.platform.hmc.AbstractToolbarActionChip

AbstractToolbarActionChip.ToolbarActionListener

Field Summary

Fields

Modifier and Type	Field and Description
static String	URI

Fields inherited from class de.hybris.platform.hmc.AbstractToolbarActionChip

accepted, ALIGN_LEFT, ALIGN_RIGHT, PERFORM

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
AbstractSelectToolbarActionChip(DisplayState displayState, AbstractToolbarChip parent, String label, String event, String javascript) Creates a new AbstractSelectToolbarActionChip which can be placed in an AbstractToolbarChip.

Method Summary

Modifier and Type	Method and Description
protected void	assureUniqueDisplayValues(Collection<AbstractSelectToolbarActionChip.Entry> entries)
boolean	containsDisplayValue(String displayValue)
boolean	containsValue(Object value)
protected abstract List	createEntries() Must be implemented by subclasses and should return a list containing the entries of this selector.
Comparator	getComparator()
protected AbstractSelectToolbarActionChip.Entry	getDefaultSelectedEntry()
List	getEntries() Returns this selector's entries.
protected AbstractSelectToolbarActionChip.Entry	getEntryByDisplayValue(String displayValue) Returns the Entry with the given displayValue or null if the Entry could not be found.
protected AbstractSelectToolbarActionChip.Entry	getEntryByValue(Object value) Returns the Entry with the given value or null if the Entry could not be found.
String	getJSPURI() Returns the uri for the jsp corresponding to this chip.
AbstractSelectToolbarActionChip.Entry	getSelectedEntry() Returns the currently selected Entry.
Object	getSelectedValue() Returns the currently selected Entry value object.
boolean	isButtonPushed(List eventValues, String eventName) Superclass method overridden to enable button-like behaviour for lists too
boolean	isCommandAction()
boolean	isEmpty() Returns true, if there are no entries defined for this select chip.
boolean	isEnabled() Is overridden to additionally test whether the selector contains more than one entry.
boolean	isSelected(AbstractSelectToolbarActionChip.Entry entry) Returns true if the given Entry is equal to the currently selected Entry.
boolean	isSelected(String displayValue) Returns true if the given displayValue equals the displayValue of the currently selected Entry.
void	processEvents(Map events) If the event of this selector is found, the appropriate entry will be selected.
void	resetEntries() Sets the entries list null to force the call of createEntries() the next time getEntries() is invoked, thus resetting/refreshing the entries list.
void	setCommandAction(boolean commandAction)
void	setComparator(Comparator comparator)
void	setSelectedEntry(AbstractSelectToolbarActionChip.Entry entry) Set the currently selected Entry.
void	setSelectedEntryByDisplayValue(String displayValue)
void	setSelectedValue(Object value)
void	setUseComparator(boolean useComparator)
boolean	useComparator()

Methods inherited from class de.hybris.platform.hmc.AbstractToolbarActionChip

addActionListener, getAcceptedEvents, getAccessKey, getAlignment, getConfirmationMessage, getEvent, getJavaScript, getLabel, getProposedUniqueName, getToolbarType, getTooltip, getWidth, isPartOf, isVisible, notifyActionPerformed, perform, removeActionListener, setAccessKey, setAlignment, setConfirmationMessage, setEnabled, setEvent, setJavaScript, setLabel, setShowLabel, setTooltip, setVisible, setWidth, showLabel

Methods inherited from class de.hybris.platform.hmc.webchips.AbstractChip

addEventListener, checkValid, 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, 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, checkValid, dispose, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getID, getJaloSession, getMenuEntries, getParent, getUniqueName, goFullScreen, isValid, leaveFullScreen, registerUniqueName, removeEventListener, render, translateFormFieldToEventName, translateFormFieldToEventValue

Field Detail

URI

public static final String URI

See Also:

Constant Field Values

Constructor Detail

AbstractSelectToolbarActionChip

public AbstractSelectToolbarActionChip(DisplayState displayState,
                                       AbstractToolbarChip parent,
                                       String label,
                                       String event,
                                       String javascript)

Creates a new AbstractSelectToolbarActionChip which can be placed in an AbstractToolbarChip.

Parameters:

displayState - the current DisplayState

parent - the parent of this chip, usually this would be the chip which creates this

label -

event -

javascript -

Method Detail

getJSPURI

public String getJSPURI()

Returns the uri for the jsp corresponding to this chip.

Specified by:

getJSPURI in interface Chip

Specified by:

getJSPURI in class AbstractToolbarActionChip

createEntries

protected abstract List createEntries()

Must be implemented by subclasses and should return a list containing the entries of this selector. (Whether the list is created only once or each time this method is called, depends on the implementation in the subclass) This method should at least return an empty List (never null)!

Returns:

List of Entry objects

getEntries

public List getEntries()

Returns this selector's entries. If no entries are set, createEntries() is called to create the entries list. If useComparator() returns true, the list will be sorted using the Comparator returned by getComparator().

Returns:

a List containing Entry objects

assureUniqueDisplayValues

protected void assureUniqueDisplayValues(Collection<AbstractSelectToolbarActionChip.Entry> entries)

resetEntries

public void resetEntries()

Sets the entries list null to force the call of createEntries() the next time getEntries() is invoked, thus resetting/refreshing the entries list.

getSelectedValue

public Object getSelectedValue()

Returns the currently selected Entry value object. If no entry is selected, the first entry in the list will be selected and returned (if there is one).

Returns:

the currently selected Entry value object.

setSelectedValue

public void setSelectedValue(Object value)

getSelectedEntry

public AbstractSelectToolbarActionChip.Entry getSelectedEntry()

Returns the currently selected Entry. If no entry is selected, the first entry in the list will be selected and returned (if there is one).

Returns:

the currently selected Entry

getDefaultSelectedEntry

protected AbstractSelectToolbarActionChip.Entry getDefaultSelectedEntry()

setSelectedEntry

public void setSelectedEntry(AbstractSelectToolbarActionChip.Entry entry)

Set the currently selected Entry.

Parameters:

entry -

setSelectedEntryByDisplayValue

public void setSelectedEntryByDisplayValue(String displayValue)

Since:

3.00 (beta1)

containsValue

public boolean containsValue(Object value)

Parameters:

value - the object to look for

Returns:

true if the entries list contains an entry with the given value

containsDisplayValue

public boolean containsDisplayValue(String displayValue)

Parameters:

displayValue - the String to look for

Returns:

true if the entries list contains an entry with the given displayValue

isSelected

public boolean isSelected(AbstractSelectToolbarActionChip.Entry entry)

Returns true if the given Entry is equal to the currently selected Entry. Note: Two Entry objects are considered equal if their displayValue strings are equal.

Parameters:

entry -

isSelected

public boolean isSelected(String displayValue)

Returns true if the given displayValue equals the displayValue of the currently selected Entry.

Parameters:

displayValue -

processEvents

public void processEvents(Map events)

If the event of this selector is found, the appropriate entry will be selected.

Specified by:

processEvents in interface Chip

Overrides:

processEvents in class AbstractToolbarActionChip

isButtonPushed

public boolean isButtonPushed(List eventValues,
                              String eventName)

Superclass method overridden to enable button-like behaviour for lists too

Overrides:

isButtonPushed in class AbstractChip

See Also:

AbstractChip.isButtonPushed(java.util.List, java.lang.String)

getEntryByDisplayValue

protected AbstractSelectToolbarActionChip.Entry getEntryByDisplayValue(String displayValue)

Returns the Entry with the given displayValue or null if the Entry could not be found.

Parameters:

displayValue -

getEntryByValue

protected AbstractSelectToolbarActionChip.Entry getEntryByValue(Object value)

Returns the Entry with the given value or null if the Entry could not be found.

Parameters:

value - the value object to look for

isEmpty

public boolean isEmpty()

Returns true, if there are no entries defined for this select chip.

Returns:

boolean true, if entries==null || entries.isEmpty(), otherwise false;

setCommandAction

public void setCommandAction(boolean commandAction)

Parameters:

commandAction - true if this action chip should be a command action.

isCommandAction

public boolean isCommandAction()

Returns:

true if this action chip should be a command action.

isEnabled

public boolean isEnabled()

Is overridden to additionally test whether the selector contains more than one entry.

Overrides:

isEnabled in class AbstractToolbarActionChip

Returns:

true if super.isEnabled() is true and this selector contains more than one entry.

getComparator

public Comparator getComparator()

Returns:

The Comparator used to sort the List of Entrys if useComparator() returns true. The Entries will be sorted each time createEntries() is called. If no Comparator is set (using setComparator(Comparator), the default Comparator AbstractSelectToolbarActionChip.EntryComparator is used.

setComparator

public void setComparator(Comparator comparator)

setUseComparator

public void setUseComparator(boolean useComparator)

Parameters:

useComparator - Set to true to enable sorting of the entry list. The Comparator returned by getComparator() is used to sort the list.

useComparator

public boolean useComparator()

Returns:

true, if the entry list should be sorted.