org.gatein.api.navigation

Class ApiNode

java.lang.Object

org.gatein.api.navigation.ApiNode

All Implemented Interfaces:

Serializable, Iterable<org.gatein.api.navigation.Node>, org.gatein.api.common.Displayable, org.gatein.api.common.LocalizedDisplayable, org.gatein.api.navigation.Node

Direct Known Subclasses:

ApiFilteredNode

public class ApiNode
extends Object
implements org.gatein.api.navigation.Node

Author:

Stian Thorgersen, Nick Scavelli

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
org.gatein.api.navigation.Node	addChild(int index, String childName)
org.gatein.api.navigation.Node	addChild(String childName)
org.gatein.api.navigation.FilteredNode	filter()
org.gatein.api.navigation.Node	getChild(int index)
org.gatein.api.navigation.Node	getChild(String childName)
int	getChildCount()
String	getDisplayName()
org.gatein.api.common.i18n.LocalizedString	getDisplayNames()
String	getIconName()
String	getName()
org.gatein.api.navigation.Node	getNode(org.gatein.api.navigation.NodePath nodePath)
org.gatein.api.navigation.Node	getNode(String... nodePath)
org.gatein.api.navigation.NodePath	getNodePath()
org.gatein.api.page.PageId	getPageId()
org.gatein.api.navigation.Node	getParent()
String	getURI()
org.gatein.api.navigation.Visibility	getVisibility()
boolean	hasChild(String childName)
int	indexOf(String childName)
boolean	isChildrenLoaded()
boolean	isRoot()
boolean	isVisible()
Iterator<org.gatein.api.navigation.Node>	iterator()
void	moveTo(int index)
void	moveTo(int index, org.gatein.api.navigation.Node parent)
void	moveTo(org.gatein.api.navigation.Node parent)
boolean	removeChild(String childName)
void	setDisplayName(String displayName)
void	setDisplayNames(org.gatein.api.common.i18n.LocalizedString displayName)
void	setIconName(String iconName)
void	setName(String name)
void	setPageId(org.gatein.api.page.PageId pageId)
void	setVisibility(boolean visible)
void	setVisibility(org.gatein.api.navigation.PublicationDate publicationDate)
void	setVisibility(org.gatein.api.navigation.Visibility visibility)
void	sort(Comparator<org.gatein.api.navigation.Node> comparator)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

addChild

public org.gatein.api.navigation.Node addChild(int index,
                                               String childName)

Specified by:

addChild in interface org.gatein.api.navigation.Node

addChild

public org.gatein.api.navigation.Node addChild(String childName)

Specified by:

addChild in interface org.gatein.api.navigation.Node

filter

public org.gatein.api.navigation.FilteredNode filter()

Specified by:

filter in interface org.gatein.api.navigation.Node

getChild

public org.gatein.api.navigation.Node getChild(int index)

Specified by:

getChild in interface org.gatein.api.navigation.Node

getChild

public org.gatein.api.navigation.Node getChild(String childName)

Specified by:

getChild in interface org.gatein.api.navigation.Node

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface org.gatein.api.navigation.Node

getNode

public org.gatein.api.navigation.Node getNode(String... nodePath)

Specified by:

getNode in interface org.gatein.api.navigation.Node

getNode

public org.gatein.api.navigation.Node getNode(org.gatein.api.navigation.NodePath nodePath)

Specified by:

getNode in interface org.gatein.api.navigation.Node

getIconName

public String getIconName()

Specified by:

getIconName in interface org.gatein.api.navigation.Node

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface org.gatein.api.common.Displayable

getDisplayNames

public org.gatein.api.common.i18n.LocalizedString getDisplayNames()

Specified by:

getDisplayNames in interface org.gatein.api.common.LocalizedDisplayable

getName

public String getName()

Specified by:

getName in interface org.gatein.api.navigation.Node

getNodePath

public org.gatein.api.navigation.NodePath getNodePath()

Specified by:

getNodePath in interface org.gatein.api.navigation.Node

getPageId

public org.gatein.api.page.PageId getPageId()

Specified by:

getPageId in interface org.gatein.api.navigation.Node

getParent

public org.gatein.api.navigation.Node getParent()

Specified by:

getParent in interface org.gatein.api.navigation.Node

getURI

public String getURI()

Specified by:

getURI in interface org.gatein.api.navigation.Node

getVisibility

public org.gatein.api.navigation.Visibility getVisibility()

Specified by:

getVisibility in interface org.gatein.api.navigation.Node

hasChild

public boolean hasChild(String childName)

Specified by:

hasChild in interface org.gatein.api.navigation.Node

indexOf

public int indexOf(String childName)

Specified by:

indexOf in interface org.gatein.api.navigation.Node

isChildrenLoaded

public boolean isChildrenLoaded()

Specified by:

isChildrenLoaded in interface org.gatein.api.navigation.Node

isRoot

public boolean isRoot()

Specified by:

isRoot in interface org.gatein.api.navigation.Node

isVisible

public boolean isVisible()

Specified by:

isVisible in interface org.gatein.api.navigation.Node

iterator

public Iterator<org.gatein.api.navigation.Node> iterator()

Specified by:

iterator in interface Iterable<org.gatein.api.navigation.Node>

moveTo

public void moveTo(int index)

Specified by:

moveTo in interface org.gatein.api.navigation.Node

moveTo

public void moveTo(int index,
                   org.gatein.api.navigation.Node parent)

Specified by:

moveTo in interface org.gatein.api.navigation.Node

moveTo

public void moveTo(org.gatein.api.navigation.Node parent)

Specified by:

moveTo in interface org.gatein.api.navigation.Node

removeChild

public boolean removeChild(String childName)

Specified by:

removeChild in interface org.gatein.api.navigation.Node

setName

public void setName(String name)
             throws IllegalArgumentException

Specified by:

setName in interface org.gatein.api.navigation.Node

Throws:

IllegalArgumentException

setIconName

public void setIconName(String iconName)

Specified by:

setIconName in interface org.gatein.api.navigation.Node

setDisplayName

public void setDisplayName(String displayName)

Specified by:

setDisplayName in interface org.gatein.api.common.Displayable

setDisplayNames

public void setDisplayNames(org.gatein.api.common.i18n.LocalizedString displayName)

Specified by:

setDisplayNames in interface org.gatein.api.common.LocalizedDisplayable

setPageId

public void setPageId(org.gatein.api.page.PageId pageId)

Specified by:

setPageId in interface org.gatein.api.navigation.Node

setVisibility

public void setVisibility(boolean visible)

Specified by:

setVisibility in interface org.gatein.api.navigation.Node

setVisibility

public void setVisibility(org.gatein.api.navigation.PublicationDate publicationDate)

Specified by:

setVisibility in interface org.gatein.api.navigation.Node

setVisibility

public void setVisibility(org.gatein.api.navigation.Visibility visibility)

Specified by:

setVisibility in interface org.gatein.api.navigation.Node

sort

public void sort(Comparator<org.gatein.api.navigation.Node> comparator)

Specified by:

sort in interface org.gatein.api.navigation.Node

toString

public String toString()

Overrides:

toString in class Object