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
 void breakDocumentTOCItemAssociation(DocumentTOCItem documentTOCItem)
          Method breakDocumentTOCItemAssociation
 void createDocumentTOCItemAssociation(DocumentTOCItem documentTOCItem)
          Method createDocumentTOCItemAssociation
 boolean equals(java.lang.Object other)
          Method equals
 java.util.List getItems()
          Method getItems
 java.lang.String getModelEncoding()
           
 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 setModelEncoding(java.lang.String modelEncoding)
           
 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 -

breakDocumentTOCItemAssociation

public void breakDocumentTOCItemAssociation(DocumentTOCItem documentTOCItem)
Method breakDocumentTOCItemAssociation

Parameters:
documentTOCItem -

createDocumentTOCItemAssociation

public void createDocumentTOCItemAssociation(DocumentTOCItem documentTOCItem)
Method createDocumentTOCItemAssociation

Parameters:
documentTOCItem -

equals

public boolean equals(java.lang.Object other)
Method equals

Overrides:
equals in class java.lang.Object
Parameters:
other -

getItems

public java.util.List getItems()
Method getItems


getName

public java.lang.String getName()
Get The name to use for the toc.


getRef

public java.lang.String getRef()
Get The ref to use for the item.


hashCode

public int hashCode()
Method hashCode

Overrides:
hashCode in class java.lang.Object

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.


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

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)

getModelEncoding

public java.lang.String getModelEncoding()


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