laika-core/laika.ast/TreePosition

TreePosition

class TreePosition extends Ordered[TreePosition]

The position of an element within a document tree.

Companion:
object
trait Ordered[TreePosition]
trait Comparable[TreePosition]
class Object
trait Matchable
class Any

Value members

Concrete methods

def compare(other: TreePosition): Int
def depth: Int

The depth (or nesting level) of this position within the document tree.

The depth (or nesting level) of this position within the document tree.

override def equals(obj: Any): Boolean
Definition Classes
Any
def forChild(childPos: Int): TreePosition

Creates a position instance for a child of this element.

Creates a position instance for a child of this element.

override def hashCode(): Int
Definition Classes
Any
def toSeq: Seq[Int]

The positions (one-based) of each nesting level of this instance (an empty sequence for the root or orphan positions).

The positions (one-based) of each nesting level of this instance (an empty sequence for the root or orphan positions).

def toSpan: Span

This tree position as a span that can get rendered as part of a numbered title for example.

This tree position as a span that can get rendered as part of a numbered title for example.

override def toString: String
Definition Classes
Any

Inherited methods

def <(that: TreePosition): Boolean
Inherited from:
Ordered
def <=(that: TreePosition): Boolean
Inherited from:
Ordered
def >(that: TreePosition): Boolean
Inherited from:
Ordered
def >=(that: TreePosition): Boolean
Inherited from:
Ordered
def compareTo(that: TreePosition): Int
Inherited from:
Ordered