laika-io/laika.io.model/RenderedTree

RenderedTree

case class RenderedTree(path: Path, title: Option[SpanSequence], content: Seq[RenderContent], titleDocument: Option[RenderedDocument]) extends RenderContent

Represents a node of the tree of rendered documents.

Value Params
content

the rendered documents and subtrees in a recursive structure

path

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

title

the title of this tree, either obtained from the title document or configuration

titleDocument

the optional title document of this tree

trait Serializable
trait Product
trait Equals
trait Navigatable
class Object
trait Matchable
class Any

Value members

Concrete methods

def asNavigationItem(context: NavigationBuilderContext): NavigationItem

Inherited methods

def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product

Concrete fields

lazy val allDocuments: Seq[RenderedDocument]

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

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

lazy val isEmpty: Boolean

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.

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.

Inherited fields

lazy val name: String

The local name of this navigatable.

The local name of this navigatable.

Inherited from
Navigatable