1.13.0

quarkdown-core/com.quarkdown.core.ast.quarkdown.block/Figure

Figure

open class Figure<T : Node>(val child: T, val caption: String? = null, val referenceId: String? = null) : SingleChildNestableNode<T> , LocationTrackableNode, CrossReferenceableNode, CaptionableNode, LocalizedKind

A block which displays a single child, with an optional caption. If a caption is provided or referenceId is set, the block is numbered.

Parameters

child

wrapped child

caption

optional caption of the figure block

referenceId

optional ID that can be cross-referenced via a com.quarkdown.core.ast.quarkdown.reference.CrossReference

T

type of the wrapped child node

Inheritors

Constructors

constructor(child: T, caption: String? = null, referenceId: String? = null)

Properties

canTrackLocation

open override val canTrackLocation: Boolean

A figure is numbered if it has either a caption or a referenceId.

open override val caption: String? = null

open override val child: T

open override val children: List<Node>

A singleton list containing child.

kindLocalizationKey

open override val kindLocalizationKey: String

Key for localization of the kind of this node, used to look up localized strings in the default com.quarkdown.core.localization.LocalizationTable.

open override val referenceId: String? = null

Functions

open override 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.

fun LocationTrackableNode.formatLocation(context: Context, format: (DocumentNumbering) -> NumberingFormat?): String?

fun LocationTrackableNode.getLocation(context: Context): SectionLocation?

getLocationLabel

fun LocationTrackableNode.getLocationLabel(context: Context): String?

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

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

fun LocationTrackableNode.setLocation(context: MutableContext, location: SectionLocation)

Registers the location of this node within the document handled by context.

setLocationLabel

fun LocationTrackableNode.setLocationLabel(context: MutableContext, label: String)

Registers the formatted location of this node within the document handled by context, according to this node's NumberingFormat.

fun Node.wrappedAsValue(): NodeValue