Package org.apache.maven.doxia.document
Class DocumentTOCItem
java.lang.Object
org.apache.maven.doxia.document.DocumentTOCItem
- All Implemented Interfaces:
Serializable
A menu item.
- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddItem(DocumentTOCItem documentTOCItem) Method addItem.booleanMethod equals.getItems()Method getItems.getName()Get the name to use for the toc.getRef()Get the ref to use for the item.inthashCode()Method hashCode.booleanGet whether to show any child elements of a TOCItem, overriding the depth given in DocumentTOC.voidremoveItem(DocumentTOCItem documentTOCItem) Method removeItem.voidsetCollapse(boolean collapse) Set whether to show any child elements of a TOCItem, overriding the depth given in DocumentTOC.voidsetItems(List<DocumentTOCItem> items) Set a table of content item containing sub-items.voidSet the name to use for the toc.voidSet the ref to use for the item.toString()Method toString.
-
Field Details
-
name
The name to use for the toc. -
ref
The ref to use for the item. -
collapse
private boolean collapseWhether 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
Field items.
-
-
Constructor Details
-
DocumentTOCItem
public DocumentTOCItem()
-
-
Method Details
-
addItem
Method addItem.- Parameters:
documentTOCItem- a documentTOCItem object.
-
equals
Method equals. -
getItems
Method getItems.- Returns:
- List
-
getName
Get the name to use for the toc.- Returns:
- String
-
getRef
Get the ref to use for the item.- Returns:
- String
-
hashCode
public int hashCode()Method hashCode. -
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
Method removeItem.- Parameters:
documentTOCItem- a documentTOCItem object.
-
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- a collapse object.
-
setItems
Set a table of content item containing sub-items.- Parameters:
items- a items object.
-
setName
Set the name to use for the toc.- Parameters:
name- a name object.
-
setRef
Set the ref to use for the item.- Parameters:
ref- a ref object.
-
toString
Method toString.
-