org.apache.maven.doxia.document
Class DocumentTOCItem

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

Constructor Summary
DocumentTOCItem()
           
 
Method Summary
 void addItem(DocumentTOCItem documentTOCItem)
          Method addItem.
 boolean equals(java.lang.Object other)
          Method equals.
 java.util.List 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 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.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DocumentTOCItem

public DocumentTOCItem()
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 -
Returns:
boolean

getItems

public java.util.List 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 class java.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 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 class java.lang.Object
Returns:
String


Copyright © 2005-2010 Apache Software Foundation. All Rights Reserved.