de.hybris.platform.hmc.generic.organizer

Class OrganizerListChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.webchips.ListChip

de.hybris.platform.hmc.ItemListChip

de.hybris.platform.hmc.generic.GenericItemListChip

de.hybris.platform.hmc.generic.GenericItemSearchListChip

de.hybris.platform.hmc.generic.organizer.OrganizerListChip

All Implemented Interfaces:

AttributeValueChangeListener, ItemAcceptor, NamedChip, ToolbarProvider, TypedChip, Chip, ChipEventListener, Serializable, Cloneable, EventListener

Direct Known Subclasses:

ClassificationOrganizerListChip

public class OrganizerListChip
extends GenericItemSearchListChip
implements NamedChip, ChipEventListener

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CANCEL
static String	CLEAR_ALL
static String	COPY
static String	COPY_TO_CREATOR
static String	DELETE Deprecated. since 2.30 GenericItemListChip.REMOVE is used
static String	EDIT_MODE
static String	MODE
static String	NAME
static String	OPEN_EXPLORER
static String	ORDER_ASC
static String	ORDER_DESC
static String	SAVE
static String	SAVE_ALL
static String	SAVE_NEEDED
static String	SELECT_EXACTLYONE

Fields inherited from class de.hybris.platform.hmc.generic.GenericItemSearchListChip

FIRST_PAGE, ITEMS_PER_PAGE, LAST_PAGE, maxDisplayEntryHeight, NEXT_PAGE, PREVIOUS_PAGE, RANGESTART, REFRESH, SEARCHRESULTACTION, SORT, TOGGLE

Fields inherited from class de.hybris.platform.hmc.generic.GenericItemListChip

ADD, COPY_EVENT, CREATE, DELETE_ICON, DELETE_NEW_ENTRY, LOG, OPEN_EDITOR, OPEN_EDITOR_EXTERNAL, OPEN_EDITOR_INTERNAL, REMOVE, SELECT_ALL, SELECT_VISIBLE

Fields inherited from class de.hybris.platform.hmc.webchips.ListChip

CLEAR, SELECT

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
OrganizerListChip(DisplayState displayState, Chip parent, AbstractSearchContainer container)
OrganizerListChip(DisplayState displayState, Chip parent, ComposedType type)

Method Summary

Modifier and Type	Method and Description
boolean	canCreate()
boolean	canRemove()
protected void	changeItemsPerPage(String value)
protected boolean	checkSaveNeeded()
protected void	copyToClipboard()
protected void	copyToCreator()
protected GenericItemListEntryChip	createListEntryChip(Item item) Depending on whether the entries of this list should be editable a GenericItemListEntryChip or an EditableItemListEntryChip will be created.
AbstractToolbarChip	createToolbar()
protected void	delete()
ListOperationChip	getActiveOperationChip()
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
int	getMaxEntryHeight() Returns the maximum height (in pixels) of a list entry.
List	getMenuEntries() Here you can specify what Actions you are able to perform at the moment.
int	getMode()
String	getName()
protected List	getNumberColumns()
ListOperationChip[]	getOperationChips()
protected OrganizerChip	getOrganizerChip()
List	getSearchableColumns()
List	getSelectedListEntries()
boolean	isChanged() Returns true if at least one of the (editable) entries has been changed.
boolean	isEditable()
boolean	isEditing()
boolean	isExplorable()
boolean	isScrollHeader()
void	notify(ChipEvent event) This method will receive the dropdown menu events (list/edit/tree mode selection).
protected void	openEditor()
protected void	openEditor(boolean external)
void	processEvents(Map<String,List<String>> events) Handles all incoming requests for this chip.
void	save()
protected void	setActiveOperationChip(ListOperationChip chip)
boolean	showScrollbar()
boolean	update()
boolean	update(boolean preserveTreeState)

Methods inherited from class de.hybris.platform.hmc.generic.GenericItemSearchListChip

getAdditionalColumnProvider, getComparator, getConditionsAsString, getHeightDiff, getItemCount, getItemsPerPageAsInt, getItemsPerPageDefault, getItemsPerPageList, getMaxItemsPerPage, getMaxItemsPerPageDefault, getMaxListHeight, getMinListHeight, getProposedUniqueName, getRangeStart, getRestrictor, getSearchContainer, getSearchCount, getSearchResultActionChipByName, getSearchResultActionChips, getSortAttributeQualifier, getSortDirection, getSortOrderIdentifier, getTypeName, hasComparator, isExpanded, isNewSearch, isSortable, setAdditionalColumnProvider, setComparator, setExpanded, setMaxItemsPerPage, setRangeStart, setRestrictor, setSearchContainer, setSortAttributeQualifier, setSortDirection, switchSortDirection

Methods inherited from class de.hybris.platform.hmc.generic.GenericItemListChip

addCreationPreset, addSearchPreset, allowsMultipleSelection, canAdd, canPaste, clearListEntries, clearSelectedListEntries, createNewItemEntry, createNewItemEntry, entriesEditable, getAssignableItemsFromClipboard, getCreationPresetQualifiers, getCreationPresets, getEditorNode, getElementTypes, getEntry, getEntryForItem, getIndexOf, getItemNotValidErrorMessage, getMaxCount, getNewItemEntry, getPresetAttributeName, getPresetSearchType, getRestrictedListEntries, getSearchEditor, getSearchPresets, getVisibleQualifiers, getWidth, isAllSelected, isAutoPerform, isAutoPerform, isAutoSave, isConsiderSubtypes, isExternalCreate, isExternalCreate, isMarkedAsMandatory, isPartOfAttribute, isProhibitOpening, isSelectVisible, mandatoryNotAccessible, mandatoryNotAccessible, notifyAttributeValueChange, refreshEntries, saveNewItemEntry, setAutoPerform, setAutoSave, setCanAdd, setCanRemove, setConsiderSubtypes, setCreate, setElementType, setElementTypes, setEntriesEditable, setExternalCreate, setMaxCount, setNewItemEntry, setPresetAttributeName, setPresetSearchType, setProhibitOpening, setSearchEditor, setSelectedItems, setSelectVisible, setWidth, showSearchEditor, subTypesVisible

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

checkValid, getAttributeNodes, getAttributeWidths, getChildNodes, getHeaderCount, getHeaderQualifiers, getItemLayoutNode, getItemType, getTitle, getToolbar, hasFancyRows, setItemLayoutNode, setItemType

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

addListEntry, addSelectedListEntries, addSelectedListEntry, getListEntries, getListEntryCount, getPosition, getSelectedListEntryCount, isListEntrySelected, isMultipleSelectionAllowed, moveDown, moveUp, removeListEntry, setFancyRows, setMultipleSelection, setMultipleSelectionAllowed, sort, sort

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

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

CANCEL

public static final String CANCEL

See Also:

Constant Field Values

CLEAR_ALL

public static final String CLEAR_ALL

See Also:

Constant Field Values

COPY

public static final String COPY

See Also:

Constant Field Values

COPY_TO_CREATOR

public static final String COPY_TO_CREATOR

See Also:

Constant Field Values

EDIT_MODE

public static final String EDIT_MODE

See Also:

Constant Field Values

MODE

public static final String MODE

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

OPEN_EXPLORER

public static final String OPEN_EXPLORER

See Also:

Constant Field Values

ORDER_ASC

public static final String ORDER_ASC

See Also:

Constant Field Values

ORDER_DESC

public static final String ORDER_DESC

See Also:

Constant Field Values

SAVE

public static final String SAVE

See Also:

Constant Field Values

SAVE_ALL

public static final String SAVE_ALL

See Also:

Constant Field Values

SAVE_NEEDED

public static final String SAVE_NEEDED

See Also:

Constant Field Values

SELECT_EXACTLYONE

public static final String SELECT_EXACTLYONE

See Also:

Constant Field Values

DELETE

@Deprecated
public static final String DELETE

Deprecated. since 2.30 GenericItemListChip.REMOVE is used

See Also:

Constant Field Values

Constructor Detail

OrganizerListChip

public OrganizerListChip(DisplayState displayState,
                         Chip parent,
                         AbstractSearchContainer container)

OrganizerListChip

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

Method Detail

createListEntryChip

protected GenericItemListEntryChip createListEntryChip(Item item)

Description copied from class: GenericItemListChip

Depending on whether the entries of this list should be editable a GenericItemListEntryChip or an EditableItemListEntryChip will be created.

Overrides:

createListEntryChip in class GenericItemListChip

Parameters:

item - the Item for which to create the list entry

Returns:

a new GenericItemListEntryChip or EditableItemListEntryChip

checkSaveNeeded

protected boolean checkSaveNeeded()

delete

protected void delete()

changeItemsPerPage

protected void changeItemsPerPage(String value)

copyToCreator

protected void copyToCreator()

processEvents

public void processEvents(Map<String,List<String>> 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

Overrides:

processEvents in class GenericItemSearchListChip

getMode

public int getMode()

Overrides:

getMode in class GenericItemListChip

openEditor

protected void openEditor()

Overrides:

openEditor in class GenericItemListChip

Since:

2.30

openEditor

protected void openEditor(boolean external)

Overrides:

openEditor in class GenericItemListChip

Parameters:

external - if true the editor will be opened in a new window

Since:

2.30

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 GenericItemSearchListChip

canCreate

public boolean canCreate()

Overrides:

canCreate in class GenericItemSearchListChip

canRemove

public boolean canRemove()

Overrides:

canRemove in class GenericItemSearchListChip

save

public void save()

Overrides:

save in class GenericItemListChip

showScrollbar

public boolean showScrollbar()

isEditing

public boolean isEditing()

getSelectedListEntries

public List getSelectedListEntries()

Overrides:

getSelectedListEntries in class GenericItemSearchListChip

isExplorable

public boolean isExplorable()

getOperationChips

public ListOperationChip[] getOperationChips()

getActiveOperationChip

public ListOperationChip getActiveOperationChip()

getSearchableColumns

public List getSearchableColumns()

getNumberColumns

protected List getNumberColumns()

setActiveOperationChip

protected void setActiveOperationChip(ListOperationChip chip)

isEditable

public boolean isEditable()

Overrides:

isEditable in class GenericItemListChip

getName

public String getName()

Specified by:

getName in interface NamedChip

isChanged

public boolean isChanged()

Description copied from class: GenericItemListChip

Returns true if at least one of the (editable) entries has been changed. If this list does not contain editable entries then always 'false' is returned. Note: This method does not care if whole entries have been added or removed (this would be the responsibility of the surrounding reference list editor).

Overrides:

isChanged in class GenericItemListChip

Returns:

true if at least one of the (editable) entries has been changed.

update

public boolean update()

Overrides:

update in class GenericItemSearchListChip

update

public boolean update(boolean preserveTreeState)

copyToClipboard

protected void copyToClipboard()

getOrganizerChip

protected OrganizerChip getOrganizerChip()

createToolbar

public AbstractToolbarChip createToolbar()

Specified by:

createToolbar in interface ToolbarProvider

Overrides:

createToolbar in class GenericItemSearchListChip

getMaxEntryHeight

public int getMaxEntryHeight()

Returns the maximum height (in pixels) of a list entry.

Overrides:

getMaxEntryHeight in class GenericItemSearchListChip

Returns:

the maximum height (in pixels) of a list entry.

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 GenericItemSearchListChip

Returns:

List of Actions;

Since:

2.30

See Also:

AbstractChip.getMenuEntries()

notify

public void notify(ChipEvent event)

This method will receive the dropdown menu events (list/edit/tree mode selection).

Specified by:

notify in interface ChipEventListener

Since:

2.30

isScrollHeader

public boolean isScrollHeader()

Since:

3.1-u5