Packages

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.

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

Linear Supertypes
Serializable, Serializable, Product, Equals, FOProperties, TagFormatter[FOFormatter], BaseFormatter[FOFormatter], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FOFormatter
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. FOProperties
  7. TagFormatter
  8. BaseFormatter
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FOFormatter(renderChild: (FOFormatter, Element) ⇒ String, currentElement: Element, parents: List[Element], pathTranslator: PathTranslator, path: Path, styles: StyleDeclarationSet, indentation: Indentation, messageFilter: MessageFilter)

    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

Type Members

  1. type StyleHint = Element
    Definition Classes
    FOFormatter → TagFormatter

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def attribute(name: String, value: String): String

    Renders the specified attribute including a preceding space character.

    Renders the specified attribute including a preceding space character.

    Definition Classes
    TagFormatter
  6. def attributes(tag: String, element: Element, attrs: Seq[(String, String)]): String

    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.

    Definition Classes
    FOFormatter → TagFormatter
  7. def attributes(attrs: Seq[(String, String)]): String

    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.

    Definition Classes
    TagFormatter
  8. def block(styleHint: Element, attr: (String, String)*): String

    Renders an empty FO block element.

  9. def block(styleHint: Element, content: Seq[Span], attr: (String, String)*): String

    Renders an FO block element and the specified nested spans on the same line.

  10. def blockContainer(styleHint: Element, content: Seq[Block], attr: (String, String)*): String

    Renders an FO block element, containing nested blocks.

    Renders an FO block element, containing nested blocks. The content will be rendered indented one level to the right.

  11. def blockWithWS(styleHint: Element, content: Seq[Span], attr: (String, String)*): String

    Renders an FO block element and the specified nested spans, preserving all whitespace within the text elements of those spans.

  12. def bookmark(bookmark: NavigationItem): String

    Renders an FO bookmark element and all of its nested bookmarks.

  13. def bookmarkTitle(title: BookmarkTitle): String

    Renders an FO bookmark-title element.

  14. def bookmarkTree(tree: NavigationList): String

    Renders an FO bookmark-tree element and all of its nested bookmarks.

  15. def buildId(path: Path): String

    Generates an id that is unique within the entire document tree for the specified path of the target document and its local reference.

  16. def buildLocalId(ref: String): String

    Generates an id that is unique within the entire document tree for the specified local reference.

  17. def child(element: Element): String

    Renders the specified element on the current line.

    Renders the specified element on the current line.

    Definition Classes
    BaseFormatter
  18. def childPerLine(elements: Seq[Element]): String

    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.

    Definition Classes
    BaseFormatter
  19. def children(elements: Seq[Element]): String

    Renders the specified elements, all on the same line, without any separators.

    Renders the specified elements, all on the same line, without any separators.

    Definition Classes
    BaseFormatter
  20. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  21. def comment(content: String): String

    Renders an HTML/XML comment.

    Renders an HTML/XML comment.

    Definition Classes
    TagFormatter
  22. val currentElement: Element
  23. def element(tagName: String, styleHint: StyleHint, content: Seq[Element], attrs: (String, String)*): String

    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.

    Definition Classes
    TagFormatter
  24. def emptyElement(tagName: String): String

    Renders an empty element with the specified tag name.

    Renders an empty element with the specified tag name.

    Definition Classes
    TagFormatter
  25. def emptyElement(tagName: String, styleHint: StyleHint, attrs: (String, String)*): String

    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.

    Definition Classes
    TagFormatter
  26. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def externalGraphic(styleHint: Element, src: String, width: Option[Length], height: Option[Length]): String

    Renders an FO external-graphic element.

  28. def externalLink(styleHint: Element, url: String, content: Seq[Span], attr: (String, String)*): String

    Renders an FO basic-link element for an external target.

  29. def filterAttributes(tagName: String, attributes: Seq[(String, String)]): Seq[(String, String)]

    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.

    tagName

    the name of tag to filter the attributes for

    attributes

    the attributes to filter as a sequence of key-name tuples

    returns

    a new sequence containing only attributes valid for that tag

    Definition Classes
    FOProperties
  30. def footnote(styleHint: Element, label: String, body: Seq[Block], options: Options): String

    Renders an FO footnote element, with the body indented one level to the right.

  31. def forMessage(message: RuntimeMessage)(whenEnabled: String): String

    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.

    Definition Classes
    BaseFormatter
  32. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. val indentation: Indentation
  34. def indented(f: (FOFormatter) ⇒ String): String

    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.

    Definition Classes
    BaseFormatter
  35. def indentedChildren(elements: Seq[Element]): String

    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.

    Definition Classes
    BaseFormatter
  36. def indentedElement(tagName: String, styleHint: StyleHint, content: Seq[Element], attrs: (String, String)*): String

    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.

    Definition Classes
    TagFormatter
  37. def inline(styleHint: Element, content: Seq[Span], attr: (String, String)*): String

    Renders an FO inline element and the specified nested spans on the same line.

  38. def internalLink(styleHint: Element, target: Path, content: Seq[Span], attr: (String, String)*): String

    Renders an FO basic-link element for an internal target.

  39. def internalLinkTarget(element: Element): String

    Renders an FO block or inline element for this internal link target, depending on whether it is inside a BlockContainer or SpanContainer.

  40. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  41. def listBlock(styleHint: Element, content: Seq[ListItem], attr: (String, String)*): String

    Renders an FO list-block element, and the specified list items.

    Renders an FO list-block element, and the specified list items. The content will be rendered indented one level to the right.

  42. def listItem(styleHint: Element, label: Seq[Span], body: Seq[Block], attr: (String, String)*): String

    Renders an FO list-item element with the specified label and body.

    Renders an FO list-item element with the specified label and body. The content will be rendered indented one level to the right.

  43. def listItemBody(styleHint: Element, content: Seq[Block], attr: (String, String)*): String

    Renders an FO list-item-body element, with the content indented one level to the right.

  44. def listItemLabel(styleHint: Element, content: Block, attr: (String, String)*): String

    Renders an FO list-item-label element, with the content indented one level to the right.

  45. val messageFilter: MessageFilter
  46. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  47. val newLine: String

    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.

    Definition Classes
    BaseFormatter
  48. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  49. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  50. def optAttributes(attrs: (String, Option[String])*): Seq[(String, String)]

    Filters empty values from the provided list of name-value pairs.

    Filters empty values from the provided list of name-value pairs.

    Definition Classes
    TagFormatter
  51. val parents: List[Element]
  52. val path: Path
  53. val pathTranslator: PathTranslator
  54. def rawElement(tagName: String, styleHint: StyleHint, content: String, attrs: (String, String)*): String

    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.

    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.

    Definition Classes
    TagFormatter
  55. def rawText(styleHint: Element, content: String, attr: (String, String)*): String

    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 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.

  56. val renderChild: (FOFormatter, Element) ⇒ String
  57. val styles: StyleDeclarationSet
  58. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  59. def text(styleHint: Element, content: String, attr: (String, String)*): String

    Renders an FO inline element and the specified 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.

  60. def text(str: String): String

    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.

    Definition Classes
    TagFormatter
  61. def textBlockWithWS(styleHint: Element, content: String, attr: (String, String)*): String

    Renders an FO block element and the specified text, preserving all whitespace.

    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.

  62. def textElement(tagName: String, styleHint: StyleHint, txt: String, attrs: (String, String)*): String

    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.

    Definition Classes
    TagFormatter
  63. def textWithWS(styleHint: Element, content: String, attr: (String, String)*): String

    Renders an FO inline element and the specified text, preserving all whitespace.

    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.

  64. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  65. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  66. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  67. def withChild(element: Element): FOFormatter
    Attributes
    protected
    Definition Classes
    FOFormatter → BaseFormatter
  68. def withCitation(ref: String)(f: (Citation) ⇒ String): String

    Obtains a Citation with the specified reference name and, if it exists, passes it to the provided render function.

  69. def withFootnote(ref: String)(f: (Footnote) ⇒ String): String

    Obtains a Footnote with the specified reference name and, if it exists, passes it to the provided render function.

  70. def withIndentation(newIndentation: Indentation): FOFormatter
    Attributes
    protected
    Definition Classes
    FOFormatter → BaseFormatter
  71. def withMinIndentation(minIndent: Int)(f: (FOFormatter) ⇒ String): String

    Invokes the specified render function with a formatter that has at least the specified minimum level of indentation.

    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.

    Definition Classes
    BaseFormatter
  72. def withoutIndentation(f: (FOFormatter) ⇒ String): String

    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.

    Definition Classes
    BaseFormatter

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from FOProperties

Inherited from TagFormatter[FOFormatter]

Inherited from BaseFormatter[FOFormatter]

Inherited from AnyRef

Inherited from Any

Ungrouped