de.hybris.platform.hmc

Class TextLabelToolbarActionChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.AbstractToolbarActionChip

de.hybris.platform.hmc.TextLabelToolbarActionChip

All Implemented Interfaces:

Chip, EventCheckingChip, Serializable, Cloneable

public class TextLabelToolbarActionChip
extends AbstractToolbarActionChip

Implementation of AbstractSelectToolbarActionChip for displaying a label at a toolbar. You can decide to use an localized label with/without arguments or an unlocalized one to display.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.hmc.AbstractToolbarActionChip

AbstractToolbarActionChip.ToolbarActionListener

Field Summary

Fields inherited from class de.hybris.platform.hmc.AbstractToolbarActionChip

accepted, ALIGN_LEFT, ALIGN_RIGHT, PERFORM

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
TextLabelToolbarActionChip(DisplayState displayState, AbstractToolbarChip parent, String label) Creates a new toolbar chip with given label without arguments for localization.
TextLabelToolbarActionChip(DisplayState displayState, AbstractToolbarChip parent, String label, Object[] labelArguments) Creates a new toolbar chip with given label and arguments for localization.

Method Summary

Modifier and Type	Method and Description
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
String	getLabel()
Object[]	getLabelArguments() Gets the arguments used for localization.
void	setLabel(String text, Object[] arguments) Sets the label and the arguments used for localization.
void	setLocalized(boolean localized) Sets whether the label will be localized (current label text is only a localization key) or not (label text will be shown as it is).

Methods inherited from class de.hybris.platform.hmc.AbstractToolbarActionChip

addActionListener, getAcceptedEvents, getAccessKey, getAlignment, getConfirmationMessage, getEvent, getJavaScript, getProposedUniqueName, getToolbarType, getTooltip, getWidth, isEnabled, isPartOf, isVisible, notifyActionPerformed, perform, processEvents, removeActionListener, setAccessKey, setAlignment, setConfirmationMessage, setEnabled, setEvent, setJavaScript, setLabel, setShowLabel, setTooltip, setVisible, setWidth, showLabel

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

addEventListener, checkValid, clearInfoMessages, clone, containsDisplayEvent, createMenuEntriesForJS, dispose, errorQueueEmpty, getClipboard, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getFrame, getID, getInfoMessages, getJaloSession, getLocalizedString, getLocalizedString, getLogger, getMenuEntries, getNameSpace, getNameSpaceFor, getParent, 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, getMenuEntries, getParent, getUniqueName, goFullScreen, isValid, leaveFullScreen, registerUniqueName, removeEventListener, render, translateFormFieldToEventName, translateFormFieldToEventValue

Constructor Detail

TextLabelToolbarActionChip

public TextLabelToolbarActionChip(DisplayState displayState,
                                  AbstractToolbarChip parent,
                                  String label)

Creates a new toolbar chip with given label without arguments for localization. Localization is enabled by default and can be disabled using setLocalized(boolean).

Parameters:

displayState - display state

parent - parent chip

label - label to show

TextLabelToolbarActionChip

public TextLabelToolbarActionChip(DisplayState displayState,
                                  AbstractToolbarChip parent,
                                  String label,
                                  Object[] labelArguments)

Creates a new toolbar chip with given label and arguments for localization. Localization is enabled by default and can be disabled using setLocalized(boolean).

Parameters:

displayState - display state

parent - parent chip

label - label to show

labelArguments - arguments for localization

Method Detail

getJSPURI

public String getJSPURI()

Description copied from interface: Chip

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

Specified by:

getJSPURI in interface Chip

Specified by:

getJSPURI in class AbstractToolbarActionChip

setLabel

public void setLabel(String text,
                     Object[] arguments)

Sets the label and the arguments used for localization.

Parameters:

text - label text to display (or localization key)

arguments - arguments for localization

getLabelArguments

public Object[] getLabelArguments()

Gets the arguments used for localization.

Returns:

arguments used for localization.

getLabel

public String getLabel()

Overrides:

getLabel in class AbstractToolbarActionChip

setLocalized

public void setLocalized(boolean localized)

Sets whether the label will be localized (current label text is only a localization key) or not (label text will be shown as it is).

Parameters:

localized - true for enable localization, otherwise false