de.hybris.platform.hmc.generic

Class GenericItemSearchListChip

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ModalGenericItemSearchListChip, OrganizerListChip, SearchResultListChip

public class GenericItemSearchListChip
extends GenericItemListChip

A pager view of a search result.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIRST_PAGE
static String	ITEMS_PER_PAGE
static String	LAST_PAGE
protected int	maxDisplayEntryHeight
static String	NEXT_PAGE
static String	PREVIOUS_PAGE
static String	RANGESTART
static String	REFRESH
static String	SEARCHRESULTACTION
static String	SORT
static String	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
GenericItemSearchListChip(DisplayState displayState, Chip parent, AbstractSearchContainer container)
GenericItemSearchListChip(DisplayState displayState, Chip parent, ComposedType type)

Method Summary

Modifier and Type	Method and Description
boolean	canCreate()
boolean	canRemove()
AbstractToolbarChip	createToolbar()
AdditionalColumnProvider	getAdditionalColumnProvider() Gets the additional column provider or null.
protected Comparator	getComparator()
String	getConditionsAsString()
int	getHeightDiff()
int	getItemCount()
protected int	getItemsPerPageAsInt(String itemsPerPage)
protected static String	getItemsPerPageDefault()
protected static List	getItemsPerPageList()
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.
int	getMaxItemsPerPage()
int	getMaxItemsPerPageDefault()
int	getMaxListHeight() Returns the maximum result list size (in pixels) based on the presumed height of all list elements.
List	getMenuEntries() Here you can specify what Actions you are able to perform at the moment.
int	getMinListHeight() Returns the minimum result list size (in pixels) based on the config property hmc.resultlist.minheight and/or the presumed height of three list elements (whichever is higher).
protected String	getProposedUniqueName()
int	getRangeStart()
protected Restrictor	getRestrictor()
AbstractSearchContainer	getSearchContainer()
int	getSearchCount()
protected SearchResultActionChip	getSearchResultActionChipByName(String name)
protected List	getSearchResultActionChips()
List	getSelectedListEntries()
String	getSortAttributeQualifier()
protected String	getSortDirection()
String	getSortOrderIdentifier()
String	getTypeName()
boolean	hasComparator()
boolean	isExpanded()
boolean	isNewSearch()
boolean	isSortable(String qualifier) Will return true if the AttributeDescriptor with the given qualifier is searchable and no comparator is used.
void	processEvents(Map<String,List<String>> events) Handles all incoming requests for this chip.
void	setAdditionalColumnProvider(AdditionalColumnProvider provider) Sets an column provider whose column will be added before each list entry.
void	setComparator(Comparator comparator)
protected void	setExpanded(boolean expanded)
void	setMaxItemsPerPage(int value)
void	setRangeStart(int value)
void	setRestrictor(Restrictor restrictor)
void	setSearchContainer(AbstractSearchContainer searchContainer) Set the SearchContainer for the SearchListChip.
protected void	setSortAttributeQualifier(String qualifier) Sets the qualifier of the AttributeDescriptor which should be used for sorting the found items.
protected void	setSortDirection(String direction)
protected void	switchSortDirection() Switches between GenericSearchConstants.ORDER_BY.DIREC.ASC and GenericSearchConstants.ORDER_BY.DIREC.DESC.
boolean	update()

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

addCreationPreset, addSearchPreset, allowsMultipleSelection, canAdd, canPaste, clearListEntries, clearSelectedListEntries, createListEntryChip, createNewItemEntry, createNewItemEntry, entriesEditable, getAssignableItemsFromClipboard, getCreationPresetQualifiers, getCreationPresets, getEditorNode, getElementTypes, getEntry, getEntryForItem, getIndexOf, getItemNotValidErrorMessage, getMaxCount, getMode, getNewItemEntry, getPresetAttributeName, getPresetSearchType, getRestrictedListEntries, getSearchEditor, getSearchPresets, getVisibleQualifiers, getWidth, isAllSelected, isAutoPerform, isAutoPerform, isAutoSave, isChanged, isConsiderSubtypes, isEditable, isExternalCreate, isExternalCreate, isMarkedAsMandatory, isPartOfAttribute, isProhibitOpening, isSelectVisible, mandatoryNotAccessible, mandatoryNotAccessible, notifyAttributeValueChange, openEditor, openEditor, refreshEntries, save, 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, dispose, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getID, getJaloSession, getParent, getUniqueName, goFullScreen, isValid, leaveFullScreen, registerUniqueName, removeEventListener, render, translateFormFieldToEventName, translateFormFieldToEventValue

Field Detail

RANGESTART

public static final String RANGESTART

See Also:

Constant Field Values

SORT

public static final String SORT

See Also:

Constant Field Values

ITEMS_PER_PAGE

public static final String ITEMS_PER_PAGE

See Also:

Constant Field Values

REFRESH

public static final String REFRESH

See Also:

Constant Field Values

FIRST_PAGE

public static final String FIRST_PAGE

See Also:

Constant Field Values

PREVIOUS_PAGE

public static final String PREVIOUS_PAGE

See Also:

Constant Field Values

NEXT_PAGE

public static final String NEXT_PAGE

See Also:

Constant Field Values

LAST_PAGE

public static final String LAST_PAGE

See Also:

Constant Field Values

TOGGLE

public static final String TOGGLE

Since:

3.0M3

See Also:

Constant Field Values

SEARCHRESULTACTION

public static final String SEARCHRESULTACTION

See Also:

Constant Field Values

maxDisplayEntryHeight

protected int maxDisplayEntryHeight

Constructor Detail

GenericItemSearchListChip

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

GenericItemSearchListChip

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

Method Detail

getSearchResultActionChips

protected List getSearchResultActionChips()

Since:

2.10

getSearchResultActionChipByName

protected SearchResultActionChip getSearchResultActionChipByName(String name)

Since:

3.00 (beta1)

getSortOrderIdentifier

public String getSortOrderIdentifier()

update

public boolean update()

getMaxItemsPerPage

public int getMaxItemsPerPage()

getRangeStart

public int getRangeStart()

setMaxItemsPerPage

public void setMaxItemsPerPage(int value)

setRangeStart

public void setRangeStart(int value)

getMaxItemsPerPageDefault

public int getMaxItemsPerPageDefault()

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 GenericItemListChip

getItemCount

public int getItemCount()

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 GenericItemListChip

isNewSearch

public boolean isNewSearch()

canRemove

public boolean canRemove()

Overrides:

canRemove in class GenericItemListChip

canCreate

public boolean canCreate()

Overrides:

canCreate in class GenericItemListChip

getSelectedListEntries

public List getSelectedListEntries()

Overrides:

getSelectedListEntries in class ListChip

switchSortDirection

protected void switchSortDirection()

Switches between GenericSearchConstants.ORDER_BY.DIREC.ASC and GenericSearchConstants.ORDER_BY.DIREC.DESC.

getSortDirection

protected String getSortDirection()

Returns:

One of GenericSearchConstants.ORDER_BY.DIREC.ASC or GenericSearchConstants.ORDER_BY.DIREC.DESC.

setSortDirection

protected void setSortDirection(String direction)

Parameters:

direction - The sort direction.

setSortAttributeQualifier

protected void setSortAttributeQualifier(String qualifier)

Sets the qualifier of the AttributeDescriptor which should be used for sorting the found items.

Parameters:

qualifier - It has to be part of ItemListChip.getHeaderQualifiers().

getSortAttributeQualifier

public String getSortAttributeQualifier()

Returns:

The qualifier of the AttributeDescriptor which should be used for sorting the found items. It has to be part of ItemListChip.getHeaderQualifiers().

getTypeName

public String getTypeName()

getConditionsAsString

public String getConditionsAsString()

setComparator

public void setComparator(Comparator comparator)

getComparator

protected Comparator getComparator()

setRestrictor

public void setRestrictor(Restrictor restrictor)

getRestrictor

protected Restrictor getRestrictor()

hasComparator

public boolean hasComparator()

isSortable

public boolean isSortable(String qualifier)

Will return true if the AttributeDescriptor with the given qualifier is searchable and no comparator is used.

createToolbar

public AbstractToolbarChip createToolbar()

Specified by:

createToolbar in interface ToolbarProvider

Overrides:

createToolbar in class GenericItemListChip

getSearchContainer

public AbstractSearchContainer getSearchContainer()

Returns:

Returns the SearchContainer.

setSearchContainer

public void setSearchContainer(AbstractSearchContainer searchContainer)

Set the SearchContainer for the SearchListChip.

Parameters:

searchContainer -

getMaxEntryHeight

public int getMaxEntryHeight()

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

Returns:

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

getMinListHeight

public int getMinListHeight()

Returns the minimum result list size (in pixels) based on the config property hmc.resultlist.minheight and/or the presumed height of three list elements (whichever is higher).

Returns:

the minimum result list size

getMaxListHeight

public int getMaxListHeight()

Returns the maximum result list size (in pixels) based on the presumed height of all list elements.

Returns:

the maximum result list size

getItemsPerPageList

protected static List getItemsPerPageList()

getItemsPerPageDefault

protected static String getItemsPerPageDefault()

getItemsPerPageAsInt

protected int getItemsPerPageAsInt(String itemsPerPage)

getSearchCount

public int getSearchCount()

Returns:

Returns the searchCounter.

Since:

2.10

getHeightDiff

public int getHeightDiff()

Since:

2.20

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 GenericItemListChip

Returns:

List of Actions;

Since:

2.30

See Also:

AbstractChip.getMenuEntries()

getProposedUniqueName

protected String getProposedUniqueName()

Overrides:

getProposedUniqueName in class AbstractChip

isExpanded

public boolean isExpanded()

Returns:

Whether the editor is in the expanded view mode (TRUE) displaying the whole table or in collapsed mode (FALSE) displaying only the header.

Since:

3.0M3

setExpanded

protected void setExpanded(boolean expanded)

Parameters:

expanded - If the editor is in the expanded view mode (TRUE) displaying the whole table or in collapsed mode (FALSE) displaying only the header.

Since:

3.0M3

setAdditionalColumnProvider

public void setAdditionalColumnProvider(AdditionalColumnProvider provider)

Sets an column provider whose column will be added before each list entry.

Parameters:

provider - provider of the additional column

getAdditionalColumnProvider

public AdditionalColumnProvider getAdditionalColumnProvider()

Gets the additional column provider or null.

Returns:

configured column provider or null if no additional column is available