Packages

class RootCursor extends AnyRef

Cursor for the root node of a document tree, providing access to all child cursors of this tree and allowing to trigger rewrite operations.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RootCursor
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Target = DocumentTreeRoot

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. lazy val allDocuments: Seq[DocumentCursor]

    All documents contained in this tree, fetched recursively, depth-first.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. val config: Config
  8. lazy val coverDocument: Option[DocumentCursor]

    The cursor for the cover document of this tree.

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. val outputContext: Option[OutputContext]

    The context for the output format when the cursor has been created for the final rewrite phase for a specific output format or empty in earlier rewrite phases that apply to all formats.

  18. lazy val pathTranslator: Option[PathTranslator]

    The path translator to be used for translating internal links and output paths.

    The path translator to be used for translating internal links and output paths.

    The translator is specific for each output format and therefore this value is empty for any cursor that has not been created for the final rewrite phase in the context of a concrete renderer and its template.

  19. def rewriteTarget(rules: RewriteRulesBuilder): Either[TreeConfigErrors, DocumentTreeRoot]

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

  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. val target: DocumentTreeRoot
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. val tree: TreeCursor

    The cursor for the underlying tree structure of this root node.

  24. def treeConfig(path: Path): Config

    Selects the tree configuration for the specified path, or its nearest parent if that path does not have a configuration assigned.

    Selects the tree configuration for the specified path, or its nearest parent if that path does not have a configuration assigned. Always succeeds as recursing upwards will eventually lead to this root cursor and return its configuration.

  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped