Class Menu
- java.lang.Object
-
- org.apache.maven.doxia.site.decoration.Menu
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
public class Menu extends java.lang.Object implements java.io.Serializable, java.lang.Cloneable
A menu in the navigation.- Version:
- $Revision$ $Date$
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
alt
The alt description for the image.private java.lang.String
border
The border to use for the menu image.private java.lang.String
height
The height to use for the menu image.private java.lang.String
img
The source location of an menu image.private java.lang.String
inherit
The way in which the menu is inherited.private boolean
inheritAsRef
If this is a reference, settingtrue means that it will be populated in the project, whereas if it is false, it is populated in the parent and then inherited.private java.util.List<MenuItem>
items
Field items.private java.lang.String
name
The name to display for the menu.private java.lang.String
position
Where to place the image regarding the displayed name (left or right).private java.lang.String
ref
Mark this menu as reference to a pre-defined menu:reports
,modules
orparent
.private java.lang.String
title
The title for the image.private java.lang.String
width
The width to use for the menu image.
-
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(java.lang.Object other)
Method equals.java.lang.String
getAlt()
Get the alt description for the image.java.lang.String
getBorder()
Get the border to use for the menu image.java.lang.String
getHeight()
Get the height to use for the menu image.java.lang.String
getImg()
Get the source location of an menu image.java.lang.String
getInherit()
Get the way in which the menu is inherited.java.util.List<MenuItem>
getItems()
Method getItems.java.lang.String
getName()
Get the name to display for the menu.java.lang.String
getPosition()
Get where to place the image regarding the displayed name (left or right).java.lang.String
getRef()
Get mark this menu as reference to a pre-defined menu:reports
,modules
orparent
.java.lang.String
getTitle()
Get the title for the image.java.lang.String
getWidth()
Get the width to use for the menu image.int
hashCode()
Method hashCode.boolean
isInheritAsRef()
Get if this is a reference, settingtrue 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
setAlt(java.lang.String alt)
Set the alt description for the image.void
setBorder(java.lang.String border)
Set the border to use for the menu image.void
setHeight(java.lang.String height)
Set the height to use for the menu image.void
setImg(java.lang.String img)
Set the source location of an menu 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, settingtrue 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<MenuItem> items)
Set a list of menu item.void
setName(java.lang.String name)
Set the name to display for the menu.void
setPosition(java.lang.String position)
Set where to place the image regarding the displayed name (left or right).void
setRef(java.lang.String ref)
Set mark this menu as reference to a pre-defined menu:reports
,modules
orparent
.void
setTitle(java.lang.String title)
Set the title for the image.void
setWidth(java.lang.String width)
Set the width to use for the menu image.java.lang.String
toString()
Method toString.
-
-
-
Field Detail
-
name
private java.lang.String name
The name to display for the menu.
-
inherit
private java.lang.String inherit
The way in which the menu is inherited. Can be one of :top
,bottom
.
-
inheritAsRef
private boolean inheritAsRef
If this is a reference, settingtrue means that it will be populated in the project, whereas if it is false, it is populated in the parent and then inherited.
-
ref
private java.lang.String ref
Mark this menu as reference to a pre-defined menu:reports
,modules
orparent
. It will be populated at runtime with corresponding pre-defined content.
-
img
private java.lang.String img
The source location of an menu image.
-
alt
private java.lang.String alt
The alt description for the image.
-
position
private java.lang.String position
Where to place the image regarding the displayed name (left or right).
-
border
private java.lang.String border
The border to use for the menu image.
-
width
private java.lang.String width
The width to use for the menu image.
-
height
private java.lang.String height
The height to use for the menu image.
-
title
private java.lang.String title
The title for the image.
-
items
private java.util.List<MenuItem> items
Field items.
-
-
Method Detail
-
addItem
public void addItem(MenuItem menuItem)
Method addItem.- Parameters:
menuItem
-
-
clone
public Menu clone()
Method clone.- Overrides:
clone
in classjava.lang.Object
- Returns:
- Menu
-
equals
public boolean equals(java.lang.Object other)
Method equals.- Overrides:
equals
in classjava.lang.Object
- Parameters:
other
-- Returns:
- boolean
-
getAlt
public java.lang.String getAlt()
Get the alt description for the image.- Returns:
- String
-
getBorder
public java.lang.String getBorder()
Get the border to use for the menu image.- Returns:
- String
-
getHeight
public java.lang.String getHeight()
Get the height to use for the menu image.- Returns:
- String
-
getImg
public java.lang.String getImg()
Get the source location of an menu 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<MenuItem> getItems()
Method getItems.- Returns:
- List
-
getName
public java.lang.String getName()
Get the name to display for the menu.- Returns:
- String
-
getPosition
public java.lang.String getPosition()
Get where to place the image regarding the displayed name (left or right).- Returns:
- String
-
getRef
public java.lang.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 java.lang.String getTitle()
Get the title for the image.- Returns:
- String
-
getWidth
public java.lang.String getWidth()
Get the width to use for the menu image.- Returns:
- String
-
hashCode
public int hashCode()
Method hashCode.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- int
-
isInheritAsRef
public boolean isInheritAsRef()
Get if this is a reference, settingtrue 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
-
-
setAlt
public void setAlt(java.lang.String alt)
Set the alt description for the image.- Parameters:
alt
-
-
setBorder
public void setBorder(java.lang.String border)
Set the border to use for the menu image.- Parameters:
border
-
-
setHeight
public void setHeight(java.lang.String height)
Set the height to use for the menu image.- Parameters:
height
-
-
setImg
public void setImg(java.lang.String img)
Set the source location of an menu 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, settingtrue 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<MenuItem> 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
-
-
setPosition
public void setPosition(java.lang.String position)
Set where to place the image regarding the displayed name (left or right).- Parameters:
position
-
-
setRef
public void setRef(java.lang.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
-
-
setTitle
public void setTitle(java.lang.String title)
Set the title for the image.- Parameters:
title
-
-
setWidth
public void setWidth(java.lang.String width)
Set the width to use for the menu image.- Parameters:
width
-
-
toString
public java.lang.String toString()
Method toString.- Overrides:
toString
in classjava.lang.Object
- Returns:
- String
-
-