de.hybris.platform.hmc

Class SearchListChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.webchips.ListChip

de.hybris.platform.hmc.SearchListChip

All Implemented Interfaces:

Chip, Serializable, Cloneable

public abstract class SearchListChip
extends ListChip

This is the base class for all *SearchListChips. It contains handling of selection, range and searching.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADD Command string for adding a new item.
static String	DELETE Command string for deleting the selected items.
static int	MAXITEMSPERPAGE The size of the viewable range of all found items.
static String	RANGESTART The initial index of the first element in the viewable range of all found items.
static String	SEARCH Command string for starting a new search.

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
SearchListChip(DisplayState displayState, Chip parent)

Method Summary

Modifier and Type	Method and Description
protected abstract void	addItem() Adds exactly one item and opens the editor.
abstract boolean	canCreate()
abstract boolean	canRemove()
void	clearSearch() Remove all listentries, set rangestart and itemcount to null and newsearch to true.
protected abstract void	deleteSelected() Removes the selected items (ListChip.getSelectedListEntries()) from database.
int	getItemCount()
int	getMaxItemsPerPage()
int	getRangeStart()
String	getTitle()
boolean	isNewSearch() This is to differentiate between a new search and a search without results.
void	processEvents(Map<String,List<String>> events) Handles all incoming requests for this chip.
protected abstract int	search() Adds the ListEntries that represent the Items found during the search.
void	searchWithRangeStart(int start) Sets the index of the first element in the viewable range of all found items, clear the list of listentries of the former search, call search() and set itemcount accordingly.

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

addListEntry, addSelectedListEntries, addSelectedListEntry, checkValid, clearListEntries, clearSelectedListEntries, getItemNotValidErrorMessage, getListEntries, getListEntryCount, getPosition, getSelectedListEntries, getSelectedListEntryCount, hasFancyRows, 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, getMenuEntries, getNameSpace, getNameSpaceFor, getParent, getProposedUniqueName, 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

getJSPURI

Field Detail

MAXITEMSPERPAGE

public static final int MAXITEMSPERPAGE

The size of the viewable range of all found items.

See Also:

Constant Field Values

RANGESTART

public static final String RANGESTART

The initial index of the first element in the viewable range of all found items.

See Also:

Constant Field Values

ADD

public static final String ADD

Command string for adding a new item.

See Also:

Constant Field Values

DELETE

public static final String DELETE

Command string for deleting the selected items.

See Also:

Constant Field Values

SEARCH

public static final String SEARCH

Command string for starting a new search.

See Also:

Constant Field Values

Constructor Detail

SearchListChip

public SearchListChip(DisplayState displayState,
                      Chip parent)

Method Detail

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 ListChip

searchWithRangeStart

public final void searchWithRangeStart(int start)

Sets the index of the first element in the viewable range of all found items, clear the list of listentries of the former search, call search() and set itemcount accordingly.

clearSearch

public final void clearSearch()

Remove all listentries, set rangestart and itemcount to null and newsearch to true. This method is used f.i. for switching between simple and complex search.

search

protected abstract int search()

Adds the ListEntries that represent the Items found during the search.

Returns:

The total count of found items.

deleteSelected

protected abstract void deleteSelected()

Removes the selected items (ListChip.getSelectedListEntries()) from database.

addItem

protected abstract void addItem()

Adds exactly one item and opens the editor.

getMaxItemsPerPage

public int getMaxItemsPerPage()

Returns:

The size of the viewable range of all found items.

getRangeStart

public final int getRangeStart()

Returns:

The index of the first element in the viewable range of all found items.

getItemCount

public int getItemCount()

Returns:

The total count of found items.

isNewSearch

public boolean isNewSearch()

This is to differentiate between a new search and a search without results.

canCreate

public abstract boolean canCreate()

Returns:

If the layout should provide an add event to support addition to the found list of objects.

canRemove

public abstract boolean canRemove()

Returns:

If the layout should provide an add event to support addition to the found list of objects.

getTitle

public String getTitle()

Returns:

Dummy localized title, override this method in subclasses for more specific titles.