de.hybris.platform.hmc.webchips

Class ListChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.webchips.ListChip

All Implemented Interfaces:

Chip, Serializable, Cloneable

Direct Known Subclasses:

AbstractGenericConditionalSearchChip, GenericListChip, ItemListChip, SearchListChip

public abstract class ListChip
extends AbstractChip

This is the base class for all ListChips. It contains handling of selection.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLEAR
static String	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
ListChip(DisplayState displayState, Chip parent)

Method Summary

Modifier and Type	Method and Description
void	addListEntry(Chip entry)
void	addSelectedListEntries(List chips)
void	addSelectedListEntry(Chip chip)
void	checkValid() Gives the chip the possibility to check if its objects are still valid.
void	clearListEntries()
void	clearSelectedListEntries()
abstract String	getItemNotValidErrorMessage() Returns a localized error message in case one or more list entrys are not valid.
List	getListEntries()
int	getListEntryCount()
int	getPosition(Chip child)
List	getSelectedListEntries()
int	getSelectedListEntryCount()
boolean	hasFancyRows() Returns whether or not a more fancy style should be used to display the rows.
boolean	isListEntrySelected(Chip aChip)
boolean	isMultipleSelectionAllowed() This is to differentiate between multiple chip selection or single chip selection.
protected void	moveDown(Chip entry) Moves the entry one position down in the list (increases index of entry).
protected void	moveUp(Chip entry) Moves the entry one position up in the list (reduces index of entry).
void	processEvents(Map<String,List<String>> events) Handles all incoming requests for this chip.
void	removeListEntry(Chip entry)
protected void	setFancyRows(boolean fancy)
void	setMultipleSelection(boolean multiple) Deprecated. use setMultipleSelectionAllowed(boolean) instead
void	setMultipleSelectionAllowed(boolean value) Set multiple chip selection or not.
protected void	sort(boolean ascending) Sorts the entries of this list.
protected void	sort(Comparator comparator) Sorts the entries of this list.

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

SELECT

public static final String SELECT

See Also:

Constant Field Values

CLEAR

public static final String CLEAR

See Also:

Constant Field Values

Constructor Detail

ListChip

public ListChip(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)

clearListEntries

public void clearListEntries()

getListEntries

public List getListEntries()

addListEntry

public void addListEntry(Chip entry)

removeListEntry

public void removeListEntry(Chip entry)

getListEntryCount

public int getListEntryCount()

getSelectedListEntries

public List getSelectedListEntries()

isListEntrySelected

public boolean isListEntrySelected(Chip aChip)

addSelectedListEntry

public void addSelectedListEntry(Chip chip)

addSelectedListEntries

public void addSelectedListEntries(List chips)

clearSelectedListEntries

public void clearSelectedListEntries()

getSelectedListEntryCount

public int getSelectedListEntryCount()

checkValid

public void checkValid()

Description copied from class: AbstractChip

Gives the chip the possibility to check if its objects are still valid. If you override this method, call super.checkValid()

Specified by:

checkValid in interface Chip

Overrides:

checkValid in class AbstractChip

getItemNotValidErrorMessage

public abstract String getItemNotValidErrorMessage()

Returns a localized error message in case one or more list entrys are not valid. Might return null which would lead to no message displayed.

sort

protected void sort(boolean ascending)

Sorts the entries of this list.

Parameters:

ascending - TRUE sort in ascending order, FALSE sort in descending order

sort

protected void sort(Comparator comparator)

Sorts the entries of this list.

Parameters:

comparator - The comparator defining the sorting order.

moveUp

protected void moveUp(Chip entry)

Moves the entry one position up in the list (reduces index of entry).

moveDown

protected void moveDown(Chip entry)

Moves the entry one position down in the list (increases index of entry).

getPosition

public int getPosition(Chip child)

hasFancyRows

public boolean hasFancyRows()

Returns whether or not a more fancy style should be used to display the rows. Subclasses can determine the way this is interpreted. For example lines can have alternating color.

setFancyRows

protected void setFancyRows(boolean fancy)

isMultipleSelectionAllowed

public boolean isMultipleSelectionAllowed()

This is to differentiate between multiple chip selection or single chip selection.

setMultipleSelection

@Deprecated
public void setMultipleSelection(boolean multiple)

Deprecated. use setMultipleSelectionAllowed(boolean) instead

Set multiple chip selection or not.

setMultipleSelectionAllowed

public void setMultipleSelectionAllowed(boolean value)

Set multiple chip selection or not.