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(classOf[java.lang.CloneNotSupportedException]) @native()

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

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.Throwable])

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

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

33.  final def getClass(): Class[_ <: AnyRef]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

34.  val indentation: Indentation
35.  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

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

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

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

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

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

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

41.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

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

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

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

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

46.  val messageFilter: MessageFilter
47.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

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

49.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

50.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

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

52.  val parents: List[Element]
53.  val path: Path
54.  val pathTranslator: PathTranslator
55.  def productElementNames: Iterator[String]

    Definition Classes

    Product

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

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

58.  val renderChild: (FOFormatter, Element) => String
59.  val styles: StyleDeclarationSet
60.  final def synchronized[T0](arg0: => T0): T0

    Definition Classes

    AnyRef

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

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

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

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

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

66.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

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

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

68.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException]) @native()

69.  def withChild(element: Element): FOFormatter

    Attributes

    protected

    Definition Classes

    FOFormatter → BaseFormatter

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

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

72.  def withIndentation(newIndentation: Indentation): FOFormatter

    Attributes

    protected

    Definition Classes

    FOFormatter → BaseFormatter

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

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