Package org.apache.maven.doxia.site
Class MenuItem
java.lang.Object
org.apache.maven.doxia.site.LinkItem
org.apache.maven.doxia.site.MenuItem
- All Implemented Interfaces:
Serializable
,Cloneable
A menu item.
- Version:
- $Revision$ $Date$
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Method addItem.clone()
Method clone.boolean
Method equals.getItems()
Method getItems.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
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
Set a list of menu item.void
Set a reference to a pre-defined menu item, such as a report (specified by the report goal name).toString()
Method toString.
-
Constructor Details
-
MenuItem
public MenuItem()
-
-
Method Details
-
addItem
Method addItem.- Parameters:
menuItem
- a menuItem object.
-
clone
Method clone. -
equals
Method equals. -
getItems
Method getItems.- Returns:
- List
-
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
-
hashCode
public int hashCode()Method hashCode. -
isCollapse
public boolean isCollapse()Get whether to collapse children elements of an item menu (by default).- Returns:
- boolean
-
removeItem
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.
-
setItems
Set a list of menu item.- Parameters:
items
- a items object.
-
setRef
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.
-
toString
Method toString.
-