class TwoPhaseRendererBuilder[FMT, PP] extends RendererBuilderOps[FMT]
Builder API for Renderer instances.
Allows to add ExtensionBundles, to override the renderer for specific elements and other options.
- FMT
the formatter API to use which varies depending on the renderer
- PP
the type of the post processor
- Alphabetic
- By Inheritance
- TwoPhaseRendererBuilder
- RendererBuilderOps
- CommonBuilderOps
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new TwoPhaseRendererBuilder(twoPhaseFormat: TwoPhaseRenderFormat[FMT, PP], config: OperationConfig)
Type Members
-
type
ThisType = TwoPhaseRendererBuilder[FMT, PP]
The type of the operation being configured by this instance.
The type of the operation being configured by this instance.
- Definition Classes
- TwoPhaseRendererBuilder → CommonBuilderOps
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( ... ) @native()
-
val
config: OperationConfig
The current configuration for this instance.
The current configuration for this instance.
- Definition Classes
- TwoPhaseRendererBuilder → CommonBuilderOps
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- 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()
-
val
renderFormat: RenderFormat[FMT]
- Attributes
- protected[this]
- Definition Classes
- TwoPhaseRendererBuilder → RendererBuilderOps
-
def
renderMessages(filter: MessageFilter): ThisType
Specifies the minimum required level for a runtime message to get included into the output by this renderer.
Specifies the minimum required level for a runtime message to get included into the output by this renderer.
- Definition Classes
- RendererBuilderOps
-
def
rendering(customRenderer: PartialFunction[(FMT, Element), String]): ThisType
Specifies a custom render function that overrides one or more of the default renderers for the output format this instance uses.
Specifies a custom render function that overrides one or more of the default renderers for the output format this instance uses.
This method expects a partial function that takes a formatter and the element to render. It will then be invoked for each element it is defined at.
Simple example for customizing the HTML output for emphasized text, adding a specific style class:
val transformer = Transformer.from(Markdown).to(HTML).rendering { case (fmt, Emphasized(content, opt)) => fmt.element("em", opt, content, "class" -> "big") }.build
- Definition Classes
- RendererBuilderOps
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
- val twoPhaseFormat: TwoPhaseRenderFormat[FMT, PP]
-
def
unformatted: ThisType
Renders without any formatting (line breaks or indentation).
Renders without any formatting (line breaks or indentation). Useful when storing the output in a database for example.
- Definition Classes
- RendererBuilderOps
-
def
using(bundles: ExtensionBundle*): ThisType
Returns a new instance with the specified extension bundles installed.
Returns a new instance with the specified extension bundles installed. Features in the new bundles may override features in already installed bundles.
Bundles are usually provided by libraries (by Laika itself or a 3rd-party extension library) or as re-usable building blocks by application code.
- Definition Classes
- CommonBuilderOps
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
withConfig(newConfig: OperationConfig): ThisType
Returns a new instance with the specified configuration.
Returns a new instance with the specified configuration.
This method discards any previously specified options. It is usually meant to be used when copying over the configuration from a fully configured object to an unconfigured one.
- Definition Classes
- TwoPhaseRendererBuilder → CommonBuilderOps