TocGenerator

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

5. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

6. final def eq(arg0: AnyRef): Boolean

   

   Definition Classes

   AnyRef

7. def equals(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

8. def finalize(): Unit

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( classOf[java.lang.Throwable] )

9. def fromDocument(doc: Document, depth: Int, refPath: Path): List[Block]

   

   Generates the tree model (consisting of BulletList elements) for the table of contents for the specified document.

   Generates the tree model (consisting of BulletList elements) for the table of contents for the specified document.

   doc

   the document to create a table of contents for

   depth

   the maximum depth to traverse when building the table, the depth is unlimited if the value is empty

   refPath

   the path from which the targets in the table will be linked

   returns

   a block element containing the table of contents as a BulltetList and its title

10. def fromTree(tree: DocumentTree, depth: Int, refPath: Path, treeTitleDoc: Option[String] = None): List[Block]

    

    Generates the tree model (consisting of BulletList elements) for the table of contents for the specified document tree.

    Generates the tree model (consisting of BulletList elements) for the table of contents for the specified document tree.

    tree

    the document tree to create a table of contents for

    depth

    the maximum depth to traverse when building the table, the depth is unlimited if the value is empty

    refPath

    the path from which the targets in the table will be linked

    treeTitleDoc

    the name for documents inserted for tree titles

    returns

    a block element containing the table of contents as a BulltetList and its title

11. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

12. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

13. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

14. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

15. final def notify(): Unit

    

    Definition Classes

    AnyRef

16. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

17. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

18. def toString(): String

    

    Definition Classes

    AnyRef → Any

19. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

20. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

21. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )