laika.render

HTMLWriter

class HTMLWriter extends TextWriter

API for renderers that produce HTML output. Extends the base TextWriter and adds methods for writing text with special HTML characters escaped and for conveniently writing attributes.

Linear Supertypes
TextWriter, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HTMLWriter
  2. TextWriter
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

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

    out
    render
    newLine

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

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

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

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

  7. def <<&(str: String): HTMLWriter.this.type

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

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

  9. def <<<&(str: String): HTMLWriter.this.type

    Writes the specified string to the output, without any indentation, with all special HTML characters converted to HTML entities.

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

  10. def <<@(tag: String, options: Options, attrs: (String, Any)*): HTMLWriter.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. The latter also allow for overriding of class and id attributes derived from the Options instance.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  21. def <|: HTMLWriter.this.type

    Writes a new line character sequence.

    Writes a new line character sequence.

    Definition Classes
    TextWriter

  22. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  23. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  24. object Indent

    Attributes
    protected
    Definition Classes
    TextWriter

  25. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  26. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  28. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  29. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  30. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  31. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  32. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  33. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  34. final def notify(): Unit

    Definition Classes
    AnyRef

  35. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  37. def toString(): String

    Definition Classes
    AnyRef → Any

  38. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  40. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  41. def withoutIndentation(f: ⇒ Any): HTMLWriter.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

Inherited from TextWriter

Inherited from AnyRef

Inherited from Any

Ungrouped