c

laika.io.model

RenderedTreeRoot

case class RenderedTreeRoot[F[_]](tree: RenderedTree, defaultTemplate: TemplateRoot, config: Config, outputContext: OutputContext, pathTranslator: PathTranslator, styles: StyleDeclarationSet = StyleDeclarationSet.empty, coverDocument: Option[RenderedDocument] = None, staticDocuments: Seq[BinaryInput[F]] = Nil) extends Product with Serializable

Represents the root of a tree of rendered documents. In addition to the recursive structure of documents it holds additional items like static or cover documents, which may contribute to the output of a site or an e-book.

tree

the recursive structure of documents, usually obtained from parsing text markup

defaultTemplate

the default template configured for the output format, which may be used by a post-processor

config

the root configuration of the rendered tree

outputContext

the context for the output format used in rendering (file suffix and format selector)

pathTranslator

the path translator specific to the output format produced by the renderer

coverDocument

the cover document (usually used with e-book formats like EPUB and PDF)

staticDocuments

the paths of documents that were neither identified as text markup, config or templates, and will potentially be embedded or copied as is to the final output, depending on the output format

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

Instance Constructors

  1. new RenderedTreeRoot(tree: RenderedTree, defaultTemplate: TemplateRoot, config: Config, outputContext: OutputContext, pathTranslator: PathTranslator, styles: StyleDeclarationSet = StyleDeclarationSet.empty, coverDocument: Option[RenderedDocument] = None, staticDocuments: Seq[BinaryInput[F]] = Nil)

    tree

    the recursive structure of documents, usually obtained from parsing text markup

    defaultTemplate

    the default template configured for the output format, which may be used by a post-processor

    config

    the root configuration of the rendered tree

    outputContext

    the context for the output format used in rendering (file suffix and format selector)

    pathTranslator

    the path translator specific to the output format produced by the renderer

    coverDocument

    the cover document (usually used with e-book formats like EPUB and PDF)

    staticDocuments

    the paths of documents that were neither identified as text markup, config or templates, and will potentially be embedded or copied as is to the final output, depending on the output format

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. val config: Config
  8. val coverDocument: Option[RenderedDocument]
  9. val defaultTemplate: TemplateRoot
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. val outputContext: OutputContext
  17. val pathTranslator: PathTranslator
  18. val staticDocuments: Seq[BinaryInput[F]]
  19. val styles: StyleDeclarationSet
  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. val title: Option[SpanSequence]

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

  22. val titleDocument: Option[RenderedDocument]

    The optional title document of the tree.

  23. val tree: RenderedTree
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  26. 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 AnyRef

Inherited from Any

Ungrouped