c

laika.io.model

RenderedTree

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

Represents a node of the tree of rendered documents.

path

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

title

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

content

the rendered documents and subtrees in a recursive structure

titleDocument

the optional title document of this tree

Linear Supertypes
Serializable, Serializable, Product, Equals, RenderContent, Navigatable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RenderedTree
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. RenderContent
  7. Navigatable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RenderedTree(path: Path, title: Option[SpanSequence], content: Seq[RenderContent], titleDocument: Option[RenderedDocument] = None)

    path

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

    title

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

    content

    the rendered documents and subtrees in a recursive structure

    titleDocument

    the optional title document of this tree

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[RenderedDocument]

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

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

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

    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.

    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

    Definition Classes
    RenderedTree → RenderContent
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. val content: Seq[RenderContent]
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. 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.

  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. lazy val name: String

    The local name of this navigatable.

    The local name of this navigatable.

    Definition Classes
    Navigatable
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. val path: Path
    Definition Classes
    RenderedTree → Navigatable
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. val title: Option[SpanSequence]
    Definition Classes
    RenderedTree → RenderContent
  20. val titleDocument: Option[RenderedDocument]
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from RenderContent

Inherited from Navigatable

Inherited from AnyRef

Inherited from Any

Ungrouped