Class/Object

laika.render

XSLFO

Related Docs: object XSLFO | package render

Permalink

class XSLFO extends RendererFactory[FOWriter]

A renderer for XSL-FO output. May be directly passed to the Render or Transform APIs:

Render as XSLFO from document toFile "hello.fo"

Transform from Markdown to XSLFO fromFile "hello.md" toFile "hello.fo"

This renderer is usually used as an interim format for producing a PDF, where you do not deal with this format directly. But it can alternatively also be used as the final output and then get processed by external tools.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. XSLFO
  2. RendererFactory
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. lazy val defaultStyles: StyleDeclarationSet

    Permalink

    The default styles to add as a fallback to the explicitly specified styles.

    The default styles to add as a fallback to the explicitly specified styles.

    Definition Classes
    XSLFORendererFactory
  7. lazy val defaultTemplate: TemplateRoot

    Permalink

    The default template to use for this renderer if no template is explicitly specified.

    The default template to use for this renderer if no template is explicitly specified.

    Definition Classes
    XSLFORendererFactory
  8. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. val fileSuffix: String

    Permalink

    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.

    Definition Classes
    XSLFORendererFactory
  11. def finalize(): Unit

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  16. def newRenderer(output: Output, root: Element, render: (Element) ⇒ Unit, styles: StyleDeclarationSet): (FOWriter, (Element) ⇒ Unit)

    Permalink

    The actual setup method for providing both the writer API for customized renderers as well as the actual default render function itself.

    The actual setup method for providing both the writer API for customized renderers as well as the actual default render function itself. The default render function always only renders a single element and then delegates to the composite renderer passed to this function as a parameter when rendering children. This way user customizations are possible on a per-element basis.

    output

    the output to write to

    root

    the root element the new renderer will be used for

    render

    the composite render function to delegate to when elements need to render their children

    styles

    the styles the new renderer should apply to the rendered elements

    returns

    a tuple consisting of the writer API for customizing the renderer as well as the actual default render function itself

    Definition Classes
    XSLFORendererFactory
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  21. def unformatted: XSLFO

    Permalink

    Renders XSL-FO without any formatting (line breaks or indentation) around tags.

    Renders XSL-FO without any formatting (line breaks or indentation) around tags. Useful when storing the output in a database for example.

  22. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. def withMessageLevel(level: MessageLevel): XSLFO

    Permalink

    Specifies the minimum required level for a system message to get included into the output by this renderer.

  26. def withStyles(additionalStyles: StyleDeclarationSet): XSLFO

    Permalink

    Adds the specified styles to the default styles this renderer applies.

Inherited from RendererFactory[FOWriter]

Inherited from AnyRef

Inherited from Any

Ungrouped