org.apache.maven.doxia.site

Class Menu

java.lang.Object

org.apache.maven.doxia.site.Menu

All Implemented Interfaces:

Serializable, Cloneable

public class Menu
extends Object
implements Serializable, Cloneable

A menu in the navigation.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Menu()

Method Summary

Modifier and Type	Method and Description
void	addItem(MenuItem menuItem) Method addItem.
Menu	clone() Method clone.
boolean	equals(Object other) Method equals.
Image	getImage() Get the image for the menu.
String	getInherit() Get the way in which the menu is inherited.
List<MenuItem>	getItems() Method getItems.
String	getName() Get the name to display for the menu.
String	getRef() Get mark this menu as reference to a pre-defined menu: reports, modules or parent.
int	hashCode() Method hashCode.
boolean	isInheritAsRef() Get if this is a reference, setting to true means that it will be populated in the site, whereas if it is false, it is populated in the parent and then inherited.
void	removeItem(MenuItem menuItem) Method removeItem.
void	setImage(Image image) Set the image for the menu.
void	setInherit(String inherit) Set the way in which the menu is inherited.
void	setInheritAsRef(boolean inheritAsRef) Set if this is a reference, setting to true means that it will be populated in the site, whereas if it is false, it is populated in the parent and then inherited.
void	setItems(List<MenuItem> items) Set a list of menu item.
void	setName(String name) Set the name to display for the menu.
void	setRef(String ref) Set mark this menu as reference to a pre-defined menu: reports, modules or parent.
String	toString() Method toString.

Methods inherited from class java.lang.Object

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

Constructor Detail

Menu

public Menu()

Method Detail

addItem

public void addItem(MenuItem menuItem)

Method addItem.

Parameters:

menuItem - a menuItem object.

clone

public Menu clone()

Method clone.

Overrides:

clone in class Object

Returns:

Menu

equals

public boolean equals(Object other)

Method equals.

Overrides:

equals in class Object

Parameters:

other - a other object.

Returns:

boolean

getImage

public Image getImage()

Get the image for the menu.

Returns:

Image

getInherit

public String getInherit()

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

Returns:

String

getItems

public List<MenuItem> getItems()

Method getItems.

Returns:

List

getName

public String getName()

Get the name to display for the menu.

Returns:

String

getRef

public String getRef()

Get mark this menu as reference to a pre-defined menu: reports, modules or parent. It will be populated at runtime with corresponding pre-defined content.

Returns:

String

hashCode

public int hashCode()

Method hashCode.

Overrides:

hashCode in class Object

Returns:

int

isInheritAsRef

public boolean isInheritAsRef()

Get if this is a reference, setting to true means that it will be populated in the site, 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 - a menuItem object.

setImage

public void setImage(Image image)

Set the image for the menu.

Parameters:

image - a image object.

setInherit

public void setInherit(String inherit)

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

Parameters:

inherit - a inherit object.

setInheritAsRef

public void setInheritAsRef(boolean inheritAsRef)

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

Parameters:

inheritAsRef - a inheritAsRef object.

setItems

public void setItems(List<MenuItem> items)

Set a list of menu item.

Parameters:

items - a items object.

setName

public void setName(String name)

Set the name to display for the menu.

Parameters:

name - a name object.

setRef

public void setRef(String ref)

Set mark this menu as reference to a pre-defined menu: reports, modules or parent. It will be populated at runtime with corresponding pre-defined content.

Parameters:

ref - a ref object.

toString

public String toString()

Method toString.

Overrides:

toString in class Object

Returns:

String