case class RenderedTreeRoot[F[_]](tree: RenderedTree, defaultTemplate: TemplateRoot, config: Config, 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
- 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
- Alphabetic
- By Inheritance
- RenderedTreeRoot
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
RenderedTreeRoot(tree: RenderedTree, defaultTemplate: TemplateRoot, config: Config, 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
- 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
-
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
-
lazy val
allDocuments: Seq[RenderedDocument]
All documents contained in this tree, fetched recursively, depth-first.
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- val config: Config
- val coverDocument: Option[RenderedDocument]
- val defaultTemplate: TemplateRoot
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val staticDocuments: Seq[BinaryInput[F]]
- val styles: StyleDeclarationSet
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
val
title: Option[SpanSequence]
The title of the tree, either obtained from the title document or configuration
-
val
titleDocument: Option[RenderedDocument]
The optional title document of the tree.
- val tree: RenderedTree
-
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( ... ) @native()