de.hybris.platform.hmc

Class ItemListChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.webchips.ListChip

de.hybris.platform.hmc.ItemListChip

All Implemented Interfaces:

ToolbarProvider, TypedChip, Chip, Serializable, Cloneable

Direct Known Subclasses:

GenericItemListChip

public abstract class ItemListChip
extends ListChip
implements TypedChip, ToolbarProvider

Abstract class implementing access to the type of the items to be displayed.

See Also:

Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method and Description
void	checkValid() Gives the chip the possibility to check if its objects are still valid.
List<AttributeNode>	getAttributeNodes()
Map	getAttributeWidths()
List	getChildNodes()
int	getHeaderCount()
List	getHeaderQualifiers()
ItemLayoutNode	getItemLayoutNode() Returns the node that is used for determining the columns/attributes that are displayed.
ComposedType	getItemType() Returns the (super)type of the items this result list is showing.
protected int	getMode()
String	getTitle(String qualifier)
AbstractToolbarChip	getToolbar()
boolean	hasFancyRows() Returns whether or not a more fancy style should be used to display the rows.
void	setItemLayoutNode(ItemLayoutNode layoutNode) Sets the ItemLayoutDescriptor which this list should use to display its entries.
protected void	setItemType(ComposedType itemType) Sets the (super)type of the items this result list is showing.

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

addListEntry, addSelectedListEntries, addSelectedListEntry, clearListEntries, clearSelectedListEntries, getItemNotValidErrorMessage, getListEntries, getListEntryCount, getPosition, getSelectedListEntries, getSelectedListEntryCount, isListEntrySelected, isMultipleSelectionAllowed, moveDown, moveUp, processEvents, 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.ToolbarProvider

createToolbar

Methods inherited from interface de.hybris.platform.hmc.webchips.Chip

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

Constructor Detail

ItemListChip

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

Method Detail

getToolbar

public AbstractToolbarChip getToolbar()

Specified by:

getToolbar in interface ToolbarProvider

setItemType

protected void setItemType(ComposedType itemType)

Sets the (super)type of the items this result list is showing.

Parameters:

itemType - the (super)type of the items this result list is showing.

getItemType

public ComposedType getItemType()

Returns the (super)type of the items this result list is showing.

Specified by:

getItemType in interface TypedChip

Returns:

the (super)type of the items this result list is showing.

getItemLayoutNode

public ItemLayoutNode getItemLayoutNode()

Returns the node that is used for determining the columns/attributes that are displayed. Default is the layout used for organizer search results (list view mode), if no itemLayoutNode is set using setitemLayoutNode().

Returns:

the node that is used for determining the columns/attributes that are displayed.

getMode

protected int getMode()

Since:

2.20

setItemLayoutNode

public void setItemLayoutNode(ItemLayoutNode layoutNode)

Sets the ItemLayoutDescriptor which this list should use to display its entries.

getHeaderQualifiers

public List getHeaderQualifiers()

getHeaderCount

public int getHeaderCount()

getTitle

public String getTitle(String qualifier)

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

getAttributeNodes

public List<AttributeNode> getAttributeNodes()

Returns:

Returns the list of AttributeNodes.

getChildNodes

public List getChildNodes()

Returns:

a List with the child nodes

Since:

2.20

getAttributeWidths

public Map getAttributeWidths()

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 ListChip