LinkDefinition

class LinkDefinition(val label: InlineContent, val url: String, val title: InlineContent?, val fileSystem: FileSystem? = null) : LinkNode, TextNode

Creation of a referenceable link definition.

Parameters

label

inline content of the displayed label

url

URL this link points to

title

optional inline title

fileSystem

optional file system this link is relative to

Constructors

Link copied to clipboard
constructor(label: InlineContent, url: String, title: InlineContent?, fileSystem: FileSystem? = null)

Properties

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: FileSystem? = null
Link copied to clipboard
open override val label: InlineContent
Link copied to clipboard
open override val text: InlineContent

Alias for label.

Link copied to clipboard
open override val title: InlineContent?
Link copied to clipboard
open override val url: String

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
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