laika.tree.Elements

CrossLink

case class CrossLink(content: Seq[Span], ref: String, path: PathInfo, title: Option[String] = scala.None, options: Options = Elements.this.NoOpt) extends Element with Link with SpanContainer[CrossLink] with Product with Serializable

A link element pointing to a location in a different document, with the span content representing the text (description) of the link.

Linear Supertypes
Serializable, Serializable, SpanContainer[CrossLink], ElementContainer[Span, CrossLink], ElementTraversal[CrossLink], Container[Seq[Span]], Link, Span, Customizable, Element, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CrossLink
  2. Serializable
  3. Serializable
  4. SpanContainer
  5. ElementContainer
  6. ElementTraversal
  7. Container
  8. Link
  9. Span
  10. Customizable
  11. Element
  12. Product
  13. Equals
  14. AnyRef
  15. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CrossLink(content: Seq[Span], ref: String, path: PathInfo, title: Option[String] = scala.None, options: Options = Elements.this.NoOpt)

Type Members

  1. class RewriteException extends RuntimeException

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

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. object RewriteException extends Serializable

    Definition Classes
    ElementTraversal
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def clone(): AnyRef

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

    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
  10. val content: Seq[Span]

    Definition Classes
    CrossLinkContainer
  11. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  12. def finalize(): Unit

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

    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
  14. final def getClass(): Class[_]

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

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

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

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

    Definition Classes
    AnyRef
  19. val options: Options

    Definition Classes
    CrossLinkCustomizable
  20. val path: PathInfo

  21. val ref: String

  22. def rewrite(rule: PartialFunction[Element, Option[Element]]): CrossLink

    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
  23. def select(p: (Element) ⇒ Boolean): List[Element]

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

    Definition Classes
    AnyRef
  25. val title: Option[String]

  26. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from SpanContainer[CrossLink]

Inherited from ElementContainer[Span, CrossLink]

Inherited from ElementTraversal[CrossLink]

Inherited from Container[Seq[Span]]

Inherited from Link

Inherited from Span

Inherited from Customizable

Inherited from Element

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped