Class DocumentTOC

    • Constructor Detail

      • DocumentTOC

        public DocumentTOC()
    • Method Detail

      • addItem

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

        public boolean equals​(Object other)
        Method equals.
        Overrides:
        equals in class Object
        Parameters:
        other -
        Returns:
        boolean
      • 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
      • getName

        public String getName()
        Get the name to use for the Table of Contents.
        Returns:
        String
      • hashCode

        public int hashCode()
        Method hashCode.
        Overrides:
        hashCode in class Object
        Returns:
        int
      • 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​(List<DocumentTOCItem> items)
        Set tOC item.
        Parameters:
        items -
      • setName

        public void setName​(String name)
        Set the name to use for the Table of Contents.
        Parameters:
        name -
      • toString

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