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

java.lang.Object
  org.apache.maven.doxia.site.decoration.Menu

All Implemented Interfaces:

java.io.Serializable

public class Menu

extends java.lang.Object

implements java.io.Serializable

A menu in the navigation.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Menu()

Method Summary

void	addItem(MenuItem menuItem) Method addItem.
boolean	equals(java.lang.Object other) Method equals.
java.lang.String	getImg() Get The location of an image.
java.lang.String	getInherit() Get The way in which the menu is inherited.
java.util.List	getItems() Method getItems.
java.lang.String	getName() Get The name to display for the menu.
java.lang.String	getRef() Get A reference to a pre-defined menu, such as a reports, modules or parentProject.
int	hashCode() Method hashCode.
boolean	isInheritAsRef() Get If this is a reference, setting true means that it will be populated in the project, whereas if it is false, it is populated in the parent and then inherited.
void	removeItem(MenuItem menuItem) Method removeItem.
void	setImg(java.lang.String img) Set The location of an image.
void	setInherit(java.lang.String inherit) Set The way in which the menu is inherited.
void	setInheritAsRef(boolean inheritAsRef) Set If this is a reference, setting true means that it will be populated in the project, whereas if it is false, it is populated in the parent and then inherited.
void	setItems(java.util.List items) Set A list of menu item.
void	setName(java.lang.String name) Set The name to display for the menu.
void	setRef(java.lang.String ref) Set A reference to a pre-defined menu, such as a reports, modules or parentProject.
java.lang.String	toString() Method toString.

Methods inherited from class java.lang.Object

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

Constructor Detail

Menu

public Menu()

Method Detail

addItem

public void addItem(MenuItem menuItem)

Method addItem.

Parameters:

menuItem -

equals

public boolean equals(java.lang.Object other)

Method equals.

Parameters:

other -

Returns:

boolean

getImg

public java.lang.String getImg()

Get The location of an image.

Returns:

String

getInherit

public java.lang.String getInherit()

Get The way in which the menu is inherited. Can be one of : top, bottom.

Returns:

String

getItems

public java.util.List getItems()

Method getItems.

Returns:

List

getName

public java.lang.String getName()

Get The name to display for the menu.

Returns:

String

getRef

public java.lang.String getRef()

Get A reference to a pre-defined menu, such as a reports, modules or parentProject.

Returns:

String

hashCode

public int hashCode()

Method hashCode.

Returns:

int

isInheritAsRef

public boolean isInheritAsRef()

Get If this is a reference, setting true means that it will be populated in the project, whereas if it is false, it is populated in the parent and then inherited.

Returns:

boolean

removeItem

public void removeItem(MenuItem menuItem)

Method removeItem.

Parameters:

menuItem -

setImg

public void setImg(java.lang.String img)

Set The location of an image.

Parameters:

img -

setInherit

public void setInherit(java.lang.String inherit)

Set The way in which the menu is inherited. Can be one of : top, bottom.

Parameters:

inherit -

setInheritAsRef

public void setInheritAsRef(boolean inheritAsRef)

Set If this is a reference, setting true means that it will be populated in the project, whereas if it is false, it is populated in the parent and then inherited.

Parameters:

inheritAsRef -

setItems

public void setItems(java.util.List items)

Set A list of menu item.

Parameters:

items -

setName

public void setName(java.lang.String name)

Set The name to display for the menu.

Parameters:

name -

setRef

public void setRef(java.lang.String ref)

Set A reference to a pre-defined menu, such as a reports, modules or parentProject.

Parameters:

ref -

toString

public java.lang.String toString()

Method toString.

Returns:

String