org.apache.maven.doxia.site.decoration
Class MenuItem

java.lang.Object
  org.apache.maven.doxia.site.decoration.LinkItem
      org.apache.maven.doxia.site.decoration.MenuItem

All Implemented Interfaces:

java.io.Serializable

public class MenuItem

extends LinkItem

implements java.io.Serializable

A menu item.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

MenuItem()

Method Summary

void	addItem(MenuItem menuItem) Method addItem
void	breakMenuItemAssociation(MenuItem menuItem) Method breakMenuItemAssociation
void	createMenuItemAssociation(MenuItem menuItem) Method createMenuItemAssociation
boolean	equals(java.lang.Object other) Method equals
java.lang.String	getDescription() Get A description of the menu item.
java.util.List	getItems() Method getItems
java.lang.String	getModelEncoding()
java.lang.String	getRef() Get A reference to a pre-defined menu item, such as a report (specified by the report goal name).
int	hashCode() Method hashCode
boolean	isCollapse() Get Whether to collapse children elements of an item menu (by default).
void	removeItem(MenuItem menuItem) Method removeItem
void	setCollapse(boolean collapse) Set Whether to collapse children elements of an item menu (by default).
void	setDescription(java.lang.String description) Set A description of the menu item.
void	setItems(java.util.List items) Set Menu item.
void	setModelEncoding(java.lang.String modelEncoding)
void	setRef(java.lang.String ref) Set A reference to a pre-defined menu item, such as a report (specified by the report goal name).
java.lang.String	toString() Method toString

Methods inherited from class org.apache.maven.doxia.site.decoration.LinkItem

getHref, getName, setHref, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

MenuItem

public MenuItem()

Method Detail

addItem

public void addItem(MenuItem menuItem)

Method addItem

Parameters:

menuItem -

breakMenuItemAssociation

public void breakMenuItemAssociation(MenuItem menuItem)

Method breakMenuItemAssociation

Parameters:

menuItem -

createMenuItemAssociation

public void createMenuItemAssociation(MenuItem menuItem)

Method createMenuItemAssociation

Parameters:

menuItem -

equals

public boolean equals(java.lang.Object other)

Method equals

Overrides:

equals in class LinkItem

Parameters:

other -

getDescription

public java.lang.String getDescription()

Get A description of the menu item. This is used on any summary pages for a menu.

getItems

public java.util.List getItems()

Method getItems

getRef

public java.lang.String getRef()

Get A reference to a pre-defined menu item, such as a report (specified by the report goal name). Any elements explicitly given override those from the pre-defined reference.

hashCode

public int hashCode()

Method hashCode

Overrides:

hashCode in class LinkItem

isCollapse

public boolean isCollapse()

Get Whether to collapse children elements of an item menu (by default).

removeItem

public void removeItem(MenuItem menuItem)

Method removeItem

Parameters:

menuItem -

setCollapse

public void setCollapse(boolean collapse)

Set Whether to collapse children elements of an item menu (by default).

Parameters:

collapse -

setDescription

public void setDescription(java.lang.String description)

Set A description of the menu item. This is used on any summary pages for a menu.

Parameters:

description -

setItems

public void setItems(java.util.List items)

Set Menu item.

Parameters:

items -

setRef

public void setRef(java.lang.String ref)

Set A reference to a pre-defined menu item, such as a report (specified by the report goal name). Any elements explicitly given override those from the pre-defined reference.

Parameters:

ref -

toString

public java.lang.String toString()

Method toString

Overrides:

toString in class LinkItem

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)

Overrides:

setModelEncoding in class LinkItem

getModelEncoding

public java.lang.String getModelEncoding()

Overrides:

getModelEncoding in class LinkItem