Cursor for the root node of a document tree, providing access to all child cursors of this tree and allowing to trigger rewrite operations.
Attributes
- target
the root of the document tree this cursor points to
- Companion:
- object
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
Members list
Type members
Types
Value members
Concrete methods
Returns a new tree root, with all the document models contained in it rewritten based on the specified rewrite rule.
Returns a new tree root, with all the document models contained in it rewritten based on the specified rewrite rule.
Attributes
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.
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.
Attributes
Concrete fields
All documents contained in this tree, fetched recursively, depth-first.
All documents contained in this tree, fetched recursively, depth-first.
Attributes
The cursor for the cover document of this tree.
The cursor for the cover document of this tree.
Attributes
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.
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.
Attributes
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.
Attributes
The cursor for the underlying tree structure of this root node.
The cursor for the underlying tree structure of this root node.