laika.factory

RendererFactory

trait RendererFactory[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. RendererFactory
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def fileSuffix: String

    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.

  2. abstract def newRenderer(out: Output, delegate: (Element) ⇒ Unit): (W, (Element) ⇒ Unit)

    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

    delegate

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

    returns

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

Concrete Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    AnyRef
  18. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped