quarkdown-core/com.quarkdown.core.ast.quarkdown/CaptionableNode

CaptionableNode

interface CaptionableNode : NestableNode

A node that may have a caption, such as a com.quarkdown.core.ast.base.block.Table or a com.quarkdown.core.ast.quarkdown.block.ImageFigure. The caption is a sequence of inline nodes, which accepts further inline formatting (e.g. emphasis, links).

Extends NestableNode so that the caption content is reachable by AST tree traversals.

Inheritors

Code

Table

Figure

Properties

caption

abstract val caption: InlineContent?

The optional caption, as inline content. If null, this node has no caption.

children

open override val children: List<Node>

Caption nodes grouped into a single container, making them visible to tree traversals. Subclasses that define their own children must include this in their override.

Functions

abstract fun <T> accept(visitor: NodeVisitor<T>): T

Accepts a visitor.

flattenedChildren

fun NestableNode.flattenedChildren(): Sequence<Node>

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.

getStoredMedia

fun Node.getStoredMedia(context: Context): StoredMedia?

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

wrappedAsValue

fun Node.wrappedAsValue(): NodeValue