trait TreeStructure extends AnyRef
The structure of a document tree.
- Self Type
- TreeStructure with TreeContent
- Alphabetic
- By Inheritance
- TreeStructure
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def content: Seq[TreeContent]
The content of this tree structure, containing all markup documents and subtrees, except for the (optional) title document.
- abstract def targetTree: DocumentTree
The actual document tree that this ast structure represents.
- 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.
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- lazy val allDocuments: Seq[Document]
All documents contained in this tree, fetched recursively, depth-first.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- 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. - def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def invalidElements(filter: MessageFilter): Seq[Invalid]
- 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.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def runtimeMessages(filter: MessageFilter): Seq[RuntimeMessage]
- 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. - 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..
). - 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. - 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.
- 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. - 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.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- lazy val title: Option[SpanSequence]
The title of this tree, obtained from configuration.
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withDefaultTemplate(template: TemplateRoot, formatSuffix: String): DocumentTree
Create a new document tree that contains the specified template as the default.