de.hybris.platform.hmc

Class ImageToolbarActionChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.AbstractToolbarActionChip

de.hybris.platform.hmc.ImageToolbarActionChip

All Implemented Interfaces:

Chip, EventCheckingChip, Serializable, Cloneable

Direct Known Subclasses:

DropDownToolbarActionChip, OrganizerCreatorClearToolbarActionChip, OrganizerCreatorOpenEditorToolbarActionChip, OrganizerCreatorSaveAndCopyToolbarActionChip

public class ImageToolbarActionChip
extends AbstractToolbarActionChip

Implementation of AbstractToolbarActionChip with additional support for displaying provided images.

See Also:

Serialized Form

Nested Class Summary

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

AbstractToolbarActionChip.ToolbarActionListener

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUTTON_ADD
static String	BUTTON_CANCEL
static String	BUTTON_CLEAR
static String	BUTTON_CLEAR_ALL
static String	BUTTON_COPY
static String	BUTTON_COPYTOCREATOR
static String	BUTTON_CREATE
static String	BUTTON_CUT
static String	BUTTON_DELETE
static String	BUTTON_DIVIDER
static String	BUTTON_EXTENSION
static String	BUTTON_INACTIVE
static String	BUTTON_NORMAL
static String	BUTTON_OK
static String	BUTTON_OPEN_ALT
static String	BUTTON_OPEN_TYPE
static String	BUTTON_PASTE
static String	BUTTON_PATH
static String	BUTTON_REFRESH
static String	BUTTON_RESET_CONDITIONS
static String	BUTTON_SAVE
static String	BUTTON_SAVE_ALL
static String	BUTTON_SAVE_AND_CLOSE
static String	BUTTON_SUFFIX_EDITORTOOLBAR
static String	BUTTON_SUFFIX_MAINTOOLBAR
static String	DEFAULT_BUTTON_CSS
static String	DEFAULT_BUTTON_CSS_DISABLED
static String	EDITOR_BUTTON_CSS
static String	EDITOR_BUTTON_CSS_DISABLED
static String	FOOTER_BUTTON_CSS
static String	FOOTER_BUTTON_CSS_DISABLED
static String	MAIN_BUTTON_CSS
static String	MAIN_BUTTON_CSS_DISABLED
static String	SECTION_BUTTON_CSS
static String	SECTION_BUTTON_CSS_DISABLED
static String	URI

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
ImageToolbarActionChip(AbstractToolbarChip parent, String event, String imageName, String label)
ImageToolbarActionChip(AbstractToolbarChip parent, String event, String imageName, String label, String javascript)
ImageToolbarActionChip(DisplayState displayState, AbstractToolbarChip parent, String event, String imageName, String label)
ImageToolbarActionChip(DisplayState displayState, AbstractToolbarChip parent, String event, String imageName, String label, String javascript)

Method Summary

Modifier and Type	Method and Description
String	getButtonCSS()
String	getImageURL()
static String	getImageURL(String name, String state, String type)
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
boolean	hasIcon()
boolean	isDropDown() Deprecated. since 2.30 we have a dedicated DropDownToolbarActionChip!
void	setButtonCSS(String cssClass)
void	setDropDown(boolean dropDown) Deprecated. since 2.30 we have a dedicated DropDownToolbarActionChip!
void	setEnabled(boolean enabled) Overrides AbstractToolbarActionChip.setEnabled(boolean) to additionally reset the button's css class name.
void	setHasIcon(boolean hasIcon)
void	setImageName(String imageName)

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

addActionListener, getAcceptedEvents, getAccessKey, getAlignment, getConfirmationMessage, getEvent, getJavaScript, getLabel, getProposedUniqueName, getToolbarType, getTooltip, getWidth, isEnabled, isPartOf, isVisible, notifyActionPerformed, perform, processEvents, removeActionListener, setAccessKey, setAlignment, setConfirmationMessage, 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

Field Detail

BUTTON_PATH

public static final String BUTTON_PATH

See Also:

Constant Field Values

BUTTON_NORMAL

public static final String BUTTON_NORMAL

See Also:

Constant Field Values

BUTTON_INACTIVE

public static final String BUTTON_INACTIVE

See Also:

Constant Field Values

BUTTON_EXTENSION

public static final String BUTTON_EXTENSION

See Also:

Constant Field Values

BUTTON_ADD

public static final String BUTTON_ADD

See Also:

Constant Field Values

BUTTON_CREATE

public static final String BUTTON_CREATE

See Also:

Constant Field Values

BUTTON_CANCEL

public static final String BUTTON_CANCEL

See Also:

Constant Field Values

BUTTON_COPY

public static final String BUTTON_COPY

See Also:

Constant Field Values

BUTTON_COPYTOCREATOR

public static final String BUTTON_COPYTOCREATOR

See Also:

Constant Field Values

BUTTON_CUT

public static final String BUTTON_CUT

See Also:

Constant Field Values

BUTTON_DELETE

public static final String BUTTON_DELETE

See Also:

Constant Field Values

BUTTON_DIVIDER

public static final String BUTTON_DIVIDER

See Also:

Constant Field Values

BUTTON_OPEN_ALT

public static final String BUTTON_OPEN_ALT

See Also:

Constant Field Values

BUTTON_OK

public static final String BUTTON_OK

See Also:

Constant Field Values

BUTTON_PASTE

public static final String BUTTON_PASTE

See Also:

Constant Field Values

BUTTON_SAVE

public static final String BUTTON_SAVE

See Also:

Constant Field Values

BUTTON_SAVE_AND_CLOSE

public static final String BUTTON_SAVE_AND_CLOSE

See Also:

Constant Field Values

BUTTON_SAVE_ALL

public static final String BUTTON_SAVE_ALL

See Also:

Constant Field Values

BUTTON_CLEAR

public static final String BUTTON_CLEAR

See Also:

Constant Field Values

BUTTON_CLEAR_ALL

public static final String BUTTON_CLEAR_ALL

See Also:

Constant Field Values

BUTTON_REFRESH

public static final String BUTTON_REFRESH

See Also:

Constant Field Values

BUTTON_RESET_CONDITIONS

public static final String BUTTON_RESET_CONDITIONS

See Also:

Constant Field Values

BUTTON_OPEN_TYPE

public static final String BUTTON_OPEN_TYPE

See Also:

Constant Field Values

BUTTON_SUFFIX_MAINTOOLBAR

public static final String BUTTON_SUFFIX_MAINTOOLBAR

See Also:

Constant Field Values

BUTTON_SUFFIX_EDITORTOOLBAR

public static final String BUTTON_SUFFIX_EDITORTOOLBAR

See Also:

Constant Field Values

URI

public static final String URI

See Also:

Constant Field Values

DEFAULT_BUTTON_CSS

public static final String DEFAULT_BUTTON_CSS

See Also:

Constant Field Values

EDITOR_BUTTON_CSS

public static final String EDITOR_BUTTON_CSS

See Also:

Constant Field Values

FOOTER_BUTTON_CSS

public static final String FOOTER_BUTTON_CSS

See Also:

Constant Field Values

MAIN_BUTTON_CSS

public static final String MAIN_BUTTON_CSS

See Also:

Constant Field Values

SECTION_BUTTON_CSS

public static final String SECTION_BUTTON_CSS

See Also:

Constant Field Values

DEFAULT_BUTTON_CSS_DISABLED

public static final String DEFAULT_BUTTON_CSS_DISABLED

See Also:

Constant Field Values

EDITOR_BUTTON_CSS_DISABLED

public static final String EDITOR_BUTTON_CSS_DISABLED

See Also:

Constant Field Values

FOOTER_BUTTON_CSS_DISABLED

public static final String FOOTER_BUTTON_CSS_DISABLED

See Also:

Constant Field Values

MAIN_BUTTON_CSS_DISABLED

public static final String MAIN_BUTTON_CSS_DISABLED

See Also:

Constant Field Values

SECTION_BUTTON_CSS_DISABLED

public static final String SECTION_BUTTON_CSS_DISABLED

See Also:

Constant Field Values

Constructor Detail

ImageToolbarActionChip

public ImageToolbarActionChip(DisplayState displayState,
                              AbstractToolbarChip parent,
                              String event,
                              String imageName,
                              String label)

ImageToolbarActionChip

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

ImageToolbarActionChip

public ImageToolbarActionChip(AbstractToolbarChip parent,
                              String event,
                              String imageName,
                              String label,
                              String javascript)

ImageToolbarActionChip

public ImageToolbarActionChip(AbstractToolbarChip parent,
                              String event,
                              String imageName,
                              String label)

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

getImageURL

public String getImageURL()

setImageName

public void setImageName(String imageName)

getImageURL

public static String getImageURL(String name,
                                 String state,
                                 String type)

isDropDown

@Deprecated
public boolean isDropDown()

Deprecated. since 2.30 we have a dedicated DropDownToolbarActionChip!

If true, the appropriate button should show a dropdown arrow.

Returns:

true to signal a dropdown layout

setDropDown

@Deprecated
public void setDropDown(boolean dropDown)

Deprecated. since 2.30 we have a dedicated DropDownToolbarActionChip!

Set to true to signal that the layout should show a dropdown arrow in the button.

Parameters:

dropDown - if true, the appropriate button should show a dropdown arrow.

setButtonCSS

public void setButtonCSS(String cssClass)

Since:

3.00 (beta1)

getButtonCSS

public String getButtonCSS()

Since:

3.00 (beta1)

setEnabled

public void setEnabled(boolean enabled)

Overrides AbstractToolbarActionChip.setEnabled(boolean) to additionally reset the button's css class name.

Overrides:

setEnabled in class AbstractToolbarActionChip

hasIcon

public boolean hasIcon()

Since:

3.00 (beta1)

setHasIcon

public void setHasIcon(boolean hasIcon)

Since:

3.00 (beta1)