Package com.hybris.backoffice.navigation.impl

Class SimpleNode

java.lang.Object

com.hybris.backoffice.actionbar.DefaultActionDefinition

com.hybris.backoffice.navigation.impl.SimpleNode

All Implemented Interfaces:

ActionDefinition, NavigationNode, ActionAwareNode, java.io.Serializable

Direct Known Subclasses:

DynamicNode, TypeNode

public class SimpleNode
extends DefaultActionDefinition
implements NavigationNode, ActionAwareNode

Represents a navigation node with name, description and icon. It can hold a data object as well.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SimpleNode(java.lang.String id)
SimpleNode(java.lang.String id, java.lang.Object data)

Method Summary

Modifier and Type	Method	Description
void	addChild(NavigationNode child)	Adds the given node as a child of this node.
static SimpleNode	create(ActionDefinition action)
boolean	equals(java.lang.Object obj)
java.util.List<NavigationNode>	getChildren()	Returns all children nodes.
CockpitContext	getContext()	Returns node context
java.lang.Object	getData()	Returns data associated with the node.
int	getLevel()	Returns the level of this node.
NavigationNode	getParent()	Returns the parent node of this node.
int	hashCode()
boolean	isActionAware()	Defines if node is action aware
boolean	isDirectory()	Returns true if this node can have children.
boolean	isExpandedByDefault()	Returns true if this node should be expanded by default when the tree is created.
void	setActionAware(boolean actionAware)
void	setChildren(java.util.List<NavigationNode> children)	Sets the given list to be child nodes of this node.
void	setContext(CockpitContext context)	Sets node context
void	setData(java.lang.Object data)
void	setDirectory(boolean directory)
void	setExpandedByDefault(boolean expandedByDefault)
void	setLevel(int level)
void	setParent(NavigationNode parent)	Sets the parent of this node to the given node.

Methods inherited from class com.hybris.backoffice.actionbar.DefaultActionDefinition

getDescription, getDescriptionLocKey, getGroup, getIconUri, getIconUriLocKey, getId, getName, getNameLocKey, setDescription, setDescriptionLocKey, setGroup, setIconUri, setIconUriLocKey, setName, setNameLocKey, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hybris.backoffice.actionbar.ActionDefinition

getDescription, getDescriptionLocKey, getGroup, getIconUri, getIconUriLocKey, getId, getName, getNameLocKey

Constructor Detail

SimpleNode

public SimpleNode(java.lang.String id)

SimpleNode

public SimpleNode(java.lang.String id,
                  java.lang.Object data)

Method Detail

getData

public java.lang.Object getData()

Description copied from interface: NavigationNode

Returns data associated with the node. If no data are associated with the node it returns null.

Specified by:

getData in interface NavigationNode

Returns:

data associated with the node or null if no data are associated with the node

setData

public void setData(java.lang.Object data)

getLevel

public int getLevel()

Description copied from interface: NavigationNode

Returns the level of this node. A root node has level = 0.

Specified by:

getLevel in interface NavigationNode

Returns:

level of this node

setLevel

public void setLevel(int level)

isDirectory

public boolean isDirectory()

Description copied from interface: NavigationNode

Returns true if this node can have children.

Specified by:

isDirectory in interface NavigationNode

Returns:

true if this node can have children and false otherwise

setDirectory

public void setDirectory(boolean directory)

isExpandedByDefault

public boolean isExpandedByDefault()

Description copied from interface: NavigationNode

Returns true if this node should be expanded by default when the tree is created.

Specified by:

isExpandedByDefault in interface NavigationNode

Returns:

true if this node should be expanded by default; false otherwise

setExpandedByDefault

public void setExpandedByDefault(boolean expandedByDefault)

getParent

public NavigationNode getParent()

Description copied from interface: NavigationNode

Returns the parent node of this node.

Specified by:

getParent in interface NavigationNode

Returns:

parent node of this node or null if this is a root node

setParent

public void setParent(NavigationNode parent)

Description copied from interface: NavigationNode

Sets the parent of this node to the given node.

Specified by:

setParent in interface NavigationNode

Parameters:

parent - a node to become a parent of this node

getChildren

public java.util.List<NavigationNode> getChildren()

Description copied from interface: NavigationNode

Returns all children nodes.

Specified by:

getChildren in interface NavigationNode

Returns:

all children nodes

setChildren

public void setChildren(java.util.List<NavigationNode> children)

Description copied from interface: NavigationNode

Sets the given list to be child nodes of this node.

Specified by:

setChildren in interface NavigationNode

Parameters:

children - list of nodes to become children of this node

addChild

public void addChild(NavigationNode child)

Description copied from interface: NavigationNode

Adds the given node as a child of this node.

Specified by:

addChild in interface NavigationNode

Parameters:

child - a node to become a child of this node

setActionAware

public void setActionAware(boolean actionAware)

isActionAware

public boolean isActionAware()

Description copied from interface: ActionAwareNode

Defines if node is action aware

Specified by:

isActionAware in interface ActionAwareNode

Returns:

whether is aware or not

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class DefaultActionDefinition

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultActionDefinition

create

public static SimpleNode create(ActionDefinition action)

getContext

public CockpitContext getContext()

Description copied from interface: NavigationNode

Returns node context

Specified by:

getContext in interface NavigationNode

Returns:

new DefaultCockpitContext by default

setContext

public void setContext(CockpitContext context)

Description copied from interface: NavigationNode

Sets node context

Specified by:

setContext in interface NavigationNode