Class Menu
- java.lang.Object
-
- org.apache.maven.doxia.site.decoration.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 Description Menu()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addItem(MenuItem menuItem)
Method addItem.Menu
clone()
Method clone.boolean
equals(Object other)
Method equals.String
getAlt()
Get the alt description for the image.String
getBorder()
Get the border to use for the menu image.String
getHeight()
Get the height to use for the menu image.String
getImg()
Get the source location of an menu image.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
getPosition()
Get where to place the image regarding the displayed name (left or right).String
getRef()
Get mark this menu as reference to a pre-defined menu:reports
,modules
orparent
.String
getTitle()
Get the title for the image.String
getWidth()
Get the width to use for the menu image.int
hashCode()
Method hashCode.boolean
isInheritAsRef()
Get if this is a reference, setting totrue
means that it will be populated in the project, whereas if it isfalse
, it is populated in the parent and then inherited.void
removeItem(MenuItem menuItem)
Method removeItem.void
setAlt(String alt)
Set the alt description for the image.void
setBorder(String border)
Set the border to use for the menu image.void
setHeight(String height)
Set the height to use for the menu image.void
setImg(String img)
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 totrue
means that it will be populated in the project, whereas if it isfalse
, 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
setPosition(String position)
Set where to place the image regarding the displayed name (left or right).void
setRef(String ref)
Set mark this menu as reference to a pre-defined menu:reports
,modules
orparent
.void
setTitle(String title)
Set the title for the image.void
setWidth(String width)
Set the width to use for the menu image.String
toString()
Method toString.
-
-
-
Method Detail
-
addItem
public void addItem(MenuItem menuItem)
Method addItem.- Parameters:
menuItem
- a menuItem object.
-
equals
public boolean equals(Object other)
Method equals.
-
getAlt
public String getAlt()
Get the alt description for the image.- Returns:
- String
-
getBorder
public String getBorder()
Get the border to use for the menu image.- Returns:
- String
-
getHeight
public String getHeight()
Get the height to use for the menu image.- Returns:
- String
-
getImg
public String getImg()
Get the source location of an menu image.- Returns:
- String
-
getInherit
public String getInherit()
Get the way in which the menu is inherited. Can be one of :top
,bottom
.- Returns:
- String
-
getName
public String getName()
Get the name to display for the menu.- Returns:
- String
-
getPosition
public String getPosition()
Get where to place the image regarding the displayed name (left or right).- Returns:
- String
-
getRef
public 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
public String getTitle()
Get the title for the image.- Returns:
- String
-
getWidth
public String getWidth()
Get the width to use for the menu image.- Returns:
- String
-
isInheritAsRef
public boolean isInheritAsRef()
Get if this is a reference, setting totrue
means that it will be populated in the project, whereas if it isfalse
, it is populated in the parent and then inherited.- Returns:
- boolean
-
removeItem
public void removeItem(MenuItem menuItem)
Method removeItem.- Parameters:
menuItem
- a menuItem object.
-
setAlt
public void setAlt(String alt)
Set the alt description for the image.- Parameters:
alt
- a alt object.
-
setBorder
public void setBorder(String border)
Set the border to use for the menu image.- Parameters:
border
- a border object.
-
setHeight
public void setHeight(String height)
Set the height to use for the menu image.- Parameters:
height
- a height object.
-
setImg
public void setImg(String img)
Set the source location of an menu image.- Parameters:
img
- a img 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 totrue
means that it will be populated in the project, whereas if it isfalse
, 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.
-
setPosition
public void setPosition(String position)
Set where to place the image regarding the displayed name (left or right).- Parameters:
position
- a position object.
-
setRef
public void setRef(String ref)
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
public void setTitle(String title)
Set the title for the image.- Parameters:
title
- a title object.
-
setWidth
public void setWidth(String width)
Set the width to use for the menu image.- Parameters:
width
- a width object.
-
-