Packages

t

laika.factory

RenderFormat

trait RenderFormat[FMT] extends Format

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

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

Type Members

  1. type CustomRenderFunction[FMT] = PartialFunction[(FMT, Element), String]
  2. case class Overrides(value: CustomRenderFunction[FMT] = PartialFunction.empty) extends RenderOverrides with Product with Serializable

Abstract Value Members

  1. abstract def defaultRenderer: (FMT, Element) ⇒ String

    The default renderer function for this output format.

    The default renderer function for this output format. It may be overridden by extensions for individual nodes of the AST.

    The function takes both, a formatter instance and the element to render and returns a String in the target format.

  2. 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.

  3. abstract def formatterFactory: (RenderContext[FMT]) ⇒ FMT

    The function for creating a new formatter for each render operation, based on the specified context containing the root element, the indentation mechanism and the delegate function for rendering child elements (that may contain user-specified extensions this render format implementation is not aware of).

    The function for creating a new formatter for each render operation, based on the specified context containing the root element, the indentation mechanism and the delegate function for rendering child elements (that may contain user-specified extensions this render format implementation is not aware of).

    The formatter created by this function (or copies created from it) will be used when invoking the default renderer.

Concrete 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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def description: String

    Short string describing the markup or output format for tooling and logging.

    Short string describing the markup or output format for tooling and logging.

    Definition Classes
    Format
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Format

Inherited from AnyRef

Inherited from Any

Ungrouped