package render
- Alphabetic
- Public
- All
Type Members
-
abstract
class
BaseFormatter[Rep <: BaseFormatter[Rep]] extends AnyRef
API basis for renderers that produce character output.
-
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] with FOProperties with Product with Serializable
API for renderers that produce XSL-FO output.
API for renderers that produce XSL-FO output.
- renderChild
the function to use for rendering child elements
- currentElement
the active element currently being rendered
- 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
- path
the virtual path of the document getting rendered, used for generating unique ids
- styles
the styles to apply when writing the attributes of an element
- indentation
the indentation mechanism for this formatter
- messageFilter
the filter to apply before rendering runtime messages
-
trait
FOProperties extends AnyRef
Mapping of XSL-FO tag names to their supported properties.
Mapping of XSL-FO tag names to their supported properties. All properties not supported by Apache FOP are omitted.
-
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] with Product with Serializable
API for renderers that produce HTML output.
API for renderers that produce HTML output.
- renderChild
the function to use for rendering child elements
- currentElement
the active element currently being rendered
- 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
- path
the virtual (translated) path of the document getting rendered
- indentation
the indentation mechanism for this formatter
- messageFilter
the filter to apply before rendering runtime messages
-
class
HTMLRenderer extends (HTMLFormatter, Element) ⇒ String
Default renderer implementation for the HTML output format.
-
case class
Indentation(currentLevel: Int, numSpaces: Int, dotted: Boolean = false) extends Product with Serializable
Represents the current indentation level of a formatter instance.
Represents the current indentation level of a formatter instance.
- currentLevel
the level of indentation (number of characters)
- numSpaces
the number of space characters to add when creating the next level of indentation from this instance
- dotted
indicates whether the indentation happens with a dot pattern or with just whitespace
-
abstract
class
TagFormatter[Rep <: BaseFormatter[Rep]] extends BaseFormatter[Rep]
Base type for formatters that produce tag-based output formats like XML or HTML.
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. -
case class
TextFormatter(renderChild: (TextFormatter, Element) ⇒ String, currentElement: Element, parents: List[Element], indentation: Indentation) extends BaseFormatter[TextFormatter] with Product with Serializable
API for renderers that produce text output.
API for renderers that produce text output.
- renderChild
the function to use for rendering child elements
- currentElement
the active element currently being rendered
- parents
the stack of parent elements of this formatter in recursive rendering, with the root element being the last in the list
- indentation
the indentation mechanism for this formatter
Value Members
-
object
ASTFormatter extends (RenderContext[TextFormatter]) ⇒ TextFormatter
Default factory for ASTFormatters, based on a provided RenderContext.
-
object
ASTRenderer extends (TextFormatter, Element) ⇒ String
Default renderer implementation for the Formatted AST output format.
-
object
FOFormatter extends (RenderContext[FOFormatter]) ⇒ FOFormatter with Serializable
Companion providing tree elements specific to the XSL-FO renderer.
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.
- object FOProperties
-
object
FORenderer extends (FOFormatter, Element) ⇒ String
Default renderer implementation for the XSL-FO output format.
-
object
HTMLFormatter extends (RenderContext[HTMLFormatter]) ⇒ HTMLFormatter with Serializable
Default factory for HTMLFormatters, based on a provided RenderContext.
- object HTMLRenderer extends HTMLRenderer
-
object
Indentation extends Serializable
Default Indentation instances.
- object TagFormatter
-
object
TextFormatter extends (RenderContext[TextFormatter]) ⇒ TextFormatter with Serializable
Default factory for TextFormatters, based on a provided RenderContext.
-
object
XHTMLFormatter extends (RenderContext[HTMLFormatter]) ⇒ HTMLFormatter
Default factory for XHTMLFormatters, based on a provided RenderContext.
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.