Trait

laika.factory

RenderFormat

Related Doc: package factory

Permalink

trait RenderFormat[W] extends AnyRef

Responsible for creating renderer instances for a specific output format. A renderer is simply a function of type Element => Unit. In addition to the actual renderer function, the factory method also produces an instance of the generic W type which is the writer API to use for custom renderer functions and which is specific to the output format.

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

Type Members

  1. case class Theme(customRenderer: (W) ⇒ RenderFunction = _: W => PartialFunction.empty, defaultTemplate: Option[TemplateRoot] = None, defaultStyles: StyleDeclarationSet = StyleDeclarationSet.empty, staticDocuments: StaticDocuments = StaticDocuments.empty) extends RenderTheme with Product with Serializable

    Permalink

Abstract Value Members

  1. abstract def defaultTheme: Theme

    Permalink

    The default theme to use if no theme is explicitly specified.

  2. abstract def fileSuffix: String

    Permalink

    The file suffix to use when rendering the output to a file.

    The file suffix to use when rendering the output to a file. When transforming entire directories the suffix of the markup file will be automatically replaced by the suffix for the output format.

  3. abstract def newRenderer(out: Output, root: Element, delegate: (Element) ⇒ Unit, styles: StyleDeclarationSet, config: RenderConfig): (W, (Element) ⇒ Unit)

    Permalink

    Creates a new renderer and a new writer instance for the specified output and delegate renderer.

    Creates a new renderer and a new writer instance for the specified output and delegate renderer. The delegate function needs to be used whenever an element renders its children, as the user might have installed custom renderer overrides this instance is not aware of. If no custom renderer is responsible for the children, the invocation will fall back to calling this renderer again.

    In contrast to the parser function, a new render function will be created for each render operation. In addition to the actual renderer function, this method also produces an instance of the generic W type which is the writer API to use for custom renderer functions and which is specific to the output format.

    out

    the output to write to

    root

    the root element the new renderer will be used for

    delegate

    a render function to use for rendering the children of an element

    styles

    the styles the new renderer should apply to the rendered elements

    config

    additional configuration for the renderer

    returns

    a new writer API of type W and a new render function

Concrete 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. final def asInstanceOf[T0]: T0

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped