org.gatein.portlet.responsive.navigation

Class NavigationNodeBean

java.lang.Object

org.gatein.portlet.responsive.navigation.NavigationNodeBean

public class NavigationNodeBean
extends Object

NavigationNodeBean is representing a single navigation node. It basically encapsulates the Node from the GateIn Portal API.

Version:

$Revision$

Author:

Viliam Rockai

Constructor Summary

Constructors

Constructor and Description
NavigationNodeBean(org.gatein.api.navigation.Node node) Constructs a new NavigationNodeBean encapsulating the Node instance specified in the parameter.

Method Summary

Modifier and Type	Method and Description
List<NavigationNodeBean>	getChildren()
String	getName() Returns the display name of the encapsulated node.
String	getPath() Returns the String value of path to the current NavigationNodeBean.
String	getURI() Returns the URI string of the encapsulated node.
boolean	isActive() Returns the current NavigationNodeBean active state.
boolean	isEmptyCategory()
boolean	isPage() Returns true if current node has a page assigned to it, false otherwise.
boolean	isParent() Returns true if parent node contains one or more children nodes.
boolean	isSystem() Returns true, if the current node is a system node.
void	setActive(boolean active) Sets the current NavigationNodeBean node active state.
void	setChildren(List<NavigationNodeBean> children)
void	setEmptyCategory(boolean emptyCategory)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NavigationNodeBean

public NavigationNodeBean(org.gatein.api.navigation.Node node)

Constructs a new NavigationNodeBean encapsulating the Node instance specified in the parameter.

Parameters:

node - A node to be encapsulated by this NavigationNodeBean.

Method Detail

getChildren

public List<NavigationNodeBean> getChildren()

setChildren

public void setChildren(List<NavigationNodeBean> children)

setEmptyCategory

public void setEmptyCategory(boolean emptyCategory)

isEmptyCategory

public boolean isEmptyCategory()

isSystem

public boolean isSystem()

Returns true, if the current node is a system node. A system node is a node with visibility status of value Visibility.Status.SYSTEM.

Returns:

true, if the current node is a system node.

setActive

public void setActive(boolean active)

Sets the current NavigationNodeBean node active state. The active state indicates that this bean is being currently accessed in the user interface.

Parameters:

active - A boolean value.

isActive

public boolean isActive()

Returns the current NavigationNodeBean active state.

Returns:

The current NavigationNodeBean active state.

See Also:

setActive(boolean)

getPath

public String getPath()

Returns the String value of path to the current NavigationNodeBean.

Returns:

The String value of path to the current NavigationNodeBean.

isPage

public boolean isPage()

Returns true if current node has a page assigned to it, false otherwise. Node doesn't have to have the page assigned. Node without any pages can serve as "categories".

Returns:

true if current node has a page assigned to it, false otherwise.

isParent

public boolean isParent()

Returns true if parent node contains one or more children nodes.

Returns:

true if current node children count is higher than 0 (it contains any children nodes), false otherwise.

getName

public String getName()

Returns the display name of the encapsulated node.

Returns:

The display name of the encapsulated node.

getURI

public String getURI()

Returns the URI string of the encapsulated node.

Returns:

The URI string of the encapsulated node.