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

Container

class Container(val width: Size? = null, val height: Size? = null, val fullWidth: Boolean = false, val float: Container.FloatAlignment? = null, val fullColumnSpan: Boolean = false, val className: String? = null, val style: NodeStyle = NodeStyle.DEFAULT, val children: List<Node>) : NestableNode, StylableNode

A general-purpose container that groups content.

Parameters

width

width of the container

height

height of the container

fullWidth

whether the container should take up the full width of the parent. Overridden by width

float

floating position of the container within the subsequent content

fullColumnSpan

whether the container should span across all columns in a multi-column layout

className

custom class name for the container, useful for applying custom styles, if supported by the renderer

Constructors

Container

constructor(width: Size? = null, height: Size? = null, fullWidth: Boolean = false, float: Container.FloatAlignment? = null, fullColumnSpan: Boolean = false, className: String? = null, style: NodeStyle = NodeStyle.DEFAULT, children: List<Node>)

Types

FloatAlignment

enum FloatAlignment : RenderRepresentable, Enum<Container.FloatAlignment>

Floating position of a Container.

Properties

children

open override val children: List<Node>

className

val className: String?

float

val float: Container.FloatAlignment?

fullColumnSpan

val fullColumnSpan: Boolean

fullWidth

val fullWidth: Boolean

height

val height: Size?

style

open override val style: NodeStyle

The style of this node.

width

val width: Size?

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.

getStoredMedia

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

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

withChildren

fun Node.withChildren(newChildren: List<Node>): Node

Returns a copy of this node with its children replaced by newChildren.

wrappedAsValue

fun Node.wrappedAsValue(): NodeValue