org.dashbuilder.navigation.impl

Class NavItemImpl

java.lang.Object

org.dashbuilder.navigation.impl.NavItemImpl

All Implemented Interfaces:

NavItem

Direct Known Subclasses:

NavDividerImpl, NavGroupImpl

@Portable
public class NavItemImpl
extends Object
implements NavItem

Nested Class Summary

Nested classes/interfaces inherited from interface org.dashbuilder.navigation.NavItem

NavItem.Type

Constructor Summary

Constructors

Constructor and Description
NavItemImpl()
NavItemImpl(String id, String name, String description, NavGroup parent, boolean modifiable, String context)

Method Summary

Modifier and Type	Method and Description
void	accept(NavItemVisitor visitor) Entry point for visitor interfaces
NavItem	cloneItem() Creates a brand new copy of this item
boolean	equals(Object obj)
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 context) 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
String	toString()
String	toString(String type)

Methods inherited from class java.lang.Object

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

Constructor Detail

NavItemImpl

public NavItemImpl()

NavItemImpl

public NavItemImpl(String id,
                   String name,
                   String description,
                   NavGroup parent,
                   boolean modifiable,
                   String context)

Method Detail

getId

public String getId()

Description copied from interface: NavItem

A unique id within the same NavTree

Specified by:

getId in interface NavItem

setId

public void setId(String id)

Description copied from interface: NavItem

Change the item's id

Specified by:

setId in interface NavItem

getName

public String getName()

Description copied from interface: NavItem

The item's name

Specified by:

getName in interface NavItem

setName

public void setName(String name)

Description copied from interface: NavItem

Change the item's name

Specified by:

setName in interface NavItem

getDescription

public String getDescription()

Description copied from interface: NavItem

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

Specified by:

getDescription in interface NavItem

setDescription

public void setDescription(String description)

Description copied from interface: NavItem

Change the item's description

Specified by:

setDescription in interface NavItem

getType

public NavItem.Type getType()

Description copied from interface: NavItem

The item's NavItem.Type

Specified by:

getType in interface NavItem

getParent

public NavGroup getParent()

Description copied from interface: NavItem

Get the parent of this item (if any)

Specified by:

getParent in interface NavItem

Returns:

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

setParent

public void setParent(NavGroup parent)

Description copied from interface: NavItem

Change the item's parent

Specified by:

setParent in interface NavItem

isModifiable

public boolean isModifiable()

Description copied from interface: NavItem

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

Specified by:

isModifiable in interface NavItem

setModifiable

public void setModifiable(boolean modifiable)

Description copied from interface: NavItem

Change the item's modifiable flag

Specified by:

setModifiable in interface NavItem

accept

public void accept(NavItemVisitor visitor)

Description copied from interface: NavItem

Entry point for visitor interfaces

Specified by:

accept in interface NavItem

getContext

public String getContext()

Description copied from interface: NavItem

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

Specified by:

getContext in interface NavItem

setContext

public void setContext(String context)

Description copied from interface: NavItem

Change the item's context attribute

Specified by:

setContext in interface NavItem

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

cloneItem

public NavItem cloneItem()

Description copied from interface: NavItem

Creates a brand new copy of this item

Specified by:

cloneItem in interface NavItem

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(String type)