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.
- Alphabetic
- By Inheritance
- RenderFormat
- Format
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- type CustomRenderFunction[FMT] = PartialFunction[(FMT, Element), String]
- case class Overrides(value: CustomRenderFunction[FMT] = PartialFunction.empty) extends RenderOverrides with Product with Serializable
Abstract Value Members
- 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.
- 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.
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()