API for renderers that produce XSL-FO output.
Attributes
- 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
- Graph
- Supertypes
- trait Serializabletrait Producttrait Equalstrait FOPropertiesclass TagFormatter[FOFormatter]class BaseFormatter[FOFormatter]class Objecttrait Matchableclass Any
Members list
Value members
Concrete methods
Renders all attributes derived from the style hint and the explicitly provided attributes.
Renders all attributes derived from the style hint and the explicitly provided attributes.
Attributes
Renders an FO block
element and the specified nested spans on the same line.
Renders an FO block
element and the specified nested spans on the same line.
Attributes
Renders an empty FO block
element.
Renders an empty FO block
element.
Attributes
Renders an FO block
element, containing nested blocks.
The content will be rendered indented one level to the right.
Renders an FO block
element, containing nested blocks.
The content will be rendered indented one level to the right.
Attributes
Renders an FO block
element and the specified nested spans, preserving
all whitespace within the text elements of those spans.
Renders an FO block
element and the specified nested spans, preserving
all whitespace within the text elements of those spans.
Attributes
Renders an FO bookmark
element and all of its nested bookmarks.
Renders an FO bookmark
element and all of its nested bookmarks.
Attributes
Renders an FO bookmark-title
element.
Renders an FO bookmark-title
element.
Attributes
Renders an FO bookmark-tree
element and all of its nested bookmarks.
Renders an FO bookmark-tree
element and all of its nested bookmarks.
Attributes
Generates an id that is unique within the entire document tree for the specified path of the target document and its local reference.
Generates an id that is unique within the entire document tree for the specified path of the target document and its local reference.
Attributes
Generates an id that is unique within the entire document tree for the specified local reference.
Generates an id that is unique within the entire document tree for the specified local reference.
Attributes
Renders an FO external-graphic
element.
Renders an FO external-graphic
element.
Attributes
Renders an FO basic-link
element for an external target.
Renders an FO basic-link
element for an external target.
Attributes
Renders an FO footnote
element, with the body indented one level to the right.
Renders an FO footnote
element, with the body indented one level to the right.
Attributes
Renders an FO inline
element and the specified nested spans on the same line.
Renders an FO inline
element and the specified nested spans on the same line.
Attributes
Renders an FO basic-link
element for an internal target.
Renders an FO basic-link
element for an internal target.
Attributes
Renders an FO block
or inline
element for this internal link
target, depending on whether it is inside a BlockContainer
or SpanContainer
.
Renders an FO block
or inline
element for this internal link
target, depending on whether it is inside a BlockContainer
or SpanContainer
.
Attributes
Renders an FO list-block
element, and the specified list items.
The content will be rendered indented one level to the right.
Renders an FO list-block
element, and the specified list items.
The content will be rendered indented one level to the right.
Attributes
Renders an FO list-item
element with the specified label and body.
The content will be rendered indented one level to the right.
Renders an FO list-item
element with the specified label and body.
The content will be rendered indented one level to the right.
Attributes
Renders an FO list-item-body
element, with the content indented one level to the right.
Renders an FO list-item-body
element, with the content indented one level to the right.
Attributes
Renders an FO list-item-label
element, with the content indented one level to the right.
Renders an FO list-item-label
element, with the content indented one level to the right.
Attributes
Renders an FO inline
element and the specified text, treating it as
"raw", pre-rendered XSL-FO output, so that no escaping of special character will be performed.
Renders only the text itself in case there are no attributes associated with the text.
Renders an FO inline
element and the specified text, treating it as
"raw", pre-rendered XSL-FO output, so that no escaping of special character will be performed.
Renders only the text itself in case there are no attributes associated with the text.
Attributes
Renders an FO inline
element and the specified text.
Renders only the text itself in case there are no
attributes associated with the text.
Renders an FO inline
element and the specified text.
Renders only the text itself in case there are no
attributes associated with the text.
Attributes
Renders an FO block
element and the specified text, preserving
all whitespace. Renders only the text itself in case there are no
attributes associated with the text.
Renders an FO block
element and the specified text, preserving
all whitespace. Renders only the text itself in case there are no
attributes associated with the text.
Attributes
Renders an FO inline
element and the specified text, preserving
all whitespace. Renders only the text itself in case there are no
attributes associated with the text.
Renders an FO inline
element and the specified text, preserving
all whitespace. Renders only the text itself in case there are no
attributes associated with the text.
Attributes
Obtains a Citation with the specified reference name and, if it exists, passes it to the provided render function.
Obtains a Citation with the specified reference name and, if it exists, passes it to the provided render function.
Attributes
Obtains a Footnote with the specified reference name and, if it exists, passes it to the provided render function.
Obtains a Footnote with the specified reference name and, if it exists, passes it to the provided render function.
Attributes
Inherited methods
Renders the specified attribute including a preceding space character.
Renders the specified attribute including a preceding space character.
Attributes
- Inherited from:
- TagFormatter
Renders the specified attributes (passed as name-value tuples), including a preceding space character.
Renders the specified attributes (passed as name-value tuples), including a preceding space character.
Attributes
- Inherited from:
- TagFormatter
Renders the specified element on the current line.
Renders the specified elements, each of them on a new line using the current level of indentation.
Renders the specified elements, each of them on a new line using the current level of indentation.
Attributes
- Inherited from:
- BaseFormatter
Renders the specified elements, all on the same line, without any separators.
Renders the specified elements, all on the same line, without any separators.
Attributes
- Inherited from:
- BaseFormatter
Renders an HTML/XML comment.
Renders an element with the specified tag name, attributes derived from the style hint and content consisting of the provided child elements, all rendered on the same line.
Renders an element with the specified tag name, attributes derived from the style hint and content consisting of the provided child elements, all rendered on the same line.
Attributes
- Inherited from:
- TagFormatter
Renders an empty element with the specified tag name.
Renders an empty element with the specified tag name and attributes derived from the style hint.
Renders an empty element with the specified tag name and attributes derived from the style hint.
Attributes
- Inherited from:
- TagFormatter
Filters out all unsupported attributes for the specified tagName and return a new sequence containing only attributes valid for that tag.
Filters out all unsupported attributes for the specified tagName and return a new sequence containing only attributes valid for that tag.
Attributes
- attributes
the attributes to filter as a sequence of key-name tuples
- tagName
the name of tag to filter the attributes for
- Returns:
a new sequence containing only attributes valid for that tag
- Inherited from:
- FOProperties
Renders the specified string only when the given message has at least the minimum message level defined for this formatter instance.
Renders the specified string only when the given message has at least the minimum message level defined for this formatter instance.
Attributes
- Inherited from:
- BaseFormatter
Invokes the specified render function with a new formatter that is indented one level to the right of this formatter.
Invokes the specified render function with a new formatter that is indented one level to the right of this formatter.
Attributes
- Inherited from:
- BaseFormatter
Renders the specified elements, each of them on a new line with the indentation increased one level to the right.
Renders the specified elements, each of them on a new line with the indentation increased one level to the right.
Attributes
- Inherited from:
- BaseFormatter
Renders an element with the specified tag name, attributes derived from the style hint and indented content consisting of the provided child elements.
Renders an element with the specified tag name, attributes derived from the style hint and indented content consisting of the provided child elements.
Attributes
- Inherited from:
- TagFormatter
Filters empty values from the provided list of name-value pairs.
Filters empty values from the provided list of name-value pairs.
Attributes
- Inherited from:
- TagFormatter
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Renders an element with the specified tag name, attributes derived from the style hint and content based on the provided string that is interpreted as already rendered in the target format. That means that no character escaping will be performed on the provided content.
Renders an element with the specified tag name, attributes derived from the style hint and content based on the provided string that is interpreted as already rendered in the target format. That means that no character escaping will be performed on the provided content.
Attributes
- Inherited from:
- TagFormatter
Renders the specified string on the same line, with all special XML/HTML characters converted to entities.
Renders the specified string on the same line, with all special XML/HTML characters converted to entities.
Attributes
- Inherited from:
- TagFormatter
Renders a text element with the specified tag name, attributes derived from the style hint and content based on the provided text content that gets rendered with all special XML/HTML characters converted to entities.
Renders a text element with the specified tag name, attributes derived from the style hint and content based on the provided text content that gets rendered with all special XML/HTML characters converted to entities.
Attributes
- Inherited from:
- TagFormatter
Invokes the specified render function with a formatter that has at least the specified minimum level of indentation. If this instance already has an indentation equal or greater to this value, the current level of indentation will be kept.
Invokes the specified render function with a formatter that has at least the specified minimum level of indentation. If this instance already has an indentation equal or greater to this value, the current level of indentation will be kept.
Attributes
- Inherited from:
- BaseFormatter
Invokes the specified render function with a new formatter that has all indentation disabled.
Invokes the specified render function with a new formatter that has all indentation disabled.
This is usually only required when rendering literal elements or source code where rendered whitespace would be significant.
Attributes
- Inherited from:
- BaseFormatter
Inherited fields
A newline character followed by whitespace matching the indentation level of this instance.
A newline character followed by whitespace matching the indentation level of this instance.
Attributes
- Inherited from:
- BaseFormatter