Class

laika.rst.ast

OptionListItem

Related Doc: package ast

Permalink

case class OptionListItem(programOptions: Seq[ProgramOption], content: Seq[Block], options: Options = NoOpt) extends Element with ListItem with BlockContainer[OptionListItem] with Product with Serializable

A single item in an option list. The content property serves as the description of the option.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OptionListItem
  2. Serializable
  3. Serializable
  4. BlockContainer
  5. ElementContainer
  6. ElementTraversal
  7. Container
  8. ListItem
  9. Customizable
  10. Element
  11. Product
  12. Equals
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OptionListItem(programOptions: Seq[ProgramOption], content: Seq[Block], options: Options = NoOpt)

    Permalink

Type Members

  1. class RewriteException extends RuntimeException

    Permalink

    Exception thrown when a rewrite rule replaced an element with a new element that does not comply with the contract of its parent container.

    Exception thrown when a rewrite rule replaced an element with a new element that does not comply with the contract of its parent container.

    The element property holds the offending element.

    Definition Classes
    ElementTraversal

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object RewriteException extends Serializable

    Permalink
    Definition Classes
    ElementTraversal
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def collect[B](pf: PartialFunction[Element, B]): List[B]

    Permalink

    Collects elements by applying the partial function to all elements it is defined for, in depth-first traversal, including this element itself.

    Collects elements by applying the partial function to all elements it is defined for, in depth-first traversal, including this element itself.

    Definition Classes
    ElementTraversal
  8. val content: Seq[Block]

    Permalink
    Definition Classes
    OptionListItemContainer
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def foreach(f: (Element) ⇒ Unit): Unit

    Permalink

    Invokes the specified function for each child of this element container, including children of children, and this element itself, in depth-first traversal.

    Invokes the specified function for each child of this element container, including children of children, and this element itself, in depth-first traversal.

    Definition Classes
    ElementTraversal
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. val options: Options

    Permalink
    Definition Classes
    OptionListItemCustomizable
  18. val programOptions: Seq[ProgramOption]

    Permalink
  19. def rewrite(rule: RewriteRule): OptionListItem

    Permalink

    Returns a new, rewritten tree model based on the specified rule.

    Returns a new, rewritten tree model based on the specified rule. The rule is a partial function that takes an Element and returns an Option[Element].

    If the function is not defined for a specific element the old element remains in the tree unchanged. If it returns None then the node gets removed from the tree, if it returns an element it will replace the old one. Of course the function may also return the old element.

    The rewriting is performed in a way that only branches of the tree that contain new or removed elements will be replaced. It is processed bottom-up, therefore any element container passed to the rule only contains children which have already been processed.

    In case multiple rewrite rules need to be applied it may be more efficient to first combine them with orElse.

    Definition Classes
    ElementTraversal
  20. def select(p: (Element) ⇒ Boolean): List[Element]

    Permalink

    Selects all elements satisfying the specified predicate, collecting in depth-first traversal, including this element itself.

    Selects all elements satisfying the specified predicate, collecting in depth-first traversal, including this element itself.

    Definition Classes
    ElementTraversal
  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  22. def toString(): String

    Permalink
    Definition Classes
    ElementContainer → AnyRef → Any
  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from BlockContainer[OptionListItem]

Inherited from Container[Seq[Block]]

Inherited from ListItem

Inherited from Customizable

Inherited from Element

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped