Packages

t

laika.ast

TreeStructure

trait TreeStructure extends AnyRef

The structure of a document tree.

Self Type
TreeStructure with TreeContent
Linear Supertypes
AnyRef, Any
Known Subclasses
DocumentTree
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TreeStructure
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def content: Seq[TreeContent]

    The content of this tree structure, containing all markup documents and subtrees, except for the (optional) title document.

  2. abstract def targetTree: DocumentTree

    The actual document tree that this ast structure represents.

  3. abstract def templates: Seq[TemplateDocument]

    All templates on this level of the tree hierarchy that might get applied to a document when it gets rendered.

  4. abstract def titleDocument: Option[Document]

    The title document for this tree, if present.

    The title document for this tree, if present.

    A document with the base name title and the corresponding suffix for the input markup, e.g. title.md for Markdown, can be used as an introductory section for a chapter represented by a directory tree.

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. lazy val allDocuments: Seq[Document]

    All documents contained in this tree, fetched recursively, depth-first.

  5. def appendContent(content: Seq[TreeContent]): DocumentTree

    Appends the specified content to this tree and return a new instance.

  6. def appendContent(content: TreeContent, contents: TreeContent*): DocumentTree

    Appends the specified content to this tree and return a new instance.

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def asNavigationItem(context: NavigationBuilderContext = NavigationBuilderContext()): NavigationItem

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

    Creates the navigation structure for this tree 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

  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. def getDefaultTemplate(formatSuffix: String): Option[TemplateDocument]

    Selects the template with the name default.template.<suffix> for the specified format suffix from this level of the document tree.

  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def invalidElements(filter: MessageFilter): Seq[Invalid]
  16. lazy val isEmpty: Boolean

    Indicates whether this tree does not contain any markup document.

    Indicates whether this tree does not contain any markup document. Template documents do not count, as they would be ignored in rendering when there is no markup document.

  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def prependContent(content: Seq[TreeContent]): DocumentTree

    Prepends the specified content to this tree and return a new instance.

  22. def prependContent(content: TreeContent, contents: TreeContent*): DocumentTree

    Prepends the specified content to this tree and return a new instance.

  23. def runtimeMessages(filter: MessageFilter): Seq[RuntimeMessage]
  24. def selectDocument(path: RelativePath): Option[Document]

    Selects a document from this tree or one of its subtrees by the specified path.

    Selects a document from this tree or one of its subtrees by the specified path. The path must not point to a parent tree (start with ../) as this instance is not aware of its parents.

  25. def selectDocument(path: String): Option[Document]

    Selects a document from this tree or one of its subtrees by the specified path.

    Selects a document from this tree or one of its subtrees by the specified path. The path needs to be relative and not point to a parent tree (neither start with / nor with ..).

  26. def selectSubtree(path: RelativePath): Option[DocumentTree]

    Selects a subtree of this tree by the specified path.

    Selects a subtree of this tree by the specified path. The path must not point to a parent tree (start with ../) as this instance is not aware of its parents.

  27. def selectSubtree(path: String): Option[DocumentTree]

    Selects a subtree of this tree by the specified path.

    Selects a subtree of this tree by the specified path. The path needs to be relative and it may point to a deeply nested subtree, not just immediate children.

  28. def selectTemplate(path: RelativePath): Option[TemplateDocument]

    Selects a template from this tree or one of its subtrees by the specified path.

    Selects a template from this tree or one of its subtrees by the specified path. The path must not point to a parent tree (start with ../) as this instance is not aware of its parents.

  29. def selectTemplate(path: String): Option[TemplateDocument]

    Selects a template from this tree or one of its subtrees by the specified path.

    Selects a template from this tree or one of its subtrees by the specified path. The path needs to be relative.

  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. lazy val title: Option[SpanSequence]

    The title of this tree, obtained from configuration.

  32. def toString(): String
    Definition Classes
    AnyRef → Any
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. def withDefaultTemplate(template: TemplateRoot, formatSuffix: String): DocumentTree

    Create a new document tree that contains the specified template as the default.

Deprecated Value Members

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

Inherited from AnyRef

Inherited from Any

Ungrouped