Package org.apache.maven.doxia.document
Class DocumentTOCItem
- java.lang.Object
-
- org.apache.maven.doxia.document.DocumentTOCItem
-
- All Implemented Interfaces:
java.io.Serializable
public class DocumentTOCItem extends java.lang.Object implements java.io.Serializable
A menu item.- Version:
- $Revision$ $Date$
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
collapse
Whether to show any child elements of a TOCItem, overriding the depth given in DocumentTOC.private java.util.List<DocumentTOCItem>
items
Field items.private java.lang.String
name
The name to use for the toc.private java.lang.String
ref
The ref to use for the item.
-
Constructor Summary
Constructors Constructor Description DocumentTOCItem()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addItem(DocumentTOCItem documentTOCItem)
Method addItem.boolean
equals(java.lang.Object other)
Method equals.java.util.List<DocumentTOCItem>
getItems()
Method getItems.java.lang.String
getName()
Get the name to use for the toc.java.lang.String
getRef()
Get the ref to use for the item.int
hashCode()
Method hashCode.boolean
isCollapse()
Get whether to show any child elements of a TOCItem, overriding the depth given in DocumentTOC.void
removeItem(DocumentTOCItem documentTOCItem)
Method removeItem.void
setCollapse(boolean collapse)
Set whether to show any child elements of a TOCItem, overriding the depth given in DocumentTOC.void
setItems(java.util.List<DocumentTOCItem> items)
Set a table of content item containing sub-items.void
setName(java.lang.String name)
Set the name to use for the toc.void
setRef(java.lang.String ref)
Set the ref to use for the item.java.lang.String
toString()
Method toString.
-
-
-
Field Detail
-
name
private java.lang.String name
The name to use for the toc.
-
ref
private java.lang.String ref
The ref to use for the item.
-
collapse
private boolean collapse
Whether to show any child elements of a TOCItem, overriding the depth given in DocumentTOC. By default, all children are expanded up to the depth given in DocumentTOC.
-
items
private java.util.List<DocumentTOCItem> items
Field items.
-
-
Method Detail
-
addItem
public void addItem(DocumentTOCItem documentTOCItem)
Method addItem.- Parameters:
documentTOCItem
-
-
equals
public boolean equals(java.lang.Object other)
Method equals.- Overrides:
equals
in classjava.lang.Object
- Parameters:
other
-- Returns:
- boolean
-
getItems
public java.util.List<DocumentTOCItem> getItems()
Method getItems.- Returns:
- List
-
getName
public java.lang.String getName()
Get the name to use for the toc.- Returns:
- String
-
getRef
public java.lang.String getRef()
Get the ref to use for the item.- Returns:
- String
-
hashCode
public int hashCode()
Method hashCode.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- int
-
isCollapse
public boolean isCollapse()
Get whether to show any child elements of a TOCItem, overriding the depth given in DocumentTOC. By default, all children are expanded up to the depth given in DocumentTOC.- Returns:
- boolean
-
removeItem
public void removeItem(DocumentTOCItem documentTOCItem)
Method removeItem.- Parameters:
documentTOCItem
-
-
setCollapse
public void setCollapse(boolean collapse)
Set whether to show any child elements of a TOCItem, overriding the depth given in DocumentTOC. By default, all children are expanded up to the depth given in DocumentTOC.- Parameters:
collapse
-
-
setItems
public void setItems(java.util.List<DocumentTOCItem> items)
Set a table of content item containing sub-items.- Parameters:
items
-
-
setName
public void setName(java.lang.String name)
Set the name to use for the toc.- Parameters:
name
-
-
setRef
public void setRef(java.lang.String ref)
Set the ref to use for the item.- Parameters:
ref
-
-
toString
public java.lang.String toString()
Method toString.- Overrides:
toString
in classjava.lang.Object
- Returns:
- String
-
-