laika-core
API
Generated with
laika-core/laika/laika.ast/Cursor

Cursor

laika.ast.Cursor
sealed trait Cursor

A cursor provides the necessary context during a rewrite operation. The stateless document tree cannot provide access to parent or sibling nodes in the tree, therefore a temporary cursor instance is created during a rewrite operation for this purpose.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class TreeCursor

Members list

Type members

Types

type Target <: TreeContent

The type of the target this cursor points to.

The type of the target this cursor points to.

Attributes

Value members

Abstract methods

def config: Config

The configuration associated with this node.

The configuration associated with this node.

Attributes

def path: Path

The full, absolute path of the target of this cursor in the (virtual) document tree

The full, absolute path of the target of this cursor in the (virtual) document tree

Attributes

def position: TreePosition

The position of this node within the document tree.

The position of this node within the document tree.

Attributes

def root: RootCursor

The root cursor for this document tree.

The root cursor for this document tree.

Attributes

def target: Target

The target within the document tree this cursor points to (a markup document or a sub-tree).

The target within the document tree this cursor points to (a markup document or a sub-tree).

Attributes

Generated with