SubdocumentLink

class SubdocumentLink(val link: Link, val anchor: String? = null) : LinkNode, TextNode

A link to a Quarkdown subdocument.

Parameters

link

the link to the subdocument

anchor

an optional anchor to a specific section within the subdocument

Constructors

Link copied to clipboard
constructor(link: Link, anchor: String? = null)

Properties

Link copied to clipboard
val anchor: String? = null
Link copied to clipboard
open override val children: List<Node>
Link copied to clipboard

The error that occurred during processing, paired with the PipelineErrorHandler strategy to handle it. If null, no error occurred and the node is rendered normally via acceptOnSuccess.

Link copied to clipboard
open override val fileSystem: <Error class: unknown class>

Optional file system where this link is defined, used for resolving relative paths.

Link copied to clipboard
open override val label: <Error class: unknown class>

Inline content of the displayed label.

Link copied to clipboard
val link: Link
Link copied to clipboard
open override val text: <Error class: unknown class>

The text of the node as processed inline content.

Link copied to clipboard
open override val title: <Error class: unknown class>

Optional title.

Link copied to clipboard
open override val url: <Error class: unknown class>

URL this link points to.

Functions

Link copied to clipboard
open override fun <T> accept(visitor: NodeVisitor<T>): T

Accepts the error as a node if an error is present, otherwise accepts this node normally via acceptOnSuccess.

Link copied to clipboard
open override fun <T> acceptOnSuccess(visitor: NodeVisitor<T>): T

Visits this node with the given visitor when no error is present.

Link copied to clipboard

Returns a sequence of all nodes in the tree, where this is the root node. The sequence is generated by traversing the tree in depth-first order. The root node is excluded from the sequence.

Link copied to clipboard
Link copied to clipboard

Retrieves the stored media associated with this node, if any.

Link copied to clipboard
Link copied to clipboard
fun ErrorCapableNode.setError(throwable: Throwable, context: Context)

Sets the given throwable as the error of this node, paired with the error handler from context.

Link copied to clipboard
fun LinkNode.setResolvedUrl(context: MutableContext, resolvedUrl: String)

Registers the resolved path of this node within the document handled by context.

Link copied to clipboard

Associates a Subdocument with the SubdocumentLink in the given context.

Link copied to clipboard