laika-core
API
Generated with
laika-core/laika/laika.render

laika.render

package laika.render

Members list

Type members

Classlikes

object ASTFormatter extends RenderContext[TextFormatter] => TextFormatter

Default factory for ASTFormatters, based on a provided RenderContext.

Default factory for ASTFormatters, based on a provided RenderContext.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object ASTRenderer extends (TextFormatter, Element) => String

Default renderer implementation for the Formatted AST output format.

Default renderer implementation for the Formatted AST output format.

Attributes

Supertypes
trait (TextFormatter, Element) => String
class Object
trait Matchable
class Any
Self type
abstract class BaseFormatter[Rep <: BaseFormatter[Rep]](renderChild: (Rep, Element) => String, currentElement: Element, parents: List[Element], indentation: Indentation, messageFilter: MessageFilter)

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 Object
trait Matchable
class Any
Known subtypes
class TagFormatter[Rep]
class FOFormatter
Self type
Rep
case class FOFormatter(renderChild: (FOFormatter, Element) => String, currentElement: Element, parents: List[Element], pathTranslator: PathTranslator, path: Path, styles: StyleDeclarationSet, indentation: Indentation, messageFilter: MessageFilter) extends TagFormatter[FOFormatter], FOProperties

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 Serializable
trait Product
trait Equals
trait FOProperties
class Object
trait Matchable
class Any
Show all
object FOFormatter extends RenderContext[FOFormatter] => FOFormatter

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 Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
trait FOProperties

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 Object
trait Matchable
class Any
Known subtypes
class FOFormatter
object FOProperties

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object FORenderer extends (FOFormatter, Element) => String

Default renderer implementation for the XSL-FO output format.

Default renderer implementation for the XSL-FO output format.

Attributes

Supertypes
trait (FOFormatter, Element) => String
class Object
trait Matchable
class Any
Self type
FORenderer.type
case class HTMLFormatter(renderChild: (HTMLFormatter, Element) => String, currentElement: Element, parents: List[Element], pathTranslator: PathTranslator, path: Path, indentation: Indentation, messageFilter: MessageFilter, closeEmptyTags: Boolean) extends TagFormatter[HTMLFormatter]

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HTMLFormatter extends RenderContext[HTMLFormatter] => HTMLFormatter

Default factory for HTMLFormatters, based on a provided RenderContext.

Default factory for HTMLFormatters, based on a provided RenderContext.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class HTMLRenderer(fileSuffix: String, format: String) extends (HTMLFormatter, Element) => String

Default renderer implementation for the HTML output format.

Default renderer implementation for the HTML output format.

Attributes

Companion
object
Supertypes
trait (HTMLFormatter, Element) => String
class Object
trait Matchable
class Any
Known subtypes
object HTMLRenderer.type
object HTMLRenderer extends HTMLRenderer

Attributes

Companion
class
Supertypes
class HTMLRenderer
trait (HTMLFormatter, Element) => String
class Object
trait Matchable
class Any
Self type
case class Indentation(currentLevel: Int, numSpaces: Int, dotted: Boolean)

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Indentation

Default Indentation instances.

Default Indentation instances.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
abstract class TagFormatter[Rep <: BaseFormatter[Rep]](renderChild: (Rep, Element) => String, currentElement: Element, parents: List[Element], pathTranslator: PathTranslator, indentation: Indentation, messageFilter: MessageFilter) extends BaseFormatter[Rep]

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
class BaseFormatter[Rep]
class Object
trait Matchable
class Any
Known subtypes
class FOFormatter
Self type
Rep
object TagFormatter

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
case class TextFormatter(renderChild: (TextFormatter, Element) => String, currentElement: Element, parents: List[Element], indentation: Indentation) extends BaseFormatter[TextFormatter]

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 Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TextFormatter extends RenderContext[TextFormatter] => TextFormatter

Default factory for TextFormatters, based on a provided RenderContext.

Default factory for TextFormatters, based on a provided RenderContext.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
object XHTMLFormatter extends RenderContext[HTMLFormatter] => HTMLFormatter

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
class Object
trait Matchable
class Any
Self type
Generated with