DocumentTree

Instance Constructors

new DocumentTree(path: Path, content: Seq[TreeContent], templates: Seq[TemplateDocument] = Nil, styles: Map[String, StyleDeclarationSet] = ..., additionalContent: Seq[AdditionalContent] = Nil, config: Config = ConfigFactory.empty, position: TreePosition = TreePosition.root, sourcePaths: Seq[String] = Nil)

path
the full, absolute path of this (virtual) document tree
content
the markup documents and subtrees
templates
all templates on this level of the tree hierarchy that might get applied to a document when it gets rendered
styles
the styles to apply when rendering this tree
additionalContent
all dynamic or static documents that are not part of the main navigatable content of the tree
config
the configuration associated with this tree
position
the position of this tree inside a document ast hierarchy, expressed as a list of Ints
sourcePaths
the paths this document tree has been built from or an empty list if this ast does not originate from the file system

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
val additionalContent: Seq[AdditionalContent]

all dynamic or static documents that are not part of the main navigatable content of the tree
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val config: Config

the configuration associated with this tree
the configuration associated with this tree

Definition Classes
DocumentTree → TreeContent
val content: Seq[TreeContent]

the markup documents and subtrees
the markup documents and subtrees

Definition Classes
DocumentTree → TreeStructure
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
lazy val globalLinkTargets: Map[Selector, TargetResolver]

All link targets that can get referenced from anywhere in the document tree.
All link targets that can get referenced from anywhere in the document tree.

Definition Classes
TreeStructure
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
lazy val name: String

The local name of this navigatable.
The local name of this navigatable.

Definition Classes
Navigatable
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val path: Path

the full, absolute path of this (virtual) document tree
the full, absolute path of this (virtual) document tree

Definition Classes
DocumentTree → Navigatable
val position: TreePosition

the position of this tree inside a document ast hierarchy, expressed as a list of Ints
the position of this tree inside a document ast hierarchy, expressed as a list of Ints

Definition Classes
DocumentTree → TreeContent
def rewrite(rule: (DocumentCursor) ⇒ RewriteRule): DocumentTree

Returns a new tree, with all the document models contained in it rewritten based on the specified rewrite rule.
Returns a new tree, with all the document models contained in it rewritten based on the specified rewrite rule.
If the specified partial function is not defined for a specific element the old element remains in the tree unchanged. If it returns None then the node gets removed from the ast, if it returns an element it will replace the old one. Of course the function may also return the old element.
The rewriting is performed in a way that only branches of the tree that contain new or removed elements will be replaced. It is processed bottom-up, therefore any element container passed to the rule only contains children which have already been processed.
The specified factory function will be invoked for each document contained in this tree and must return a partial function that represents the rewrite rules for that particular document.
def selectDocument(path: Path): 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.

Definition Classes
TreeStructure
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.

Definition Classes
TreeStructure
def selectSubtree(path: Path): 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.

Definition Classes
TreeStructure
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.

Definition Classes
TreeStructure
def selectTarget(selector: Selector): Option[TargetResolver]

Selects a link target by the specified selector if it is defined somewhere in a document inside this document tree.
Selects a link target by the specified selector if it is defined somewhere in a document inside this document tree.

Definition Classes
TreeContent
def selectTemplate(path: Path): 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.

Definition Classes
TreeStructure
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.

Definition Classes
TreeStructure
val sourcePaths: Seq[String]

the paths this document tree has been built from or an empty list if this ast does not originate from the file system
val styles: Map[String, StyleDeclarationSet]

the styles to apply when rendering this tree
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val targetTree: DocumentTree

The actual document tree that this ast structure represents.
The actual document tree that this ast structure represents.

Definition Classes
DocumentTree → TreeStructure
val templates: Seq[TemplateDocument]

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

Definition Classes
DocumentTree → TreeStructure
lazy val title: Seq[Span]

The title of this tree, obtained from configuration.
The title of this tree, obtained from configuration.

Definition Classes
TreeStructure
def titleFromConfig: Option[Seq[Span]]

Attributes
protected
Definition Classes
TreeContent
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package ast

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val additionalContent: Seq[AdditionalContent]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val config: Config

val content: Seq[TreeContent]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

lazy val globalLinkTargets: Map[Selector, TargetResolver]

final def isInstanceOf[T0]: Boolean

lazy val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val path: Path

val position: TreePosition

def rewrite(rule: (DocumentCursor) ⇒ RewriteRule): DocumentTree

def selectDocument(path: Path): Option[Document]

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

def selectSubtree(path: Path): Option[DocumentTree]

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

def selectTarget(selector: Selector): Option[TargetResolver]

def selectTemplate(path: Path): Option[TemplateDocument]

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

val sourcePaths: Seq[String]

val styles: Map[String, StyleDeclarationSet]

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

val targetTree: DocumentTree

val templates: Seq[TemplateDocument]

lazy val title: Seq[Span]

def titleFromConfig: Option[Seq[Span]]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from TreeContent

Inherited from Navigatable

Inherited from TreeStructure

Inherited from AnyRef

Inherited from Any

Ungrouped