Class/Object

laika.ast

TreeCursor

Related Docs: object TreeCursor | package ast

Permalink

case class TreeCursor(target: DocumentTree, parent: Option[TreeCursor], 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 parent of this tree or None if this is the root

config

the configuration associated with this tree

position

the position of this tree within the document tree

Linear Supertypes
Serializable, Serializable, Product, Equals, Cursor, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TreeCursor
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Cursor
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TreeCursor(target: DocumentTree, parent: Option[TreeCursor], config: Config, position: TreePosition)

    Permalink

    target

    the document tree this cursor points to

    parent

    the parent of this tree or None if this is the root

    config

    the configuration associated with this tree

    position

    the position of this tree within the document tree

Type Members

  1. type Target = DocumentTree

    Permalink

    The type of the target this cursor points to.

    The type of the target this cursor points to.

    Definition Classes
    TreeCursor → Cursor

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. lazy val children: Seq[Cursor]

    Permalink

    The cursors for all children of this node in the document tree.

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. val config: Config

    Permalink

    the configuration associated with this tree

    the configuration associated with this tree

    Definition Classes
    TreeCursor → Cursor

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. val parent: Option[TreeCursor]

    Permalink

    the parent of this tree or None if this is the root

  16. val position: TreePosition

    Permalink

    the position of this tree within the document tree

    the position of this tree within the document tree

    Definition Classes
    TreeCursor → Cursor

  17. def rewriteTarget(rule: (DocumentCursor) ⇒ RewriteRule): DocumentTree

    Permalink

    Returns a new tree, with all the document models contained in it rewritten based on the specified rewrite rule.

  18. lazy val root: TreeCursor

    Permalink

    The root cursor for this document tree.

    The root cursor for this document tree.

    Definition Classes
    TreeCursor → Cursor

  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  20. val target: DocumentTree

    Permalink

    the document tree this cursor points to

    the document tree this cursor points to

    Definition Classes
    TreeCursor → Cursor

  21. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Cursor

Inherited from AnyRef

Inherited from Any

Ungrouped