laika.render
Members list
Type members
Classlikes
Default factory for ASTFormatters, based on a provided RenderContext.
Default factory for ASTFormatters, based on a provided RenderContext.
Attributes
- Supertypes
- Self type
-
ASTFormatter.type
Default renderer implementation for the Formatted AST output format.
Default renderer implementation for the Formatted AST output format.
Attributes
- Supertypes
- Self type
-
ASTRenderer.type
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
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
- Self type
-
Rep
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
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait FOPropertiesclass TagFormatter[FOFormatter]class BaseFormatter[FOFormatter]class Objecttrait Matchableclass AnyShow all
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.
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass AnyShow all
- Self type
-
FOFormatter.type
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.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class FOFormatter
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
FOProperties.type
Default renderer implementation for the XSL-FO output format.
Default renderer implementation for the XSL-FO output format.
Attributes
- Supertypes
- Self type
-
FORenderer.type
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
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass TagFormatter[HTMLFormatter]class BaseFormatter[HTMLFormatter]class Objecttrait Matchableclass AnyShow all
Default factory for HTMLFormatters, based on a provided RenderContext.
Default factory for HTMLFormatters, based on a provided RenderContext.
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass AnyShow all
- Self type
-
HTMLFormatter.type
Default renderer implementation for the HTML output format.
Default renderer implementation for the HTML output format.
Attributes
- Companion
- object
- Supertypes
- Known subtypes
-
object HTMLRenderer.type
Attributes
- Companion
- class
- Supertypes
- Self type
-
HTMLRenderer.type
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
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Default Indentation instances.
Default Indentation instances.
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
Indentation.type
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
Attributes
- Companion
- object
- Supertypes
- Known subtypes
-
class FOFormatterclass HTMLFormatter
- Self type
-
Rep
Attributes
- Companion
- class
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
TagFormatter.type
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
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass BaseFormatter[TextFormatter]class Objecttrait Matchableclass AnyShow all
Default factory for TextFormatters, based on a provided RenderContext.
Default factory for TextFormatters, based on a provided RenderContext.
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass AnyShow all
- Self type
-
TextFormatter.type
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.
Attributes
- Supertypes
- Self type
-
XHTMLFormatter.type