de.hybris.platform.hmc

Class AbstractToolbarActionChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.AbstractToolbarActionChip

All Implemented Interfaces:

Chip, EventCheckingChip, Serializable, Cloneable

Direct Known Subclasses:

AbstractAutocompleterToolbarActionChip, AbstractSelectToolbarActionChip, ActionSelectChip, DividerToolbarChip, ImageToolbarActionChip, LucenesearchToolbarActionChip, ProgressToolbarActionChip, TextboxToolbarActionChip, TextLabelToolbarActionChip, ToggleTooblbarActionChip

public abstract class AbstractToolbarActionChip
extends AbstractChip
implements EventCheckingChip

This class is the base class for all ToolbarActionChips

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractToolbarActionChip.ToolbarActionListener Interface for offering a notification mechanism of toolbar actions.

Field Summary

Fields

Modifier and Type	Field and Description
protected Set	accepted
static int	ALIGN_LEFT
static int	ALIGN_RIGHT
static String	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
AbstractToolbarActionChip(AbstractToolbarChip parent, String label, String event)
AbstractToolbarActionChip(AbstractToolbarChip parent, String label, String event, String javascript)
AbstractToolbarActionChip(DisplayState displayState, AbstractToolbarChip parent, String label, String event)
AbstractToolbarActionChip(DisplayState displayState, AbstractToolbarChip parent, String label, String event, String javascript)

Method Summary

Modifier and Type	Method and Description
void	addActionListener(AbstractToolbarActionChip.ToolbarActionListener listener)
Set	getAcceptedEvents()
char	getAccessKey()
int	getAlignment() Gets the preferred alignment of this toolbar action chip.
String	getConfirmationMessage()
String	getEvent()
String	getJavaScript()
abstract String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
String	getLabel()
protected String	getProposedUniqueName()
int	getToolbarType()
String	getTooltip()
String	getWidth() Get the preferred width of this chip.
boolean	isEnabled()
boolean	isPartOf()
boolean	isVisible()
protected void	notifyActionPerformed(List values)
protected void	perform()
void	processEvents(Map<String,List<String>> events) Handles all incoming requests for this chip.
void	removeActionListener(AbstractToolbarActionChip.ToolbarActionListener listener)
void	setAccessKey(char accessKey)
void	setAlignment(int alignment) Sets the alignment of this toolbar action chip.
void	setConfirmationMessage(String confirmationMessage)
void	setEnabled(boolean enabled)
void	setEvent(String event)
void	setJavaScript(String string)
void	setLabel(String string)
void	setShowLabel(boolean showLabel)
void	setTooltip(String tooltip)
void	setVisible(boolean visible)
void	setWidth(String string) Set the intended width for this toolbaraction.
boolean	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

Field Detail

PERFORM

public static final String PERFORM

See Also:

Constant Field Values

ALIGN_LEFT

public static final int ALIGN_LEFT

See Also:

Constant Field Values

ALIGN_RIGHT

public static final int ALIGN_RIGHT

See Also:

Constant Field Values

accepted

protected Set accepted

Constructor Detail

AbstractToolbarActionChip

public AbstractToolbarActionChip(DisplayState displayState,
                                 AbstractToolbarChip parent,
                                 String label,
                                 String event)

Since:

3.00 (beta1)

AbstractToolbarActionChip

public AbstractToolbarActionChip(DisplayState displayState,
                                 AbstractToolbarChip parent,
                                 String label,
                                 String event,
                                 String javascript)

AbstractToolbarActionChip

public AbstractToolbarActionChip(AbstractToolbarChip parent,
                                 String label,
                                 String event,
                                 String javascript)

AbstractToolbarActionChip

public AbstractToolbarActionChip(AbstractToolbarChip parent,
                                 String label,
                                 String event)

Since:

3.00 (beta1)

Method Detail

getAcceptedEvents

public Set getAcceptedEvents()

Specified by:

getAcceptedEvents in interface EventCheckingChip

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

notifyActionPerformed

protected void notifyActionPerformed(List values)

addActionListener

public void addActionListener(AbstractToolbarActionChip.ToolbarActionListener listener)

removeActionListener

public void removeActionListener(AbstractToolbarActionChip.ToolbarActionListener listener)

perform

protected void perform()

isVisible

public boolean isVisible()

setVisible

public void setVisible(boolean visible)

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getJSPURI

public abstract 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

getJavaScript

public String getJavaScript()

getLabel

public String getLabel()

setJavaScript

public void setJavaScript(String string)

setLabel

public void setLabel(String string)

getEvent

public String getEvent()

setEvent

public void setEvent(String event)

isPartOf

public boolean isPartOf()

getWidth

public String getWidth()

Get the preferred width of this chip.

Returns:

a String containing the width in css syntax (e.g. "100px") or null if there is no width set

setWidth

public void setWidth(String string)

Set the intended width for this toolbaraction. The jsp using this chip is expected to cope with null as result (meaning that the chip should be rendered with default width). Use setWidth(null) to delete the preferred width.

Parameters:

string - a String containing the preferred width for this chip (in css syntax, e.g. "50px") or null to delete the preferred width

getAlignment

public int getAlignment()

Gets the preferred alignment of this toolbar action chip.

Returns:

int containing the alignment constant (ALIGN_LEFT or ALIGN_RIGHT) or -1 if there is no preferred alignment

setAlignment

public void setAlignment(int alignment)

Sets the alignment of this toolbar action chip.

Parameters:

alignment - int containing the alignment constant (ALIGN_LEFT or ALIGN_RIGHT) or -1 if there is no preferred alignment set (in constructor ALIGN_LEFT is set as default)

showLabel

public boolean showLabel()

setShowLabel

public void setShowLabel(boolean showLabel)

getToolbarType

public int getToolbarType()

Returns:

Returns the toolbarType.

getTooltip

public String getTooltip()

Since:

2.20

setTooltip

public void setTooltip(String tooltip)

Since:

2.20

getAccessKey

public char getAccessKey()

Since:

2.30

setAccessKey

public void setAccessKey(char accessKey)

Since:

2.30

getConfirmationMessage

public String getConfirmationMessage()

setConfirmationMessage

public void setConfirmationMessage(String confirmationMessage)

getProposedUniqueName

protected String getProposedUniqueName()

Overrides:

getProposedUniqueName in class AbstractChip