quarkdown-core/com.quarkdown.core.ast.base.block/Table

Table

class Table(val columns: List<Table.Column>, val caption: String? = null, val referenceId: String? = null) : NestableNode, LocationTrackableNode, CaptionableNode, CrossReferenceableNode, LocalizedKind

A table, consisting of columns, each of which has a header and multiple cells. A table is location-trackable since, if requested by the user, it may show a caption displaying its location-based label.

Parameters

columns

columns of the table. Each column has a header and multiple cells

caption

optional caption of the table (Quarkdown extension)

referenceId

optional ID of the table to cross-reference via com.quarkdown.core.ast.quarkdown.reference.CrossReference (Quarkdown extension)

Constructors

Table

constructor(columns: List<Table.Column>, caption: String? = null, referenceId: String? = null)

Types

Alignment

enum Alignment : Enum<Table.Alignment> , RenderRepresentable

Text alignment of a Column.

Cell

data class Cell(val text: InlineContent)

A single cell of a table.

Column

data class Column(val alignment: Table.Alignment, val header: Table.Cell, val cells: List<Table.Cell>)

A column of a table.

Properties

canTrackLocation

open val canTrackLocation: Boolean

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

caption

open override val caption: String? = null

children

open override val children: List<Node>

columns

val columns: List<Table.Column>

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.

referenceId

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.

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