Class DocumentTOCItem

java.lang.Object
org.apache.maven.doxia.document.DocumentTOCItem
All Implemented Interfaces:
Serializable

public class DocumentTOCItem extends Object implements Serializable
A menu item.
Version:
$Revision$ $Date$
See Also:
  • Field Details

    • name

      private String name
      The name to use for the toc.
    • ref

      private String ref
      The ref to use for the item.
    • collapse

      private boolean collapse
      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.
    • items

      private List<DocumentTOCItem> items
      Field items.
  • Constructor Details

    • DocumentTOCItem

      public DocumentTOCItem()
  • Method Details

    • addItem

      public void addItem(DocumentTOCItem documentTOCItem)
      Method addItem.
      Parameters:
      documentTOCItem - a documentTOCItem object.
    • equals

      public boolean equals(Object other)
      Method equals.
      Overrides:
      equals in class Object
      Parameters:
      other - a other object.
      Returns:
      boolean
    • getItems

      public List<DocumentTOCItem> getItems()
      Method getItems.
      Returns:
      List
    • getName

      public String getName()
      Get the name to use for the toc.
      Returns:
      String
    • getRef

      public String getRef()
      Get the ref to use for the item.
      Returns:
      String
    • hashCode

      public int hashCode()
      Method hashCode.
      Overrides:
      hashCode in class 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 - 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

      public void setItems(List<DocumentTOCItem> items)
      Set a table of content item containing sub-items.
      Parameters:
      items - a items object.
    • setName

      public void setName(String name)
      Set the name to use for the toc.
      Parameters:
      name - a name object.
    • setRef

      public void setRef(String ref)
      Set the ref to use for the item.
      Parameters:
      ref - a ref object.
    • toString

      public String toString()
      Method toString.
      Overrides:
      toString in class Object
      Returns:
      String