laika.tree

Templates

object Templates

Provides the elements of the document tree which are specific to templates.

In contrast to document trees built from text markup, these elements do not make a distinction between block and inline elements. Therefore all template elements mix in the TemplateSpan trait which extends Span, making it an inline element.

The abstract base classes are not sealed as the tree model is extensible. Renderers should anticipate unknown elements and add fallback rules for those.

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

Type Members

  1. trait BlockResolver extends Element with Block

    Represents a placeholder block element that needs to be resolved in a rewrite step.

  2. abstract class ContextReference[T <: Span] extends Element with SpanResolver

    Represents a reference to a value from the context of the current document.

  3. case class EmbeddedRoot(content: Seq[Block], options: Options = laika.tree.Elements.NoOpt) extends Element with TemplateSpan with BlockContainer[EmbeddedRoot] with Product with Serializable

    The root element of a document tree (originating from text markup) inside a template.

  4. case class MarkupContextReference(ref: String, options: Options = laika.tree.Elements.NoOpt) extends ContextReference[Span] with Product with Serializable

    A context reference specifically for use in markup documents.

  5. trait SpanResolver extends Element with Span

    Represents a placeholder inline element that needs to be resolved in a rewrite step.

  6. case class TemplateContextReference(ref: String, options: Options = laika.tree.Elements.NoOpt) extends ContextReference[TemplateSpan] with TemplateSpan with Product with Serializable

    A context reference specifically for use in template documents.

  7. case class TemplateDocument(path: Path, content: TemplateRoot, config: Config = ...) extends Product with Serializable

    A template document containing the element tree of a parsed template and its extracted configuration section (if present).

  8. case class TemplateElement(element: Element, options: Options = laika.tree.Elements.NoOpt) extends Element with TemplateSpan with ElementTraversal[TemplateElement] with Product with Serializable

    Wraps a generic element that otherwise could not be placed directly into a template document tree.

  9. case class TemplateRoot(content: Seq[TemplateSpan], options: Options = laika.tree.Elements.NoOpt) extends Element with Block with SpanContainer[TemplateRoot] with Product with Serializable

    The root element of a template document tree.

  10. trait TemplateSpan extends Element with Span

    The base type for all inline elements that can be found in a template.

  11. case class TemplateSpanSequence(content: Seq[TemplateSpan], options: Options = laika.tree.Elements.NoOpt) extends Element with TemplateSpan with SpanContainer[TemplateSpanSequence] with Product with Serializable

    A generic container element containing a list of template spans.

  12. case class TemplateString(content: String, options: Options = laika.tree.Elements.NoOpt) extends Element with TemplateSpan with TextContainer with Product with Serializable

    A simple string element, representing the parts of a template that are not detected as special markup constructs and treated as raw text.

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. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  17. def rewriteRules(context: DocumentContext): PartialFunction[Element, Option[Element]]

    The default rewrite rules for template documents, responsible for replacing all span and block resolvers with the final resolved element they produce based on the specified document context.

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

    Definition Classes
    AnyRef

  19. def toString(): String

    Definition Classes
    AnyRef → Any

  20. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped