Packages

c

laika.ast

TemplateContextReference

case class TemplateContextReference(ref: Key, required: Boolean, source: SourceFragment, options: Options = NoOpt) extends ContextReference[TemplateSpan] with TemplateSpan with Product with Serializable

A context reference specifically for use in template documents.

Linear Supertypes
TemplateSpan, ContextReference[TemplateSpan], SpanResolver, Unresolved, Span, Element, Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TemplateContextReference
  2. TemplateSpan
  3. ContextReference
  4. SpanResolver
  5. Unresolved
  6. Span
  7. Element
  8. Serializable
  9. Serializable
  10. Product
  11. Equals
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TemplateContextReference(ref: Key, required: Boolean, source: SourceFragment, options: Options = NoOpt)

Type Members

  1. type Self = TemplateContextReference
    Definition Classes
    TemplateContextReferenceSpanElement

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

    Indicates whether this element has an id assigned.

    Indicates whether this element has an id assigned.

    Definition Classes
    Element
  10. 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
  11. def invalid(cError: ConfigError): InvalidSpan
    Attributes
    protected
    Definition Classes
    ContextReference
  12. def invalidType(value: ConfigValue): InvalidSpan
    Attributes
    protected
    Definition Classes
    ContextReference
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. 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
  15. def missing: InvalidSpan
    Attributes
    protected
    Definition Classes
    ContextReference
  16. 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
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. val options: Options
    Definition Classes
    TemplateContextReferenceElement
  21. val ref: Key
  22. val required: Boolean
  23. def resolve(cursor: DocumentCursor): Span
    Definition Classes
    ContextReferenceSpanResolver
  24. def result(value: ConfigResult[Option[ConfigValue]]): TemplateSpan
  25. val 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
    TemplateContextReferenceUnresolved
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. lazy val 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
    TemplateContextReferenceUnresolved
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  31. 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
  32. def withOptions(options: Options): TemplateContextReference

    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
    TemplateContextReferenceElement
  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 TemplateSpan

Inherited from ContextReference[TemplateSpan]

Inherited from SpanResolver

Inherited from Unresolved

Inherited from Span

Inherited from Element

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped