RenderedTree

laika.io.model.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 parameters

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

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Navigatable
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def asNavigationItem(context: NavigationBuilderContext): NavigationItem

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

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

Value parameters

context

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

Attributes

Returns

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

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product

Concrete fields

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

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

Attributes

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.

Attributes

Inherited fields

lazy val name: String

The local name of this navigatable.

The local name of this navigatable.

Attributes

Inherited from:
Navigatable