Class DocumentTOCItem

    • Constructor Detail

      • DocumentTOCItem

        public DocumentTOCItem()
    • 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
      • 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 -
      • 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​(List<DocumentTOCItem> items)
        Set a table of content item containing sub-items.
        Parameters:
        items -
      • setName

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

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

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