net.ontopia.topicmaps.nav2.portlets.pojos

Class Menu.Heading

java.lang.Object

net.ontopia.topicmaps.nav2.portlets.pojos.Menu.Heading

All Implemented Interfaces:

Menu.ChildIF, Menu.MenuObjectIF, Menu.ParentIF

Enclosing class:

Menu

public static class Menu.Heading
extends Object
implements Menu.ChildIF, Menu.ParentIF

Field Summary

Fields

Modifier and Type	Field and Description
protected List	children

Constructor Summary

Constructors

Constructor and Description
Heading(TopicIF topic)

Method Summary

Modifier and Type	Method and Description
Menu.Heading	createHeading(String title) Create new Heading as child of this Heading
Menu.Item	createItem(String title) Create new Item as child of this Heading.
void	delete() Delete this Heading with all its descendants.
List	getChildren() Get the children of this Heading.
boolean	getHasChildren() Check if this Heading has children.
boolean	getIsHeading() Check whether this is a Heading.
boolean	getIsItem() Check whether this is an Item.
String	getTitle() The title of this Heading as a String.
TopicIF	getTopic() Get the topic of this Heading.
void	moveOneDown() Moves this Heading one step down the list of children on its parent.
void	moveOneUp() Moves this Heading one step up the list of children on its parent.
void	setTitle(String title) Sets the title of this Heading.

Methods inherited from class java.lang.Object

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

Field Detail

children

protected List children

Constructor Detail

Heading

public Heading(TopicIF topic)

Method Detail

getIsHeading

public boolean getIsHeading()

Check whether this is a Heading.

Specified by:

getIsHeading in interface Menu.ChildIF

Returns:

true, since it is a Heading.

getIsItem

public boolean getIsItem()

Check whether this is an Item.

Specified by:

getIsItem in interface Menu.ChildIF

Returns:

false, since it is not an Item.

getTitle

public String getTitle()

The title of this Heading as a String.

Specified by:

getTitle in interface Menu.MenuObjectIF

getTopic

public TopicIF getTopic()

Get the topic of this Heading.

Specified by:

getTopic in interface Menu.MenuObjectIF

getChildren

public List getChildren()

Get the children of this Heading.

Specified by:

getChildren in interface Menu.ParentIF

getHasChildren

public boolean getHasChildren()

Check if this Heading has children.

Specified by:

getHasChildren in interface Menu.MenuObjectIF

setTitle

public void setTitle(String title)

Sets the title of this Heading.

Specified by:

setTitle in interface Menu.MenuObjectIF

moveOneUp

public void moveOneUp()

Moves this Heading one step up the list of children on its parent. has no effect if it is already first

Specified by:

moveOneUp in interface Menu.ChildIF

moveOneDown

public void moveOneDown()

Moves this Heading one step down the list of children on its parent. Has no effect if it is already last.

Specified by:

moveOneDown in interface Menu.ChildIF

createHeading

public Menu.Heading createHeading(String title)

Create new Heading as child of this Heading

Specified by:

createHeading in interface Menu.ParentIF

Returns:

The heading that was created.

createItem

public Menu.Item createItem(String title)

Create new Item as child of this Heading.

Specified by:

createItem in interface Menu.ParentIF

Returns:

The item that was created.

delete

public void delete()

Delete this Heading with all its descendants.

Specified by:

delete in interface Menu.MenuObjectIF