Packages

c

laika.ast

Selection

case class Selection(name: String, choices: Seq[Choice], options: Options = NoOpt) extends Element with Block with RewritableContainer with Product with Serializable

Represents a selection of choices (alternatives) that represent the same content in different ways, e.g. a code sample in Scala or Java or a build setup in sbt vs. Maven. In the final output these will usually be rendered in a way to allow for a convenient selection.

Linear Supertypes
RewritableContainer, Block, Element, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Selection
  2. RewritableContainer
  3. Block
  4. Element
  5. Serializable
  6. Product
  7. Equals
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Selection(name: String, choices: Seq[Choice], options: Options = NoOpt)

Type Members

  1. type Self = Selection
    Definition Classes
    SelectionRewritableContainerBlockElement

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. val choices: Seq[Choice]
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  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. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  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. val name: String
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. val options: Options
    Definition Classes
    SelectionElement
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. def rewriteChildren(rules: RewriteRules): Selection

    Rewrites all children of this container based on the specified rules.

    Rewrites all children of this container based on the specified rules.

    Concrete types are expected to support rewriting at least for all standard block, span and template span elements they contain, plus optionally for any other elements that have custom support for rewriting.

    Definition Classes
    SelectionRewritableContainer
  22. def rewriteSpans(rule: RewriteRule[Span]): Self

    Rewrites all span children of this container based on the specified rules.

    Rewrites all span children of this container based on the specified rules.

    Concrete types are expected to support rewriting at least for all standard block, span and template span elements they contain, plus optionally for any other elements that have custom support for rewriting.

    Definition Classes
    RewritableContainer
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  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): Selection

    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
    SelectionElement
  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 RewritableContainer

Inherited from Block

Inherited from Element

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped