Class

laika.render

HTMLWriter

Related Doc: package render

Permalink

class HTMLWriter extends TagWriter

API for renderers that produce HTML output.

Linear Supertypes
TagWriter, TextWriter, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HTMLWriter
  2. TagWriter
  3. TextWriter
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HTMLWriter(out: (String) ⇒ Unit, render: (Element) ⇒ Unit, root: Element, newLine: String = "\n", formatted: Boolean = true)

    Permalink

    out

    the render function to write string values to

    render

    the render function for writing elements

    root

    the root element to render

    newLine

    the newline character to use

    formatted

    whether the output is formatted (adding indentation and newlines)

Value Members

  1. final def !=(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def <<(element: Element): HTMLWriter.this.type

    Permalink

    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
  4. def <<(elements: Seq[Element]): HTMLWriter.this.type

    Permalink

    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
  5. def <<(str: String): HTMLWriter.this.type

    Permalink

    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
  6. def <<&(str: String): HTMLWriter.this.type

    Permalink

    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
  7. def <<<(elements: Seq[Span]): HTMLWriter.this.type

    Permalink

    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
  8. def <<<&(str: String): HTMLWriter.this.type

    Permalink

    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
  9. def <<@(tag: String, element: Element, attrs: (String, Any)*): HTMLWriter.this.type

    Permalink

    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
  10. def <<@(tag: String, options: Options, attrs: (String, Any)*): HTMLWriter.this.type

    Permalink

    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
  11. def <<@(attrs: (String, Any)*): HTMLWriter.this.type

    Permalink

    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
  12. def <<@(name: String, value: Any): HTMLWriter.this.type

    Permalink

    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
  13. def <<@(name: String, value: String): HTMLWriter.this.type

    Permalink

    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
  14. def <<@(name: String, value: Option[String]): HTMLWriter.this.type

    Permalink

    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
  15. def <<@/(tag: String, element: Element, attrs: (String, Any)*): HTMLWriter.this.type

    Permalink

    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
  16. def <<@/(tag: String, options: Options, attrs: (String, Any)*): HTMLWriter.this.type

    Permalink

    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
  17. def <<|(element: Element): HTMLWriter.this.type

    Permalink

    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
  18. def <<|(elements: Seq[Element]): HTMLWriter.this.type

    Permalink

    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
  19. def <<|(str: String): HTMLWriter.this.type

    Permalink

    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
  20. def <<|&(str: String): HTMLWriter.this.type

    Permalink

    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
  21. def <<|>(element: Element): HTMLWriter.this.type

    Permalink

    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
  22. def <<|>(elements: Seq[Element]): HTMLWriter.this.type

    Permalink

    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
  23. def <<|>(str: String): HTMLWriter.this.type

    Permalink

    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
  24. def <<|>&(str: String): HTMLWriter.this.type

    Permalink

    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
  25. def <|: HTMLWriter.this.type

    Permalink

    Writes a new line character sequence.

    Writes a new line character sequence.

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

    Permalink
    Definition Classes
    AnyRef → Any
  27. object Indent

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

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

    Permalink

    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
    HTMLWriterTagWriter
  30. def attributes(tag: String, options: Options, attrs: Seq[(String, Any)]): Seq[(String, Any)]

    Permalink

    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
    HTMLWriterTagWriter
  31. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  33. def equals(arg0: Any): Boolean

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

    Permalink

    Replaces all special XML/HTML characters with entities.

    Replaces all special XML/HTML characters with entities.

    Attributes
    protected
    Definition Classes
    TagWriter
  35. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  36. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  37. def hashCode(): Int

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

    Permalink

    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
  39. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  40. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  41. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  42. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  43. def parents: List[Element]

    Permalink
    Attributes
    protected
    Definition Classes
    TextWriter
  44. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  45. def toString(): String

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

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

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

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

    Permalink

    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

Inherited from TagWriter

Inherited from TextWriter

Inherited from AnyRef

Inherited from Any

Ungrouped