Object/Class

laika.api

Render

Related Docs: class Render | package api

Permalink

object Render

Serves as an entry point to the Render API.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Render
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class RenderGatheredOutput[Writer] extends Render[Writer]

    Permalink

    A render operation that gathers input from one or more input documents in an input tree structure to be rendered to a single output destination.

    A render operation that gathers input from one or more input documents in an input tree structure to be rendered to a single output destination.

    This is necessary for formats like PDF, where the output will be contained in a single file, but the input can still be conveniently organized in a full directory structure.

  2. class RenderMappedOutput[Writer] extends Render[Writer]

    Permalink

    A render operation that maps each input document of a given input tree to a corresponding output document in the destination tree.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def as[Writer](processor: RenderResultProcessor[Writer]): RenderGatheredOutput[Writer]

    Permalink

    Returns a new Render instance for the specified processor.

    Returns a new Render instance for the specified processor. This instance is usually an object provided by the library or a plugin that is capable of rendering a specific output.

    processor

    the processor responsible for processing the renderer result

  5. def as[Writer](format: RenderFormat[Writer]): RenderMappedOutput[Writer]

    Permalink

    Returns a new Render instance for the specified render format.

    Returns a new Render instance for the specified render format. This factory is usually an object provided by the library or a plugin that is capable of rendering a specific output.

    format

    the renderer factory responsible for creating the final renderer

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped