c

laika.api.builder

TwoPhaseRendererBuilder

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

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TwoPhaseRendererBuilder
  2. RendererBuilderOps
  3. CommonBuilderOps
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TwoPhaseRendererBuilder(twoPhaseFormat: TwoPhaseRenderFormat[FMT, PP], config: OperationConfig)

Type Members

  1. 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
    TwoPhaseRendererBuilderCommonBuilderOps

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. val config: OperationConfig

    The current configuration for this instance.

    The current configuration for this instance.

    Definition Classes
    TwoPhaseRendererBuilderCommonBuilderOps
  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. val renderFormat: RenderFormat[FMT]
    Attributes
    protected[this]
    Definition Classes
    TwoPhaseRendererBuilderRendererBuilderOps
  17. 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
  18. 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
  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. val twoPhaseFormat: TwoPhaseRenderFormat[FMT, PP]
  22. 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
  23. 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
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  27. 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
    TwoPhaseRendererBuilderCommonBuilderOps

Inherited from RendererBuilderOps[FMT]

Inherited from CommonBuilderOps

Inherited from AnyRef

Inherited from Any

Ungrouped