FOWriter

Instance Constructors

new FOWriter(out: (String) ⇒ Unit, render: (Element) ⇒ Unit, root: Element, path: Path, styles: StyleDeclarationSet, newLine: String = "\n", formatted: Boolean = true)

out
the render function to write string values to
render
the render function for writing elements
root
the root element to render
path
the path of the document getting rendered, used for generating unique ids
styles
the styles to apply when writing the attributes of an element
newLine
the newline character to use
formatted
whether the output is formatted (adding indentation and newlines)

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def <<(element: Element): FOWriter.this.type

Writes the specified element to the output, on the same line.
Writes the specified element to the output, on the same line.

Definition Classes
TextWriter
def <<(elements: Seq[Element]): FOWriter.this.type

Writes the specified elements to the output, all on the same line.
Writes the specified elements to the output, all on the same line.

Definition Classes
TextWriter
def <<(str: String): FOWriter.this.type

Writes the specified string to the output, on the same line.
Writes the specified string to the output, on the same line.

Definition Classes
TextWriter
def <<&(str: String): FOWriter.this.type

Writes the specified string to the output, on the same line, with all special XML/HTML characters converted to entities.
Writes the specified string to the output, on the same line, with all special XML/HTML characters converted to entities.

Definition Classes
TagWriter
def <<<(elements: Seq[Span]): FOWriter.this.type

Writes the specified span elements to the output, on the same line, while omitting indentation for all text spans written with one of the methods that convert special characters.
Writes the specified span elements to the output, on the same line, while omitting indentation for all text spans written with one of the methods that convert special characters.

Definition Classes
TagWriter
def <<<&(str: String): FOWriter.this.type

Writes the specified string to the output, without any indentation, with all special XML/HTML characters converted to entities.
Writes the specified string to the output, without any indentation, with all special XML/HTML characters converted to entities. This is needed for writing blocks like those enclosed in <pre&rt; tags where whitespace is significant.

Definition Classes
TagWriter
def <<@(tag: String, element: Element, attrs: (String, Any)*): FOWriter.this.type

Writes an opening tag with attributes derived from both the element parameter and the subsequent tuples.
Writes an opening tag with attributes derived from both the element parameter and the subsequent tuples.

Definition Classes
TagWriter
def <<@(tag: String, options: Options, attrs: (String, Any)*): FOWriter.this.type

Writes an opening tag with attributes derived from both the options parameter and the subsequent tuples.
Writes an opening tag with attributes derived from both the options parameter and the subsequent tuples.

Definition Classes
TagWriter
def <<@(attrs: (String, Any)*): FOWriter.this.type

Writes the specified attributes (passed as name-value tuples), including a preceding space character.
Writes the specified attributes (passed as name-value tuples), including a preceding space character. In cases where the value is None nothing will be written to the output.

Definition Classes
TagWriter
def <<@(name: String, value: Any): FOWriter.this.type

Writes the specified name and value as an optional attribute, including a preceding space character.
Writes the specified name and value as an optional attribute, including a preceding space character. In case the value is None nothing will be written to the output.

Attributes
protected
Definition Classes
TagWriter
def <<@(name: String, value: String): FOWriter.this.type

Writes the specified name and value as an attribute, including a preceding space character.
Writes the specified name and value as an attribute, including a preceding space character.

Definition Classes
TagWriter
def <<@(name: String, value: Option[String]): FOWriter.this.type

Writes the specified name and value as an optional attribute, including a preceding space character.
Writes the specified name and value as an optional attribute, including a preceding space character. In case the value is None nothing will be written to the output.

Definition Classes
TagWriter
def <<@/(tag: String, element: Element, attrs: (String, Any)*): FOWriter.this.type

Writes an empty tag with attributes derived from both the element parameter and the subsequent tuples.
Writes an empty tag with attributes derived from both the element parameter and the subsequent tuples.

Definition Classes
TagWriter
def <<@/(tag: String, options: Options, attrs: (String, Any)*): FOWriter.this.type

Writes an empty tag with attributes derived from both the options parameter and the subsequent tuples.
Writes an empty tag with attributes derived from both the options parameter and the subsequent tuples.

Definition Classes
TagWriter
def <<|(element: Element): FOWriter.this.type

Writes the specified element to the output, on a new line using the current level of indentation.
Writes the specified element to the output, on a new line using the current level of indentation.

Definition Classes
TextWriter
def <<|(elements: Seq[Element]): FOWriter.this.type

Writes the specified elements to the output, each of them on a new line using the current level of indentation.
Writes the specified elements to the output, each of them on a new line using the current level of indentation.

Definition Classes
TextWriter
def <<|(str: String): FOWriter.this.type

Writes the specified string to the output, on a new line using the current level of indentation.
Writes the specified string to the output, on a new line using the current level of indentation.

Definition Classes
TextWriter
def <<|&(str: String): FOWriter.this.type

Writes the specified string to the output, on a new line using the current level of indentation, with all special XML/HTML characters converted to entities.
Writes the specified string to the output, on a new line using the current level of indentation, with all special XML/HTML characters converted to entities.

Definition Classes
TagWriter
def <<|>(element: Element): FOWriter.this.type

Writes the specified element to the output, on a new line and increasing indentation one level to the right.
Writes the specified element to the output, on a new line and increasing indentation one level to the right.

Definition Classes
TextWriter
def <<|>(elements: Seq[Element]): FOWriter.this.type

Writes the specified elements to the output, each of them on a new line with the indentation increased one level to the right.
Writes the specified elements to the output, each of them on a new line with the indentation increased one level to the right.

Definition Classes
TextWriter
def <<|>(str: String): FOWriter.this.type

Writes the specified string to the output, on a new line and increasing indentation one level to the right.
Writes the specified string to the output, on a new line and increasing indentation one level to the right.

Definition Classes
TextWriter
def <<|>&(str: String): FOWriter.this.type

Writes the specified string to the output, on a new line and increasing indentation one level to the right, with all special XML/HTML characters converted to entities.
Writes the specified string to the output, on a new line and increasing indentation one level to the right, with all special XML/HTML characters converted to entities.

Definition Classes
TagWriter
def <|: FOWriter.this.type

Writes a new line character sequence.
Writes a new line character sequence.

Definition Classes
TextWriter
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
object Indent

Attributes
protected
Definition Classes
TextWriter
final def asInstanceOf[T0]: T0

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

Produces the complete sequence of attributes to write for the specified tag.
Produces the complete sequence of attributes to write for the specified tag.

Attributes
protected
Definition Classes
FOWriter → TagWriter
def attributes(tag: String, options: Options, attrs: Seq[(String, Any)]): Seq[(String, Any)]

Produces the complete sequence of attributes to write for the specified tag.
Produces the complete sequence of attributes to write for the specified tag.

Attributes
protected
Definition Classes
FOWriter → TagWriter
def block(element: Element, attr: (String, String)*): FOWriter

Renders an empty FO block element.
def block(element: Element, content: Seq[Span], attr: (String, String)*): FOWriter

Renders an FO block element and the specified nested spans.
def blockContainer(element: Element, content: Seq[Block], attr: (String, String)*): FOWriter

Renders an FO block element, containing nested blocks.
def blockWithWS(element: Element, content: Seq[Span], attr: (String, String)*): FOWriter

Renders an FO block element and the specified nested spans, preserving all whitespace within the text elements of those spans.
def bookmark(bookmark: Bookmark): FOWriter

Renders an FO bookmark element and all of its nested bookmarks.
def bookmarkTitle(title: BookmarkTitle): FOWriter

Renders an FO bookmark-title element.
def bookmarkTree(tree: BookmarkTree): FOWriter

Renders an FO bookmark-tree element and all of its nested bookmarks.
def buildId(path: Path, ref: String): String

Generates a unique id for the specified path of the target document and the local reference.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def escaped(str: String): String

Replaces all special XML/HTML characters with entities.
Replaces all special XML/HTML characters with entities.

Attributes
protected
Definition Classes
TagWriter
def externalGraphic(element: Element, src: String, width: Option[Size], height: Option[Size]): FOWriter

Renders an FO external-graphic element.
def externalLink(element: Element, url: String, content: Seq[Span], attr: (String, String)*): FOWriter

Renders an FO basic-link element for an external target.
def filterAttributes(tagName: String, attributes: Seq[(String, Any)]): Seq[(String, Any)]

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
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def footnote(element: Element, label: String, body: Seq[Block], options: Options): FOWriter

Renders an FO footnote element.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def indented(indent: Int)(block: ⇒ Unit): Unit

Executes the specified block while temporarily shifting the indentation level (if it is greater than the currently active one).
Executes the specified block while temporarily shifting the indentation level (if it is greater than the currently active one).

Definition Classes
TextWriter
def inline(element: Element, content: Seq[Span], attr: (String, String)*): FOWriter

Renders an FO inline element and the specified nested spans.
def internalLink(element: Element, target: String, content: Seq[Span], attr: (String, String)*): FOWriter

Renders an FO basic-link element for an internal target.
def internalLinkTarget(element: Element): FOWriter

Renders an FO block or inline for this internal link target, depending on whether it is inside a BlockContainer or SpanContainer.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def listBlock(element: Element, content: Seq[ListItem], attr: (String, String)*): FOWriter

Renders an FO list-block element, and the specified list items.
def listItem(element: Element, label: Seq[Span], body: Seq[Block], attr: (String, String)*): FOWriter

Renders an FO list-item element with the specified label and body.
def listItemBody(element: Element, content: Seq[Block], attr: (String, String)*): FOWriter

Renders an FO list-item-body element.
def listItemLabel(element: Element, content: Block, attr: (String, String)*): FOWriter

Renders an FO list-item-label element.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def parents: List[Element]

Attributes
protected
Definition Classes
TextWriter
def rawText(element: Element, content: String, attr: (String, String)*): FOWriter

Renders an FO inline element and the specified text, treating it as "raw", prerendered XSL-FO output.
Renders an FO inline element and the specified text, treating it as "raw", prerendered XSL-FO output. Renders only the text itself in case there are no attributes associated with the text.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def text(element: Element, content: String, attr: (String, String)*): FOWriter

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.
def textBlockWithWS(element: Element, content: String, attr: (String, String)*): FOWriter

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.
def textWithWS(element: Element, content: String, attr: (String, String)*): FOWriter

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.
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withoutIndentation(f: ⇒ Any): FOWriter.this.type

Invokes the specified function after switching off the rendering of any indentation for escaped text elements.
Invokes the specified function after switching off the rendering of any indentation for escaped text elements. The old flag gets restored after invocation.

Attributes
protected
Definition Classes
TagWriter

Related Docs: object FOWriter | package render

class FOWriter extends TagWriter with FOProperties

Instance Constructors

new FOWriter(out: (String) ⇒ Unit, render: (Element) ⇒ Unit, root: Element, path: Path, styles: StyleDeclarationSet, newLine: String = "\n", formatted: Boolean = true)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def <<(element: Element): FOWriter.this.type

def <<(elements: Seq[Element]): FOWriter.this.type

def <<(str: String): FOWriter.this.type

def <<&(str: String): FOWriter.this.type

def <<<(elements: Seq[Span]): FOWriter.this.type

def <<<&(str: String): FOWriter.this.type

def <<@(tag: String, element: Element, attrs: (String, Any)*): FOWriter.this.type

def <<@(tag: String, options: Options, attrs: (String, Any)*): FOWriter.this.type

def <<@(attrs: (String, Any)*): FOWriter.this.type

def <<@(name: String, value: Any): FOWriter.this.type

def <<@(name: String, value: String): FOWriter.this.type

def <<@(name: String, value: Option[String]): FOWriter.this.type

def <<@/(tag: String, element: Element, attrs: (String, Any)*): FOWriter.this.type

def <<@/(tag: String, options: Options, attrs: (String, Any)*): FOWriter.this.type

def <<|(element: Element): FOWriter.this.type

def <<|(elements: Seq[Element]): FOWriter.this.type

def <<|(str: String): FOWriter.this.type

def <<|&(str: String): FOWriter.this.type

def <<|>(element: Element): FOWriter.this.type

def <<|>(elements: Seq[Element]): FOWriter.this.type

def <<|>(str: String): FOWriter.this.type

def <<|>&(str: String): FOWriter.this.type

def <|: FOWriter.this.type

final def ==(arg0: Any): Boolean

object Indent

final def asInstanceOf[T0]: T0

def attributes(tag: String, element: Element, attrs: Seq[(String, Any)]): Seq[(String, Any)]

def attributes(tag: String, options: Options, attrs: Seq[(String, Any)]): Seq[(String, Any)]

def block(element: Element, attr: (String, String)*): FOWriter

def block(element: Element, content: Seq[Span], attr: (String, String)*): FOWriter

def blockContainer(element: Element, content: Seq[Block], attr: (String, String)*): FOWriter

def blockWithWS(element: Element, content: Seq[Span], attr: (String, String)*): FOWriter

def bookmark(bookmark: Bookmark): FOWriter

def bookmarkTitle(title: BookmarkTitle): FOWriter

def bookmarkTree(tree: BookmarkTree): FOWriter

def buildId(path: Path, ref: String): String

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def escaped(str: String): String

def externalGraphic(element: Element, src: String, width: Option[Size], height: Option[Size]): FOWriter

def externalLink(element: Element, url: String, content: Seq[Span], attr: (String, String)*): FOWriter

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

def finalize(): Unit

def footnote(element: Element, label: String, body: Seq[Block], options: Options): FOWriter

final def getClass(): Class[_]

def hashCode(): Int

def indented(indent: Int)(block: ⇒ Unit): Unit

def inline(element: Element, content: Seq[Span], attr: (String, String)*): FOWriter

def internalLink(element: Element, target: String, content: Seq[Span], attr: (String, String)*): FOWriter

def internalLinkTarget(element: Element): FOWriter

final def isInstanceOf[T0]: Boolean

def listBlock(element: Element, content: Seq[ListItem], attr: (String, String)*): FOWriter

def listItem(element: Element, label: Seq[Span], body: Seq[Block], attr: (String, String)*): FOWriter

def listItemBody(element: Element, content: Seq[Block], attr: (String, String)*): FOWriter

def listItemLabel(element: Element, content: Block, attr: (String, String)*): FOWriter

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def parents: List[Element]

def rawText(element: Element, content: String, attr: (String, String)*): FOWriter

final def synchronized[T0](arg0: ⇒ T0): T0

def text(element: Element, content: String, attr: (String, String)*): FOWriter

def textBlockWithWS(element: Element, content: String, attr: (String, String)*): FOWriter

def textWithWS(element: Element, content: String, attr: (String, String)*): FOWriter

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withoutIndentation(f: ⇒ Any): FOWriter.this.type

Inherited from FOProperties

Inherited from TagWriter