laika.render
Type members
Classlikes
Default factory for ASTFormatters, based on a provided RenderContext.
Default factory for ASTFormatters, based on a provided RenderContext.
Default renderer implementation for the Formatted AST output format.
Default renderer implementation for the Formatted AST output format.
API basis for renderers that produce character output.
API basis for renderers that produce character output.
- Value parameters:
- currentElement
the active element currently being rendered
- indentation
the indentation mechanism for this formatter
- messageFilter
the filter to apply before rendering runtime messages
- parents
the stack of parent elements of this formatter in recursive rendering, with the root element being the last in the list
- renderChild
the function to use for rendering child elements
API for renderers that produce XSL-FO output.
API for renderers that produce XSL-FO output.
- Value parameters:
- currentElement
the active element currently being rendered
- indentation
the indentation mechanism for this formatter
- messageFilter
the filter to apply before rendering runtime messages
- parents
the stack of parent elements of this formatter in recursive rendering, with the root element being the last in the list
- path
the virtual path of the document getting rendered, used for generating unique ids
- pathTranslator
translates paths of input documents to the corresponding output path
- renderChild
the function to use for rendering child elements
- styles
the styles to apply when writing the attributes of an element
- Companion:
- object
Companion providing tree elements specific to the XSL-FO renderer. These are usually not part of the document AST produced by a parser, but only inserted dynamically during the render process to drive features specific to FO output.
Companion providing tree elements specific to the XSL-FO renderer. These are usually not part of the document AST produced by a parser, but only inserted dynamically during the render process to drive features specific to FO output.
- Companion:
- class
Mapping of XSL-FO tag names to their supported properties. All properties not supported by Apache FOP are omitted.
Mapping of XSL-FO tag names to their supported properties. All properties not supported by Apache FOP are omitted.
Default renderer implementation for the XSL-FO output format.
Default renderer implementation for the XSL-FO output format.
API for renderers that produce HTML output.
API for renderers that produce HTML output.
- Value parameters:
- currentElement
the active element currently being rendered
- indentation
the indentation mechanism for this formatter
- messageFilter
the filter to apply before rendering runtime messages
- parents
the stack of parent elements of this formatter in recursive rendering, with the root element being the last in the list
- path
the virtual (translated) path of the document getting rendered
- pathTranslator
translates paths of input documents to the corresponding output path
- renderChild
the function to use for rendering child elements
- Companion:
- object
Default factory for HTMLFormatters, based on a provided RenderContext.
Default factory for HTMLFormatters, based on a provided RenderContext.
- Companion:
- class
Default renderer implementation for the HTML output format.
Default renderer implementation for the HTML output format.
- Companion:
- object
Represents the current indentation level of a formatter instance.
Represents the current indentation level of a formatter instance.
- Value parameters:
- currentLevel
the level of indentation (number of characters)
- dotted
indicates whether the indentation happens with a dot pattern or with just whitespace
- numSpaces
the number of space characters to add when creating the next level of indentation from this instance
- Companion:
- object
Base type for formatters that produce tag-based output formats like XML or HTML.
Extends the BaseFormatter and adds methods for writing text
with special characters as entities and for conveniently writing
tags with attributes.
Base type for formatters that produce tag-based output formats like XML or HTML.
Extends the BaseFormatter and adds methods for writing text
with special characters as entities and for conveniently writing
tags with attributes.
- Value parameters:
- currentElement
the active element currently being rendered
- indentation
the indentation mechanism for this formatter
- messageFilter
the filter to apply before rendering runtime messages
- parents
the stack of parent elements of this formatter in recursive rendering, with the root element being the last in the list
- pathTranslator
translates paths of input documents to the corresponding output path
- renderChild
the function to use for rendering child elements
- Companion:
- object
API for renderers that produce text output.
API for renderers that produce text output.
- Value parameters:
- currentElement
the active element currently being rendered
- indentation
the indentation mechanism for this formatter
- parents
the stack of parent elements of this formatter in recursive rendering, with the root element being the last in the list
- renderChild
the function to use for rendering child elements
- Companion:
- object
Default factory for TextFormatters, based on a provided RenderContext.
Default factory for TextFormatters, based on a provided RenderContext.
- Companion:
- class
Default factory for XHTMLFormatters, based on a provided RenderContext.
It differs from an standard HTMLFormatter solely in that it close empty
tags. Therefore it offers the same API and shares the type HTMLFormatter
so that shared custom renderers can be built for HTML and XHTML.
Default factory for XHTMLFormatters, based on a provided RenderContext.
It differs from an standard HTMLFormatter solely in that it close empty
tags. Therefore it offers the same API and shares the type HTMLFormatter
so that shared custom renderers can be built for HTML and XHTML.