de.hybris.platform.hmc

Class AbstractToolbarChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.AbstractToolbarChip

All Implemented Interfaces:

Chip, Serializable, Cloneable

Direct Known Subclasses:

AbstractGenericConditionalSearchToolbarChip, DefaultFooterChip, DefaultToolbarChip, GenericSearchItemListToolbarChip, OrganizerCreatorToolbarChip, OrganizerToolbarChip, SearchResultToolbarChip, ToolbarChip

public abstract class AbstractToolbarChip
extends AbstractChip

This is a template for toolbar chips.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<AbstractToolbarActionChip>	extensionToolbarActionChips
static int	TOOLBAR_TYPE_DEFAULT default = use 'old' behaviour which tries to determine the correct color by context
static int	TOOLBAR_TYPE_EDITOR editor = dark grey toolbars in list/map attribute editors (containing add and resort buttons in lists etc.)
static int	TOOLBAR_TYPE_FOOTER footer = grey footer beneath sections, lists, editors (containing page browsing buttons etc.)
static int	TOOLBAR_TYPE_MAIN main = topmost, light grey toolbar in main hmc window (containing create and logout buttons etc.)
static int	TOOLBAR_TYPE_SECTION section = blue toolbars as in search, result and edit section (containing save and delete buttons etc.)
protected List<AbstractToolbarActionChip>	toolbarActionChips
static String	URI

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

Method Summary

Modifier and Type	Method and Description
void	addCoreActionChip(AbstractToolbarActionChip action)
void	addCoreActionChip(AbstractToolbarActionChip action, int index)
void	addDivider()
void	addDivider(boolean alignLeft)
AbstractToolbarActionChip	addToolbarAction(String action, String icon, String label, String javaScript, int width, boolean left, AbstractToolbarActionChip.ToolbarActionListener listener)
void	checkValid() Gives the chip the possibility to check if its objects are still valid.
static List	filterToolbarActionChips(List<AbstractToolbarActionChip> actionChips, int alignment) Returns list of actionChips with the given alignment.
String	getBackgroundColor()
List<AbstractToolbarActionChip>	getCoreToolbarActionChips()
protected List<AbstractToolbarActionChip>	getEditorToolbarActionChips() Deprecated. Use getCoreToolbarActionChips() instead.
List<AbstractToolbarActionChip>	getExtensionToolbarActionChips()
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
List<AbstractToolbarActionChip>	getToolbarActionChips()
int	getToolbarType()
boolean	hasBackgroundColor()
boolean	hasCorners()
protected void	initialize()
boolean	isEmpty()
boolean	isInitialized()
boolean	isPartOf()
void	processEvents(Map<String,List<String>> events) Handles all incoming requests for this chip.
void	removeCoreActionChip(AbstractToolbarActionChip action)
protected void	removeExtensionActionChip(AbstractToolbarActionChip action)
void	removeToolbarAction(AbstractToolbarActionChip actionChip)
void	setBackgroundColor(String colorDef)
void	setCorners(boolean corners)
void	setPartOf(boolean partOf)
void	setToolbarType(int toolbarType)

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

Field Detail

URI

public static final String URI

See Also:

Constant Field Values

toolbarActionChips

protected List<AbstractToolbarActionChip> toolbarActionChips

extensionToolbarActionChips

protected List<AbstractToolbarActionChip> extensionToolbarActionChips

TOOLBAR_TYPE_DEFAULT

public static final int TOOLBAR_TYPE_DEFAULT

default = use 'old' behaviour which tries to determine the correct color by context

See Also:

Constant Field Values

TOOLBAR_TYPE_MAIN

public static final int TOOLBAR_TYPE_MAIN

main = topmost, light grey toolbar in main hmc window (containing create and logout buttons etc.)

See Also:

Constant Field Values

TOOLBAR_TYPE_SECTION

public static final int TOOLBAR_TYPE_SECTION

section = blue toolbars as in search, result and edit section (containing save and delete buttons etc.)

See Also:

Constant Field Values

TOOLBAR_TYPE_EDITOR

public static final int TOOLBAR_TYPE_EDITOR

editor = dark grey toolbars in list/map attribute editors (containing add and resort buttons in lists etc.)

See Also:

Constant Field Values

TOOLBAR_TYPE_FOOTER

public static final int TOOLBAR_TYPE_FOOTER

footer = grey footer beneath sections, lists, editors (containing page browsing buttons etc.)

See Also:

Constant Field Values

Constructor Detail

AbstractToolbarChip

public AbstractToolbarChip(DisplayState displayState,
                           Chip parent)

AbstractToolbarChip

public AbstractToolbarChip(Chip parent)

Method Detail

setCorners

public void setCorners(boolean corners)

hasCorners

public boolean hasCorners()

setPartOf

public void setPartOf(boolean partOf)

isPartOf

public boolean isPartOf()

setBackgroundColor

public void setBackgroundColor(String colorDef)

getBackgroundColor

public String getBackgroundColor()

hasBackgroundColor

public boolean hasBackgroundColor()

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)

getExtensionToolbarActionChips

public List<AbstractToolbarActionChip> getExtensionToolbarActionChips()

isEmpty

public final boolean isEmpty()

getToolbarActionChips

public final List<AbstractToolbarActionChip> getToolbarActionChips()

filterToolbarActionChips

public static List filterToolbarActionChips(List<AbstractToolbarActionChip> actionChips,
                                            int alignment)

Returns list of actionChips with the given alignment. If alignment = AbstractToolbarActionChip.ALIGN_LEFT then the chips with alignment set to -1 (undefined) are included in the list, too.

getEditorToolbarActionChips

@Deprecated
protected final List<AbstractToolbarActionChip> getEditorToolbarActionChips()

Deprecated. Use getCoreToolbarActionChips() instead.

getCoreToolbarActionChips

public final List<AbstractToolbarActionChip> getCoreToolbarActionChips()

getJSPURI

public String getJSPURI()

Description copied from interface: Chip

Returns the URI of the JSP that this chip wants to use.

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

addDivider

public void addDivider()

addDivider

public void addDivider(boolean alignLeft)

addToolbarAction

public AbstractToolbarActionChip addToolbarAction(String action,
                                                  String icon,
                                                  String label,
                                                  String javaScript,
                                                  int width,
                                                  boolean left,
                                                  AbstractToolbarActionChip.ToolbarActionListener listener)

removeToolbarAction

public void removeToolbarAction(AbstractToolbarActionChip actionChip)

addCoreActionChip

public void addCoreActionChip(AbstractToolbarActionChip action,
                              int index)

addCoreActionChip

public void addCoreActionChip(AbstractToolbarActionChip action)

removeCoreActionChip

public void removeCoreActionChip(AbstractToolbarActionChip action)

removeExtensionActionChip

protected void removeExtensionActionChip(AbstractToolbarActionChip action)

Since:

3.1-u5

initialize

protected void initialize()

isInitialized

public boolean isInitialized()

getToolbarType

public int getToolbarType()

Returns:

Returns the toolbarType.

setToolbarType

public void setToolbarType(int toolbarType)

Parameters:

toolbarType - The toolbarType to set.