Packages

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.

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

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

Instance Constructors

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

    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

Type Members

  1. type StyleHint = Options
    Definition Classes
    HTMLFormatter → 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, styleHint: StyleHint, 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
    HTMLFormatter → 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 child(element: Element): String

    Renders the specified element on the current line.

    Renders the specified element on the current line.

    Definition Classes
    BaseFormatter
  9. 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
  10. 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
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  12. val closeEmptyTags: Boolean
  13. def comment(content: String): String

    Renders an HTML/XML comment.

    Renders an HTML/XML comment.

    Definition Classes
    TagFormatter
  14. val currentElement: Element
  15. 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
  16. 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
    HTMLFormatter → TagFormatter
  17. 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
    HTMLFormatter → TagFormatter
  18. val emptyTagClosingChar: String
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. 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
  21. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. val indentation: Indentation
  23. def indented(f: (HTMLFormatter) ⇒ 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
  24. 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
  25. 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
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. val messageFilter: MessageFilter
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. 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
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. 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
  33. val parents: List[Element]
  34. val path: Path
  35. val pathTranslator: PathTranslator
  36. 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
  37. val renderChild: (HTMLFormatter, Element) ⇒ String
  38. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  39. 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
  40. 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
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. def withChild(element: Element): HTMLFormatter
    Attributes
    protected
    Definition Classes
    HTMLFormatter → BaseFormatter
  45. def withIndentation(newIndentation: Indentation): HTMLFormatter
    Attributes
    protected
    Definition Classes
    HTMLFormatter → BaseFormatter
  46. def withMinIndentation(minIndent: Int)(f: (HTMLFormatter) ⇒ 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
  47. def withoutIndentation(f: (HTMLFormatter) ⇒ 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 TagFormatter[HTMLFormatter]

Inherited from BaseFormatter[HTMLFormatter]

Inherited from AnyRef

Inherited from Any

Ungrouped