org.gatein.mop.api.workspace

Interface Navigation

All Superinterfaces:

Adaptable, WorkspaceObject

public interface Navigation
extends WorkspaceObject

A navigation denotes a visual item that display a link to a referenced entity like a page. A navigation is expressed as a tree where each navigation node owns an ordered list of named children.

A navigation node owns an optional link to a Link that denotes the entity shown visually by the navigation node.

Version:

$Revision$

Author:

Julien Viet

Method Summary

Methods

Modifier and Type	Method and Description
Navigation	addChild(Integer index, String name) Adds a child navigation that will be added to the specified position among the ordered children list.
Navigation	addChild(String name) Adds a child navigation that will be added to the last position among the ordered children list.
void	destroy() Destroys this navigation.
Navigation	getChild(String name) Returns a specified navigation.
List<Navigation>	getChildren() Returns the child navigations.
int	getIndex() Returns the index of this navigation.
Link	getLink() Returns the current link related to this navitation object.
String	getName() Returns the navigation name.
ObjectType<? extends Navigation>	getObjectType() Extends the object type to navigation.
Navigation	getParent() Return the navigation parent or null if it is a root.
Site	getSite() Returns the site this navigation belongs to
Templatized	getTemplatized() Returns the templatized aspect of this navigation when it exists.
<L extends Link> L	linkTo(ObjectType<L> linkType) Link the navigation to a specifed type and returns the corresponding link subclass that allows the configuration of the link.
void	setName(String name) Update the navigation name.

Methods inherited from interface org.gatein.mop.api.workspace.WorkspaceObject

getAttributes, getObjectId

Methods inherited from interface org.gatein.mop.api.Adaptable

adapt, isAdapted, removeAdapter

Method Detail

getName

String getName()

Returns the navigation name.

Returns:

the navigation name

setName

void setName(String name)

Update the navigation name.

Parameters:

name - the new navigation name

getIndex

int getIndex()

Returns the index of this navigation.

Returns:

the navigation index

getObjectType

ObjectType<? extends Navigation> getObjectType()

Extends the object type to navigation.

Specified by:

getObjectType in interface WorkspaceObject

Returns:

the object type

getSite

Site getSite()

Returns the site this navigation belongs to

Returns:

the site

getParent

Navigation getParent()

Return the navigation parent or null if it is a root.

Returns:

the navigation parent

getChildren

List<Navigation> getChildren()

Returns the child navigations.

Returns:

the child navigations

getChild

Navigation getChild(String name)

Returns a specified navigation.

Parameters:

name - the navigation name

Returns:

a child navigation

addChild

Navigation addChild(String name)
                    throws NullPointerException,
                           IllegalArgumentException

Adds a child navigation that will be added to the last position among the ordered children list.

Parameters:

name - the child name

Returns:

the child navigation

Throws:

NullPointerException - when a null name is provided

IllegalArgumentException - when an illegal name is provided

addChild

Navigation addChild(Integer index,
                  String name)
                    throws NullPointerException,
                           IndexOutOfBoundsException,
                           IllegalArgumentException

Adds a child navigation that will be added to the specified position among the ordered children list. When the the index is not specified, the child is appended at the last position.

Parameters:

index - the child index

name - the child name

Returns:

the child navigation

Throws:

NullPointerException - when a null name is provided

IndexOutOfBoundsException - if the index is out of bounds

IllegalArgumentException - when an illegal name is provided

destroy

void destroy()

Destroys this navigation.

getLink

Link getLink()

Returns the current link related to this navitation object.

Returns:

the link

linkTo

<L extends Link> L linkTo(ObjectType<L> linkType)

Link the navigation to a specifed type and returns the corresponding link subclass that allows the configuration of the link.

Type Parameters:

L - the link type parameter

Parameters:

linkType - the link type

Returns:

the link object

getTemplatized

Templatized getTemplatized()

Returns the templatized aspect of this navigation when it exists.

Returns:

the templatized