LinkIdReference

case class LinkIdReference(content: Seq[Span], ref: String, source: SourceFragment, options: Options) extends Reference with SpanContainer

A reference to any kind of referencable object, e.g. a link definition or an internal target.

The reference can be local, in the same document, or anywhere else in the input tree, as long as the id is not ambiguous. Search for a matching target happens recursively, from the current document, to the current tree (directory) upwards to the root tree.

Companion:
object
trait Container[Seq[Span]]
trait Reference
trait Span
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Type members

Types

Value members

Concrete methods

def withContent(newContent: Seq[Span]): LinkIdReference

Inherited methods

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.

Inherited from:
ElementTraversal
def extractText: String

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

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

Inherited from:
SpanContainer
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.

Inherited from:
ElementTraversal
def hasId: Boolean

Indicates whether this element has an id assigned.

Indicates whether this element has an id assigned.

Inherited from:
Element
def hasStyle(name: String): Boolean

Indicates whether this element has the specified style assigned.

Indicates whether this element has the specified style assigned.

Inherited from:
Element

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.

Inherited from:
Element

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.

Inherited from:
Element
def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product
Inherited from:
SpanContainer

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.

Inherited from:
RewritableContainer
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.

Inherited from:
ElementTraversal
override def toString: String
Definition Classes
Inherited from:
ElementContainer
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.

Inherited from:
Element
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.

Inherited from:
Element
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.

Inherited from:
Element
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.

Inherited from:
Element

Returns a new instance of this element without its id.

Returns a new instance of this element without its id.

Inherited from:
Element

Concrete fields

lazy val unresolvedMessage: String