Package org.dashbuilder.navigation

Interface NavItem

All Known Subinterfaces:

NavDivider, NavGroup

All Known Implementing Classes:

NavDividerImpl, NavGroupImpl, NavItemImpl

public interface NavItem

A navigation item is a way to classify different assets, like for instance, perspectives. A tag can be referenced by other tags, either as a parent or as a child. The links between different tags creates a NavTree structure that can be used to provide navigation services across the different assets referenced by the tags in the tree.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	NavItem.Type

Method Summary

Modifier and Type	Method	Description
void	accept(NavItemVisitor visitor)	Entry point for visitor interfaces
NavItem	cloneItem()	Creates a brand new copy of this item
String	getContext()	An optional string that can be used to attach contextual information, like an external reference for instance.
String	getDescription()	A brief description of the item (optional, if not provided the name is used instead)
String	getId()	A unique id within the same NavTree
String	getName()	The item's name
NavGroup	getParent()	Get the parent of this item (if any)
NavItem.Type	getType()	The item's NavItem.Type
boolean	isModifiable()	Flag indicating if the item can be modified from a tree once added
void	setContext(String ctx)	Change the item's context attribute
void	setDescription(String description)	Change the item's description
void	setId(String id)	Change the item's id
void	setModifiable(boolean modifiable)	Change the item's modifiable flag
void	setName(String name)	Change the item's name
void	setParent(NavGroup parent)	Change the item's parent

Method Detail

getId

String getId()

A unique id within the same NavTree

setId

void setId(String id)

Change the item's id

getName

String getName()

The item's name

setName

void setName(String name)

Change the item's name

getDescription

String getDescription()

A brief description of the item (optional, if not provided the name is used instead)

setDescription

void setDescription(String description)

Change the item's description

getType

NavItem.Type getType()

The item's NavItem.Type

getParent

NavGroup getParent()

Get the parent of this item (if any)

Returns:

The item this one is a child of. Or null if this is a root item

setParent

void setParent(NavGroup parent)

Change the item's parent

isModifiable

boolean isModifiable()

Flag indicating if the item can be modified from a tree once added

setModifiable

void setModifiable(boolean modifiable)

Change the item's modifiable flag

getContext

String getContext()

An optional string that can be used to attach contextual information, like an external reference for instance.

setContext

void setContext(String ctx)

Change the item's context attribute

accept

void accept(NavItemVisitor visitor)

Entry point for visitor interfaces

cloneItem

NavItem cloneItem()

Creates a brand new copy of this item