Packages

t

laika.ast

DocumentNavigation

trait DocumentNavigation extends Navigatable

Represents a document structure with sections that can be turned into a navigation structure.

Linear Supertypes
Navigatable, AnyRef, Any
Known Subclasses
Document, DocumentStructure
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocumentNavigation
  2. Navigatable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def path: Path
    Definition Classes
    Navigatable
  2. abstract def sections: Seq[SectionInfo]

    The section structure of this document based on the hierarchy of headers found in the original text markup.

  3. abstract def targetFormats: TargetFormats

    The formats this document should be rendered to.

  4. abstract def title: Option[SpanSequence]

    The title of this document, obtained from the document structure or from the configuration.

    The title of this document, obtained from the document structure or from the configuration. In case no title is defined in either of the two places the result will be None.

Concrete 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 asNavigationItem(context: NavigationBuilderContext = NavigationBuilderContext()): NavigationItem

    Creates the navigation structure for this document up to the specified depth.

    Creates the navigation structure for this document up to the specified depth. The returned instance can be used as part of a bigger navigation structure comprising of trees, documents and their sections.

    context

    captures the navigation depth, reference path and styles for the navigation tree being built

    returns

    a navigation item that can be used as part of a bigger navigation structure comprising of trees, documents and their sections

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. lazy val name: String

    The local name of this navigatable.

    The local name of this navigatable.

    Definition Classes
    Navigatable
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  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(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Navigatable

Inherited from AnyRef

Inherited from Any

Ungrouped