quarkdown-core/com.quarkdown.core.ast.attributes.location/LocationTrackableNode

LocationTrackableNode

A node that requests its location to be tracked within the document's hierarchy. By location, it is meant the section indices (SectionLocation) the node is located in.

Inheritors

Properties

canTrackLocation

open val canTrackLocation: Boolean

Whether this node should be tracked in the document's hierarchy.

Functions

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

Accepts a visitor.

formatLocation

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

getLocation

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

getLocationLabel

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

getStoredMedia

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

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

setLocation

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.

wrappedAsValue

fun Node.wrappedAsValue(): NodeValue

LocationTrackableNode

See also

Inheritors

Properties

Functions