Trait

laika.ast

SpanContainer

Related Doc: package ast

Permalink

trait SpanContainer[Self <: SpanContainer[Self]] extends Element with ElementContainer[Span, Self]

A container of other Span elements. Such a container may be a Block or a Span itself.

Linear Supertypes
ElementContainer[Span, Self], ElementTraversal[Self], Container[Seq[Span]], Element, Product, Equals, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SpanContainer
  2. ElementContainer
  3. ElementTraversal
  4. Container
  5. Element
  6. Product
  7. Equals
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean

    Permalink
    Definition Classes
    Equals
  2. abstract def content: Seq[Span]

    Permalink
    Definition Classes
    Container
  3. abstract def productArity: Int

    Permalink
    Definition Classes
    Product
  4. abstract def productElement(n: Int): Any

    Permalink
    Definition Classes
    Product

Concrete 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. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def extractText: String

    Permalink

    Extracts the text from the spans of this container, removing any formatting or links.

  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. 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
  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  14. def hashCode(): Int

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  19. def productIterator: Iterator[Any]

    Permalink
    Definition Classes
    Product
  20. def productPrefix: String

    Permalink
    Definition Classes
    Product
  21. def rewrite(rule: RewriteRule): Self

    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
  22. 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
  23. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

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

Inherited from ElementContainer[Span, Self]

Inherited from ElementTraversal[Self]

Inherited from Container[Seq[Span]]

Inherited from Element

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped