play.doc

Toc

case class Toc(name: String, title: String, nodes: List[(String, TocTree)], descend: Boolean = true) extends TocTree with Product with Serializable

A table of contents

title

The title of this table of contents

nodes

The nodes in the table of contents

descend

Whether a table of contents should descend into this table of contents

Linear Supertypes
Serializable, Serializable, Product, Equals, TocTree, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Toc
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. TocTree
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Toc(name: String, title: String, nodes: List[(String, TocTree)], descend: Boolean = true)

    title

    The title of this table of contents

    nodes

    The nodes in the table of contents

    descend

    Whether a table of contents should descend into this table of contents

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. val descend: Boolean

    Whether a table of contents should descend into this table of contents

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

    Definition Classes
    AnyRef

  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

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

    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  13. val name: String

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

    Definition Classes
    AnyRef

  15. val nodes: List[(String, TocTree)]

    The nodes in the table of contents

  16. final def notify(): Unit

    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  18. def page: String

    The page that this node should point to

    The page that this node should point to

    Definition Classes
    Toc → TocTree

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

    Definition Classes
    AnyRef

  20. val title: String

    The title of this table of contents

    The title of this table of contents

    Definition Classes
    Toc → TocTree

  21. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from TocTree

Inherited from AnyRef

Inherited from Any

Ungrouped