Packages

c

laika.ast

IconReference

case class IconReference(key: String, source: SourceFragment, options: Options = NoOpt) extends Element with SpanResolver with Reference with Product with Serializable

A reference to an icon by key.

The icon must have been registered with the global configuration to be accessible by this node type. The indirection provided by this key allows to more easily swap entire icon sets without touching any code.

Linear Supertypes
Reference, SpanResolver, Unresolved, Span, Element, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IconReference
  2. Reference
  3. SpanResolver
  4. Unresolved
  5. Span
  6. Element
  7. Serializable
  8. Product
  9. Equals
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new IconReference(key: String, source: SourceFragment, options: Options = NoOpt)

Type Members

  1. type Self = IconReference
    Definition Classes
    IconReferenceReferenceSpanElement

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 finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  8. final def getClass(): Class[_ <: AnyRef]
    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. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val key: String
  13. 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
  14. 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
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. val options: Options
    Definition Classes
    IconReferenceElement
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. def resolve(cursor: DocumentCursor): Span
    Definition Classes
    IconReferenceSpanResolver
  21. 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
    IconReferenceUnresolved
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. 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
    IconReferenceUnresolved
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. 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
  28. def withOptions(options: Options): IconReference

    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
    IconReferenceElement
  29. 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
  30. 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
  31. 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
  32. 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 Reference

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