de.hybris.platform.hmc

Class TypeSelectToolbarActionChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.AbstractToolbarActionChip

de.hybris.platform.hmc.AbstractSelectToolbarActionChip

de.hybris.platform.hmc.TypeSelectToolbarActionChip

All Implemented Interfaces:

ComposedTypeChangeListener, Chip, EventCheckingChip, Serializable, Cloneable

public class TypeSelectToolbarActionChip
extends AbstractSelectToolbarActionChip
implements ComposedTypeChangeListener

Implementation of AbstractSelectToolbarActionChip

Version:

version , checked in by $Author: max.friedmann $

See Also:

Serialized Form

Nested Class Summary

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

AbstractSelectToolbarActionChip.Entry, AbstractSelectToolbarActionChip.EntryComparator

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

AbstractToolbarActionChip.ToolbarActionListener

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPEN_TYPE_EXT
static String	OPEN_TYPE_INT

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

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
TypeSelectToolbarActionChip(DisplayState displayState, AbstractToolbarChip parent, String label, String event, String javascript, ComposedType type) Creates a new TypeSelectToolbarActionChip which will be filled with the given type

Method Summary

Modifier and Type	Method and Description
void	composedTypeChanged(ComposedTypeChangeEvent event) Notifies this chip of a search type change.
protected List	createEntries() Takes the typeEntries and creates the appropriate select entries for this selector.
void	filterTypes(String presetAttributeQualifier, ComposedType presetAttributeType) Removes all type entries in this selector where the given attribute qualifier either does not exist or is an incompatible type (when compared with the given type).
Set	getAcceptedEvents()
List	getEntries() Overrides AbstractSelectToolbarActionChip.getEntries() to filter incompatible type entries.
Set	getFilteredEntries()
List	getMenuEntries() Here you can specify what Actions you are able to perform at the moment.
protected String	getProposedUniqueName()
ComposedType	getSelectedType()
void	processEvents(Map events) If the event of this selector is found, the appropriate entry will be selected.
void	setSelectedType(ComposedType type) Sets the currently selected type.

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

assureUniqueDisplayValues, containsDisplayValue, containsValue, getComparator, getDefaultSelectedEntry, getEntryByDisplayValue, getEntryByValue, getJSPURI, getSelectedEntry, getSelectedValue, isButtonPushed, isCommandAction, isEmpty, isEnabled, isSelected, isSelected, resetEntries, setCommandAction, setComparator, setSelectedEntry, setSelectedEntryByDisplayValue, setSelectedValue, setUseComparator, useComparator

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

addActionListener, getAccessKey, getAlignment, getConfirmationMessage, getEvent, getJavaScript, getLabel, 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, 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, getParent, getUniqueName, goFullScreen, isValid, leaveFullScreen, registerUniqueName, removeEventListener, render, translateFormFieldToEventName, translateFormFieldToEventValue

Field Detail

OPEN_TYPE_EXT

public static final String OPEN_TYPE_EXT

See Also:

Constant Field Values

OPEN_TYPE_INT

public static final String OPEN_TYPE_INT

See Also:

Constant Field Values

Constructor Detail

TypeSelectToolbarActionChip

public TypeSelectToolbarActionChip(DisplayState displayState,
                                   AbstractToolbarChip parent,
                                   String label,
                                   String event,
                                   String javascript,
                                   ComposedType type)

Creates a new TypeSelectToolbarActionChip which will be filled with the given type

Parameters:

displayState -

parent -

label -

event -

javascript -

type -

Method Detail

getAcceptedEvents

public Set getAcceptedEvents()

Specified by:

getAcceptedEvents in interface EventCheckingChip

Overrides:

getAcceptedEvents in class AbstractToolbarActionChip

createEntries

protected List createEntries()

Takes the typeEntries and creates the appropriate select entries for this selector.

Specified by:

createEntries in class AbstractSelectToolbarActionChip

Returns:

List of Entry objects

getSelectedType

public ComposedType getSelectedType()

Returns:

the currently selected type

setSelectedType

public void setSelectedType(ComposedType type)

Sets the currently selected type.

Parameters:

type -

getEntries

public List getEntries()

Overrides AbstractSelectToolbarActionChip.getEntries() to filter incompatible type entries.

Overrides:

getEntries in class AbstractSelectToolbarActionChip

Returns:

a List containing Entry objects

filterTypes

public void filterTypes(String presetAttributeQualifier,
                        ComposedType presetAttributeType)

Removes all type entries in this selector where the given attribute qualifier either does not exist or is an incompatible type (when compared with the given type).
Example: There is a preset attribute of type Unit for the attribute 'unit'. In this type selector there is a subtype which redeclared the 'unit' attribute and changed its type to a subtype of Unit, SubUnit. Obviously the preset Unit would not be compatible with any Item of this subtype so it will be removed from this selector.

Since:

2.10

getFilteredEntries

public Set getFilteredEntries()

Since:

2.10

processEvents

public void processEvents(Map events)

Description copied from class: AbstractSelectToolbarActionChip

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

Specified by:

processEvents in interface Chip

Overrides:

processEvents in class AbstractSelectToolbarActionChip

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:

3.00 (beta1)

getProposedUniqueName

protected String getProposedUniqueName()

Overrides:

getProposedUniqueName in class AbstractToolbarActionChip

composedTypeChanged

public void composedTypeChanged(ComposedTypeChangeEvent event)

Notifies this chip of a search type change. Usually this chip, as it is the type selector, is the source for the type change. But in some occasions the search type is set from 'outside', e.g. if a reference editor opens an item search and uses some preset searchtype.

Specified by:

composedTypeChanged in interface ComposedTypeChangeListener

Since:

3.0 M2

See Also:

ComposedTypeChangeListener.composedTypeChanged(de.hybris.platform.hmc.generic.ComposedTypeChangeEvent)