org.apache.maven.doxia.document
Class DocumentTOC

java.lang.Object
  org.apache.maven.doxia.document.DocumentTOC

All Implemented Interfaces:

java.io.Serializable

public class DocumentTOC
extends java.lang.Object
implements java.io.Serializable

A Table Of Content for the document.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

DocumentTOC()

Method Summary

void	addItem(DocumentTOCItem documentTOCItem) Method addItem
boolean	equals(java.lang.Object other) Method equals
int	getDepth() Get The level up to which toc items are included by default.
java.util.List	getItems() Method getItems
java.lang.String	getModelEncoding()
java.lang.String	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(java.util.List items) Set TOC item.
void	setModelEncoding(java.lang.String modelEncoding)
void	setName(java.lang.String name) Set The name to use for the Table of Contents.
java.lang.String	toString() Method toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentTOC

public DocumentTOC()

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 class java.lang.Object

Parameters:

other -

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.

getItems

public java.util.List getItems()

Method getItems

getName

public java.lang.String getName()

Get The name to use for the Table of Contents.

hashCode

public int hashCode()

Method hashCode

Overrides:

hashCode in class java.lang.Object

removeItem

public void removeItem(DocumentTOCItem documentTOCItem)

Method removeItem

Parameters:

documentTOCItem -

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 -

setItems

public void setItems(java.util.List items)

Set TOC item.

Parameters:

items -

setName

public void setName(java.lang.String name)

Set The name to use for the Table of Contents.

Parameters:

name -

toString

public java.lang.String toString()

Method toString

Overrides:

toString in class java.lang.Object

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)

getModelEncoding

public java.lang.String getModelEncoding()