Package org.apache.maven.doxia.site
Class Menu
java.lang.Object
org.apache.maven.doxia.site.Menu
- All Implemented Interfaces:
Serializable
,Cloneable
A menu in the navigation.
- Version:
- $Revision$ $Date$
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Method addItem.clone()
Method clone.boolean
Method equals.getImage()
Get the image for the menu.Get the way in which the menu is inherited.getItems()
Method getItems.getName()
Get the name to display for the menu.getRef()
Get mark this menu as reference to a pre-defined menu:reports
,modules
orparent
.int
hashCode()
Method hashCode.boolean
Get if this is a reference, setting totrue
means that it will be populated in the site, whereas if it isfalse
, it is populated in the parent and then inherited.void
removeItem
(MenuItem menuItem) Method removeItem.void
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 totrue
means that it will be populated in the site, whereas if it isfalse
, it is populated in the parent and then inherited.void
Set a list of menu item.void
Set the name to display for the menu.void
Set mark this menu as reference to a pre-defined menu:reports
,modules
orparent
.toString()
Method toString.
-
Constructor Details
-
Menu
public Menu()
-
-
Method Details
-
addItem
Method addItem.- Parameters:
menuItem
- a menuItem object.
-
clone
Method clone. -
equals
Method equals. -
getImage
Get the image for the menu.- Returns:
- Image
-
getInherit
Get the way in which the menu is inherited. Can be one of :top
,bottom
.- Returns:
- String
-
getItems
Method getItems.- Returns:
- List
-
getName
Get the name to display for the menu.- Returns:
- String
-
getRef
Get mark this menu as reference to a pre-defined menu:reports
,modules
orparent
. It will be populated at runtime with corresponding pre-defined content.- Returns:
- String
-
hashCode
public int hashCode()Method hashCode. -
isInheritAsRef
public boolean isInheritAsRef()Get if this is a reference, setting totrue
means that it will be populated in the site, whereas if it isfalse
, it is populated in the parent and then inherited.- Returns:
- boolean
-
removeItem
Method removeItem.- Parameters:
menuItem
- a menuItem object.
-
setImage
Set the image for the menu.- Parameters:
image
- a image object.
-
setInherit
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 totrue
means that it will be populated in the site, whereas if it isfalse
, it is populated in the parent and then inherited.- Parameters:
inheritAsRef
- a inheritAsRef object.
-
setItems
Set a list of menu item.- Parameters:
items
- a items object.
-
setName
Set the name to display for the menu.- Parameters:
name
- a name object.
-
setRef
Set mark this menu as reference to a pre-defined menu:reports
,modules
orparent
. It will be populated at runtime with corresponding pre-defined content.- Parameters:
ref
- a ref object.
-
toString
Method toString.
-