Class MenuItem
- java.lang.Object
-
- org.apache.maven.doxia.site.decoration.LinkItem
-
- org.apache.maven.doxia.site.decoration.MenuItem
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class MenuItem extends LinkItem implements Serializable, Cloneable
A menu item.- Version:
- $Revision$ $Date$
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description MenuItem()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addItem(MenuItem menuItem)
Method addItem.MenuItem
clone()
Method clone.boolean
equals(Object other)
Method equals.String
getDescription()
Get a description of the menu item.List<MenuItem>
getItems()
Method getItems.String
getRef()
Get a reference to a pre-defined menu item, such as a report (specified by the report goal name).int
hashCode()
Method hashCode.boolean
isCollapse()
Get whether to collapse children elements of an item menu (by default).void
removeItem(MenuItem menuItem)
Method removeItem.void
setCollapse(boolean collapse)
Set whether to collapse children elements of an item menu (by default).void
setDescription(String description)
Set a description of the menu item.void
setItems(List<MenuItem> items)
Set a list of menu item.void
setRef(String ref)
Set a reference to a pre-defined menu item, such as a report (specified by the report goal name).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.
-
getDescription
public String getDescription()
Get a description of the menu item. This is used on any summary pages for a menu.- Returns:
- String
-
getRef
public String getRef()
Get a reference to a pre-defined menu item, such as a report (specified by the report goal name). Any elements explicitly given override those from the pre-defined reference.- Returns:
- String
-
isCollapse
public boolean isCollapse()
Get whether to collapse children elements of an item menu (by default).- Returns:
- boolean
-
removeItem
public void removeItem(MenuItem menuItem)
Method removeItem.- Parameters:
menuItem
- a menuItem object.
-
setCollapse
public void setCollapse(boolean collapse)
Set whether to collapse children elements of an item menu (by default).- Parameters:
collapse
- a collapse object.
-
setDescription
public void setDescription(String description)
Set a description of the menu item. This is used on any summary pages for a menu.- Parameters:
description
- a description object.
-
setItems
public void setItems(List<MenuItem> items)
Set a list of menu item.- Parameters:
items
- a items object.
-
setRef
public void setRef(String ref)
Set a reference to a pre-defined menu item, such as a report (specified by the report goal name). Any elements explicitly given override those from the pre-defined reference.- Parameters:
ref
- a ref object.
-
-