c

play.doc

TocPage

case class TocPage(page: String, title: String, next: Option[List[String]]) extends TocTree with Product with Serializable

A page (leaf node) pointed to by the table of contents

page

The page

title

The title of the page

next

Explicitly provided next links. If None, then the index structure are used to generate the next links, otherwise these links should be used. Note that Some(Nil) is distinct from None, in that Some(Nil) means there should be no next links, whereas None means let the index decide what the next link should be.

Linear Supertypes
Serializable, Product, Equals, TocTree, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TocPage
  2. Serializable
  3. Product
  4. Equals
  5. TocTree
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TocPage(page: String, title: String, next: Option[List[String]])

    page

    The page

    title

    The title of the page

    next

    Explicitly provided next links. If None, then the index structure are used to generate the next links, otherwise these links should be used. Note that Some(Nil) is distinct from None, in that Some(Nil) means there should be no next links, whereas None means let the index decide what the next link should be.

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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  8. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  9. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. val next: Option[List[String]]
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  13. val page: String

    The page that this node should point to

    The page that this node should point to

    Definition Classes
    TocPage → TocTree
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. val title: String

    The title of this node

    The title of this node

    Definition Classes
    TocPage → TocTree
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from TocTree

Inherited from AnyRef

Inherited from Any

Ungrouped