de.hybris.platform.hmc.generic

Class GenericListChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.webchips.ListChip

de.hybris.platform.hmc.generic.GenericListChip

All Implemented Interfaces:

ToolbarProvider, Chip, Serializable, Cloneable

Direct Known Subclasses:

GenericAtomicTypeListChip, GenericMapTypeListChip

public abstract class GenericListChip
extends ListChip
implements ToolbarProvider

Generic ListChip which has a list of non-item (mostly primitive) values.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADD
static String	REMOVE
static String	SELECT_ALL
static String	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
GenericListChip(DisplayState displayState, AbstractAttributeEditorChip parent) The List is per default editable.

Method Summary

Modifier and Type	Method and Description
protected abstract void	addEmptyEntry()
protected abstract void	addItem()
boolean	allowsMultipleSelection() Method which has to be implemented for ItemAcceptor interface.
boolean	canAdd()
boolean	canRemove()
AbstractToolbarChip	createToolbar()
protected void	deleteSelected()
String	getItemNotValidErrorMessage() Returns a localized error message in case one or more list entrys are not valid.
List	getMenuEntries() Here you can specify what Actions you are able to perform at the moment.
String	getTitle()
AbstractToolbarChip	getToolbar()
int	getWidth()
boolean	hasFancyRows() Returns whether or not a more fancy style should be used to display the rows.
boolean	isAllSelected()
abstract boolean	isEditable()
void	processEvents(Map<String,List<String>> events) Handles all incoming requests for this chip.
boolean	restrictHeight()
void	setAdd(boolean value)
void	setAddAndRemove(boolean value)
void	setRemove(boolean value)
void	setRestrictHeight(boolean restrict)
void	setTitle(String title)
void	setToolbar(AbstractToolbarChip toolbar)
void	setWidth(int width)

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

addListEntry, addSelectedListEntries, addSelectedListEntry, checkValid, clearListEntries, clearSelectedListEntries, getListEntries, getListEntryCount, getPosition, getSelectedListEntries, 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, 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

addEventListener, checkValid, dispose, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getID, getJaloSession, getJSPURI, getParent, getUniqueName, goFullScreen, isValid, leaveFullScreen, registerUniqueName, removeEventListener, render, translateFormFieldToEventName, translateFormFieldToEventValue

Field Detail

REMOVE

public static final String REMOVE

See Also:

Constant Field Values

ADD

public static final String ADD

See Also:

Constant Field Values

SELECT_ALL

public static final String SELECT_ALL

See Also:

Constant Field Values

SELECT_VISIBLE

public static final String SELECT_VISIBLE

See Also:

Constant Field Values

Constructor Detail

GenericListChip

public GenericListChip(DisplayState displayState,
                       AbstractAttributeEditorChip parent)

The List is per default editable.

Method Detail

setToolbar

public void setToolbar(AbstractToolbarChip toolbar)

getToolbar

public AbstractToolbarChip getToolbar()

Specified by:

getToolbar in interface ToolbarProvider

canAdd

public boolean canAdd()

canRemove

public boolean canRemove()

setAdd

public void setAdd(boolean value)

setRemove

public void setRemove(boolean value)

setAddAndRemove

public void setAddAndRemove(boolean value)

createToolbar

public AbstractToolbarChip createToolbar()

Specified by:

createToolbar in interface ToolbarProvider

hasFancyRows

public boolean hasFancyRows()

Description copied from class: ListChip

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.

Overrides:

hasFancyRows in class ListChip

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

addItem

protected abstract void addItem()

addEmptyEntry

protected abstract void addEmptyEntry()

deleteSelected

protected void deleteSelected()

isAllSelected

public boolean isAllSelected()

allowsMultipleSelection

public boolean allowsMultipleSelection()

Method which has to be implemented for ItemAcceptor interface.

isEditable

public abstract boolean isEditable()

getItemNotValidErrorMessage

public String getItemNotValidErrorMessage()

Description copied from class: ListChip

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.

Specified by:

getItemNotValidErrorMessage in class ListChip

restrictHeight

public boolean restrictHeight()

setRestrictHeight

public void setRestrictHeight(boolean restrict)

getWidth

public int getWidth()

setWidth

public void setWidth(int width)

getTitle

public String getTitle()

Since:

2.10

setTitle

public void setTitle(String title)

Since:

2.10

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:

2.30

See Also:

AbstractChip.getMenuEntries()