Class Menu
java.lang.Object
org.apache.maven.doxia.site.decoration.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.getAlt()
Get the alt description for the image.Get the border to use for the menu image.Get the height to use for the menu image.getImg()
Get the source location of an menu image.Get the way in which the menu is inherited.getItems()
Method getItems.getName()
Get the name to display for the menu.Get where to place the image regarding the displayed name (left or right).getRef()
Get mark this menu as reference to a pre-defined menu:reports
,modules
orparent
.getTitle()
Get the title for the image.getWidth()
Get the width to use for the menu image.int
hashCode()
Method hashCode.boolean
Get if this is a reference, setting <inheritAsRef>true</inheritAsRef> 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
Set the alt description for the image.void
Set the border to use for the menu image.void
Set the height to use for the menu image.void
Set the source location of an menu image.void
setInherit
(String inherit) Set the way in which the menu is inherited.void
setInheritAsRef
(boolean inheritAsRef) Set if this is a reference, setting <inheritAsRef>true</inheritAsRef> means that it will be populated in the project, whereas if it is false, 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
setPosition
(String position) Set where to place the image regarding the displayed name (left or right).void
Set mark this menu as reference to a pre-defined menu:reports
,modules
orparent
.void
Set the title for the image.void
Set the width to use for the menu image.toString()
Method toString.
-
Constructor Details
-
Menu
public Menu()
-
-
Method Details
-
addItem
Method addItem.- Parameters:
menuItem
- a menuItem object.
-
clone
Method clone. -
equals
Method equals. -
getAlt
Get the alt description for the image.- Returns:
- String
-
getBorder
Get the border to use for the menu image.- Returns:
- String
-
getHeight
Get the height to use for the menu image.- Returns:
- String
-
getImg
Get the source location of an menu image.- Returns:
- String
-
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
-
getPosition
Get where to place the image regarding the displayed name (left or right).- 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
-
getTitle
Get the title for the image.- Returns:
- String
-
getWidth
Get the width to use for the menu image.- Returns:
- String
-
hashCode
public int hashCode()Method hashCode. -
isInheritAsRef
public boolean isInheritAsRef()Get if this is a reference, setting <inheritAsRef>true</inheritAsRef> 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
Method removeItem.- Parameters:
menuItem
- a menuItem object.
-
setAlt
Set the alt description for the image.- Parameters:
alt
- a alt object.
-
setBorder
Set the border to use for the menu image.- Parameters:
border
- a border object.
-
setHeight
Set the height to use for the menu image.- Parameters:
height
- a height object.
-
setImg
Set the source location of an menu image.- Parameters:
img
- a img 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 <inheritAsRef>true</inheritAsRef> 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
- 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.
-
setPosition
Set where to place the image regarding the displayed name (left or right).- Parameters:
position
- a position 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.
-
setTitle
Set the title for the image.- Parameters:
title
- a title object.
-
setWidth
Set the width to use for the menu image.- Parameters:
width
- a width object.
-
toString
Method toString.
-