case class TreeCursor(target: DocumentTree, parent: Option[TreeCursor], root: RootCursor, config: Config, position: TreePosition) extends Cursor with Product with Serializable
Cursor for an entire document tree, providing access to all child cursors of this tree and allowing to trigger rewrite operations.
- target
the document tree this cursor points to
- parent
the immediate parent of this tree or
Noneif this is the root- root
the root of this tree
- config
the configuration associated with this tree
- position
the position of this tree within the document tree
- Alphabetic
- By Inheritance
- TreeCursor
- Serializable
- Serializable
- Product
- Equals
- Cursor
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
TreeCursor(target: DocumentTree, parent: Option[TreeCursor], root: RootCursor, config: Config, position: TreePosition)
- target
the document tree this cursor points to
- parent
the immediate parent of this tree or
Noneif this is the root- root
the root of this tree
- config
the configuration associated with this tree
- position
the position of this tree within the document tree
Type Members
-
type
Target = DocumentTree
The type of the target this cursor points to.
The type of the target this cursor points to.
- Definition Classes
- TreeCursor → Cursor
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
lazy val
allDocuments: Seq[DocumentCursor]
All documents contained in this tree, fetched recursively, depth-first.
All documents contained in this tree, fetched recursively, depth-first. This method behaves differently than the
childrenmethod which only returns the cursors on this level of the tree hierarchy. -
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
lazy val
children: Seq[Cursor]
The cursors for all children of this node in the document tree.
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
val
config: Config
The configuration associated with this node.
The configuration associated with this node.
- Definition Classes
- TreeCursor → Cursor
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val parent: Option[TreeCursor]
-
val
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
- Definition Classes
- TreeCursor → Cursor
-
val
position: TreePosition
The position of this node within the document tree.
The position of this node within the document tree.
- Definition Classes
- TreeCursor → Cursor
-
def
rewriteTarget(rules: RewriteRulesBuilder): Either[TreeConfigErrors, DocumentTree]
Returns a new tree, with all the document models contained in it rewritten based on the specified rewrite rule.
-
val
root: RootCursor
The root cursor for this document tree.
The root cursor for this document tree.
- Definition Classes
- TreeCursor → Cursor
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
val
target: DocumentTree
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).
- Definition Classes
- TreeCursor → Cursor
-
lazy val
titleDocument: Option[DocumentCursor]
The cursor for the title document of this tree.
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()