Package org.apache.maven.doxia.document
Class DocumentTOC
java.lang.Object
org.apache.maven.doxia.document.DocumentTOC
- All Implemented Interfaces:
Serializable
A Table Of Content for the document.
- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addItem
(DocumentTOCItem documentTOCItem) Method addItem.boolean
Method equals.int
getDepth()
Get the level up to which toc items are included by default.getItems()
Method getItems.getName()
Get the name to use for the Table of Contents.int
hashCode()
Method hashCode.void
removeItem
(DocumentTOCItem documentTOCItem) Method removeItem.void
setDepth
(int depth) Set the level up to which toc items are included by default.void
setItems
(List<DocumentTOCItem> items) Set tOC item.void
Set the name to use for the Table of Contents.toString()
Method toString.
-
Field Details
-
name
The name to use for the Table of Contents. -
depth
private int depthThe level up to which toc items are included by default. Defaults to 0 which means only top-level element entries are included. A depth of 1 includes one level of sub-items (sub-sections), etc. This may be overridden for individual entries by using the collapse attribute of the corresponding toc item. -
items
Field items.
-
-
Constructor Details
-
DocumentTOC
public DocumentTOC()
-
-
Method Details
-
addItem
Method addItem.- Parameters:
documentTOCItem
- a documentTOCItem object.
-
equals
Method equals. -
getDepth
public int getDepth()Get the level up to which toc items are included by default. Defaults to 0 which means only top-level element entries are included. A depth of 1 includes one level of sub-items (sub-sections), etc. This may be overridden for individual entries by using the collapse attribute of the corresponding toc item.- Returns:
- int
-
getItems
Method getItems.- Returns:
- List
-
getName
Get the name to use for the Table of Contents.- Returns:
- String
-
hashCode
public int hashCode()Method hashCode. -
removeItem
Method removeItem.- Parameters:
documentTOCItem
- a documentTOCItem object.
-
setDepth
public void setDepth(int depth) Set the level up to which toc items are included by default. Defaults to 0 which means only top-level element entries are included. A depth of 1 includes one level of sub-items (sub-sections), etc. This may be overridden for individual entries by using the collapse attribute of the corresponding toc item.- Parameters:
depth
- a depth object.
-
setItems
Set tOC item.- Parameters:
items
- a items object.
-
setName
Set the name to use for the Table of Contents.- Parameters:
name
- a name object.
-
toString
Method toString.
-