com.hybris.backoffice.actionbar

Interface ActionComponent

All Known Implementing Classes:

LabelImageActionComponent, MenuActionComponent, MenuitemActionComponent, TreeitemActionComponent

public interface ActionComponent

A component interface that represents a single action

Method Summary

Modifier and Type	Method and Description
Object	getAttribute(String name) Gets an attribute of specified name from action representation component
org.zkoss.zk.ui.Component	getComponent() Gets action representation component
String	getImage() Gets uri to action icon
String	getLabel() Gets current label representation of action
String	getTooltiptext() Gets current action's tooltip
boolean	hasAttribute(String name) Checks whether action representation component has defined an attribute of specified name
Object	removeAttribute(String name) Removes definition of specified attribute from action representation component
Object	setAttribute(String name, Object value) Sets new value of specified attribute in action representation component
void	setImage(String image) Sets new uri to action icon
void	setLabel(String label) Sets new label representation of action
void	setTooltiptext(String tooltiptext) Sets new action's tooltip

Method Detail

setLabel

void setLabel(String label)

Sets new label representation of action

Parameters:

label - label representation

getLabel

String getLabel()

Gets current label representation of action

Returns:

label representation

getImage

String getImage()

Gets uri to action icon

Returns:

action's icon uri

setImage

void setImage(String image)

Sets new uri to action icon

Parameters:

image - action's icon uri

getTooltiptext

String getTooltiptext()

Gets current action's tooltip

Returns:

tooltip

setTooltiptext

void setTooltiptext(String tooltiptext)

Sets new action's tooltip

Parameters:

tooltiptext - new tooltip

getAttribute

Object getAttribute(String name)

Gets an attribute of specified name from action representation component

Parameters:

name - name of attribute

Returns:

value of component's attribute

hasAttribute

boolean hasAttribute(String name)

Checks whether action representation component has defined an attribute of specified name

Parameters:

name - name of attribute

Returns:

true if component defines an attribute

setAttribute

Object setAttribute(String name,
                    Object value)

Sets new value of specified attribute in action representation component

Parameters:

name - name of attribute

value - value of attribute

Returns:

previous value of attribute

removeAttribute

Object removeAttribute(String name)

Removes definition of specified attribute from action representation component

Parameters:

name - name of attribute

Returns:

value of attribute just removed

getComponent

org.zkoss.zk.ui.Component getComponent()

Gets action representation component

Returns:

actual component