com.hybris.backoffice.actionbar

Class DefaultActionDefinition

java.lang.Object

com.hybris.backoffice.actionbar.DefaultActionDefinition

All Implemented Interfaces:

ActionDefinition, Serializable

Direct Known Subclasses:

SimpleNode

public class DefaultActionDefinition
extends Object
implements ActionDefinition

Represents a action node with name, description and icon.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultActionDefinition(String id)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDescription() Returns the description of the node.
String	getDescriptionLocKey() Returns the localization key for the description of the node.
String	getGroup() Returns a group name for a node.
String	getIconUri() Returns the icon URI of the node.
String	getIconUriLocKey() Returns the localization key for the icon URI of the node.
String	getId() Returns the ID of the node.
String	getName() Returns the name of the node.
String	getNameLocKey() Returns the localization key for the name of the node.
int	hashCode()
void	setDescription(String description)
void	setDescriptionLocKey(String descriptionLocKey)
void	setGroup(String group)
void	setIconUri(String iconUri)
void	setIconUriLocKey(String iconUriLocKey)
void	setName(String name)
void	setNameLocKey(String nameLocKey)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultActionDefinition

public DefaultActionDefinition(String id)

Method Detail

getName

public String getName()

Description copied from interface: ActionDefinition

Returns the name of the node. This is only used as a node name if the localization key for the node name is not set (see ActionDefinition.getNameLocKey()).

Specified by:

getName in interface ActionDefinition

Returns:

the name of the node

See Also:

ActionDefinition.getNameLocKey()

setName

public void setName(String name)

getNameLocKey

public String getNameLocKey()

Description copied from interface: ActionDefinition

Returns the localization key for the name of the node. This will be used to get the localized name of the node in the current Locale. If this is null then ActionDefinition.getName() is used as the node name.

Specified by:

getNameLocKey in interface ActionDefinition

Returns:

localization key for the name of the node or null if ActionDefinition.getName() is should be used as the node name

See Also:

ActionDefinition.getName()

setNameLocKey

public void setNameLocKey(String nameLocKey)

getDescription

public String getDescription()

Description copied from interface: ActionDefinition

Returns the description of the node. This is only used as a node description if the localization key for the node description is not set (see ActionDefinition.getDescriptionLocKey()).

Specified by:

getDescription in interface ActionDefinition

Returns:

the description of the node

See Also:

ActionDefinition.getDescriptionLocKey()

setDescription

public void setDescription(String description)

getDescriptionLocKey

public String getDescriptionLocKey()

Description copied from interface: ActionDefinition

Returns the localization key for the description of the node. This will be used to get the localized description of the node in the current Locale. If this is null then ActionDefinition.getDescription() is used as the node description.

Specified by:

getDescriptionLocKey in interface ActionDefinition

Returns:

localization key for the description of the node or null if ActionDefinition.getDescription() is should be used as the node description

See Also:

ActionDefinition.getDescription()

setDescriptionLocKey

public void setDescriptionLocKey(String descriptionLocKey)

getIconUri

public String getIconUri()

Description copied from interface: ActionDefinition

Returns the icon URI of the node. This is only used as a node icon URI if the localization key for the node icon URI is not set (see ActionDefinition.getIconUriLocKey()).

Specified by:

getIconUri in interface ActionDefinition

Returns:

the icon URI of the node

See Also:

ActionDefinition.getIconUriLocKey()

setIconUri

public void setIconUri(String iconUri)

getIconUriLocKey

public String getIconUriLocKey()

Description copied from interface: ActionDefinition

Returns the localization key for the icon URI of the node. This will be used to get the localized icon URI of the node in the current Locale. If this is null then ActionDefinition.getIconUri() is used as the node description.

Specified by:

getIconUriLocKey in interface ActionDefinition

Returns:

localization key for the icon URI of the node or null if ActionDefinition.getIconUri() is should be used as the node icon URI

See Also:

ActionDefinition.getIconUri()

setIconUriLocKey

public void setIconUriLocKey(String iconUriLocKey)

getId

public String getId()

Description copied from interface: ActionDefinition

Returns the ID of the node. Should be unique within the tree structure.

Specified by:

getId in interface ActionDefinition

Returns:

ID of the node

getGroup

public String getGroup()

Description copied from interface: ActionDefinition

Returns a group name for a node.

Interpretation of group depends totally on toolbar's implementation.

Specified by:

getGroup in interface ActionDefinition

Returns:

name of group or null if not applicable

setGroup

public void setGroup(String group)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object