Packages

c

laika.render

BaseFormatter

abstract class BaseFormatter[Rep <: BaseFormatter[Rep]] extends AnyRef

API basis for renderers that produce character output.

Self Type
Rep
Linear Supertypes
AnyRef, Any
Known Subclasses
FOFormatter, HTMLFormatter, TagFormatter, TextFormatter
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BaseFormatter
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BaseFormatter(renderChild: (Rep, Element) ⇒ String, currentElement: Element, parents: List[Element], indentation: Indentation, messageFilter: MessageFilter)

    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

    indentation

    the indentation mechanism for this formatter

    messageFilter

    the filter to apply before rendering runtime messages

Abstract Value Members

  1. abstract def withChild(element: Element): Rep
    Attributes
    protected
  2. abstract def withIndentation(newIndentation: Indentation): Rep
    Attributes
    protected

Concrete 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 child(element: Element): String

    Renders the specified element on the current line.

  6. def childPerLine(elements: Seq[Element]): String

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

  7. def children(elements: Seq[Element]): String

    Renders the specified elements, all on the same line, without any separators.

  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. 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.

  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def indented(f: (Rep) ⇒ String): String

    Invokes the specified render function with a new formatter that is indented one level to the right of this formatter.

  16. 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.

  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. val newLine: String

    A newline character followed by whitespace matching the indentation level of this instance.

  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  27. def withMinIndentation(minIndent: Int)(f: (Rep) ⇒ 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.

  28. def withoutIndentation(f: (Rep) ⇒ 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.

Inherited from AnyRef

Inherited from Any

Ungrouped