c

laika.io.model

RenderedDocument

case class RenderedDocument(path: Path, title: Option[SpanSequence], sections: Seq[SectionInfo], content: String, config: Config) extends RenderContent with DocumentNavigation with Product with Serializable

A single rendered document with the content as a plain string in the target format.

The title and section info are still represented as an AST, so they be used in any subsequent step that needs to produce navigation structures.

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

Instance Constructors

  1. new RenderedDocument(path: Path, title: Option[SpanSequence], sections: Seq[SectionInfo], content: String, config: Config)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def asNavigationItem(context: NavigationBuilderContext = NavigationBuilderContext()): NavigationItem

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

    Creates the navigation structure for this document 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
    DocumentNavigation
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. val config: Config
  8. val content: String
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. lazy val name: String

    The local name of this navigatable.

    The local name of this navigatable.

    Definition Classes
    Navigatable
  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 path: Path
    Definition Classes
    RenderedDocument → Navigatable
  17. val sections: Seq[SectionInfo]

    The section structure of this document based on the hierarchy of headers found in the original text markup.

    The section structure of this document based on the hierarchy of headers found in the original text markup.

    Definition Classes
    RenderedDocument → DocumentNavigation
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. val targetFormats: TargetFormats

    The formats this document should be rendered to.

    The formats this document should be rendered to.

    Definition Classes
    RenderedDocument → DocumentNavigation
  20. val title: Option[SpanSequence]

    The title of this document, obtained from the document structure or from the configuration.

    The title of this document, obtained from the document structure or from the configuration. In case no title is defined in either of the two places the result will be None.

    Definition Classes
    RenderedDocument → DocumentNavigation → RenderContent
  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 DocumentNavigation

Inherited from RenderContent

Inherited from Navigatable

Inherited from AnyRef

Inherited from Any

Ungrouped