Packages

c

laika.ast

ContextReference

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

Represents a reference to a value from the context of the current document. The ref attribute is a simple path expression in dot notation for accessing properties of an object (or keys of a Map).

The root elements accessible to such a reference are:

  • document: the current document with all of its public properties
  • parent: the parent tree of the current document
  • root: the root tree
  • config: all configuration values for the current document, including those inherited from parent trees
Linear Supertypes
SpanResolver, Unresolved, Span, Element, Serializable, Product, Equals, AnyRef, Any
Known Subclasses
MarkupContextReference, TemplateContextReference
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ContextReference
  2. SpanResolver
  3. Unresolved
  4. Span
  5. Element
  6. Serializable
  7. Product
  8. Equals
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ContextReference(ref: Key, source: SourceFragment)

Type Members

  1. abstract type Self <: Span
    Definition Classes
    Span → Element

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean
    Definition Classes
    Equals
  2. abstract def options: Options
    Definition Classes
    Element
  3. abstract def productArity: Int
    Definition Classes
    Product
  4. abstract def productElement(n: Int): Any
    Definition Classes
    Product
  5. abstract def result(value: ConfigResult[Option[ConfigValue]]): T
  6. abstract def source: SourceFragment

    The fragment from the input source that produced this element.

    The fragment from the input source that produced this element. Can be used to report the line of the error or to render a fallback that simply renders back the consumed input.

    Definition Classes
    Unresolved
  7. abstract def unresolvedMessage: String

    An error message to display when this element remains unresolved until after the final AST transformation step.

    An error message to display when this element remains unresolved until after the final AST transformation step.

    Definition Classes
    Unresolved
  8. abstract def withOptions(options: Options): Self

    Returns a new instance of this element with the specified options replacing the current value.

    Returns a new instance of this element with the specified options replacing the current value.

    Definition Classes
    Element

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

    Indicates whether this element has an id assigned.

    Indicates whether this element has an id assigned.

    Definition Classes
    Element
  11. def hasStyle(name: String): Boolean

    Indicates whether this element has the specified style assigned.

    Indicates whether this element has the specified style assigned.

    Definition Classes
    Element
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def invalid(cError: ConfigError): InvalidSpan
    Attributes
    protected
  14. def invalidType(value: ConfigValue): InvalidSpan
    Attributes
    protected
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def mergeOptions(opt: Options): Self

    Returns a new instance of this element with its options merged with the specified options.

    Returns a new instance of this element with its options merged with the specified options.

    Definition Classes
    Element
  17. def missing: InvalidSpan
    Attributes
    protected
  18. def modifyOptions(f: (Options) => Options): Self

    Returns a new instance of this element with the new options obtained from applying the specified function to the existing value.

    Returns a new instance of this element with the new options obtained from applying the specified function to the existing value.

    Definition Classes
    Element
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def productElementName(n: Int): String
    Definition Classes
    Product
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. def productIterator: Iterator[Any]
    Definition Classes
    Product
  25. def productPrefix: String
    Definition Classes
    Product
  26. def resolve(cursor: DocumentCursor): Span
    Definition Classes
    ContextReference → SpanResolver
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. def withId(id: String): Self

    Returns a new instance of this element with its id set to the specified value, overriding any existing value.

    Returns a new instance of this element with its id set to the specified value, overriding any existing value.

    Definition Classes
    Element
  33. def withStyle(name: String): Self

    Returns a new instance of this element with the specified style added to its existing styles.

    Returns a new instance of this element with the specified style added to its existing styles.

    Definition Classes
    Element
  34. def withStyles(styles: Iterable[String]): Self

    Returns a new instance of this element with the specified styles added to its existing styles.

    Returns a new instance of this element with the specified styles added to its existing styles.

    Definition Classes
    Element
  35. def withStyles(style: String, styles: String*): Self

    Returns a new instance of this element with the specified styles added to its existing styles.

    Returns a new instance of this element with the specified styles added to its existing styles.

    Definition Classes
    Element
  36. def withoutId: Self

    Returns a new instance of this element without its id.

    Returns a new instance of this element without its id.

    Definition Classes
    Element

Inherited from SpanResolver

Inherited from Unresolved

Inherited from Span

Inherited from Element

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped