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 foregroundColor: Color? = null, val backgroundColor: Color? = null, val borderColor: Color? = null, val borderWidth: Sizes? = null, val borderStyle: Container.BorderStyle? = null, val margin: Sizes? = null, val padding: Sizes? = null, val cornerRadius: Sizes? = null, val alignment: Container.Alignment? = null, val textAlignment: Container.TextAlignment? = null, val textTransform: TextTransformData? = null, val float: Container.FloatAlignment? = null, val children: List<Node>) : NestableNode

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

foregroundColor

text color

backgroundColor

background color

borderColor

border color

borderWidth

border width

borderStyle

border style

margin

whitespace outside the content

padding

whitespace around the content

cornerRadius

border radius of the container

alignment

alignment of the content

textAlignment

alignment of the text

textTransform

transformation applied to the text content

fontSize

relative font size of the text

float

floating position of the container within the subsequent content

Constructors

Container

constructor(width: Size? = null, height: Size? = null, fullWidth: Boolean = false, foregroundColor: Color? = null, backgroundColor: Color? = null, borderColor: Color? = null, borderWidth: Sizes? = null, borderStyle: Container.BorderStyle? = null, margin: Sizes? = null, padding: Sizes? = null, cornerRadius: Sizes? = null, alignment: Container.Alignment? = null, textAlignment: Container.TextAlignment? = null, textTransform: TextTransformData? = null, float: Container.FloatAlignment? = null, children: List<Node>)

Types

Alignment

enum Alignment : Enum<Container.Alignment> , RenderRepresentable

Possible alignment types of a Container.

BorderStyle

enum BorderStyle : Enum<Container.BorderStyle> , RenderRepresentable

Style of the border of a Container.

FloatAlignment

enum FloatAlignment : Enum<Container.FloatAlignment> , RenderRepresentable

Floating position of a Container.

TextAlignment

enum TextAlignment : Enum<Container.TextAlignment> , RenderRepresentable

Possible alignment types of a Container.

Properties

alignment

val alignment: Container.Alignment? = null

backgroundColor

val backgroundColor: Color? = null

borderColor

val borderColor: Color? = null

borderStyle

val borderStyle: Container.BorderStyle? = null

borderWidth

val borderWidth: Sizes? = null

children

open override val children: List<Node>

cornerRadius

val cornerRadius: Sizes? = null

float

val float: Container.FloatAlignment? = null

foregroundColor

val foregroundColor: Color? = null

fullWidth

val fullWidth: Boolean = false

height

val height: Size? = null

margin

val margin: Sizes? = null

padding

val padding: Sizes? = null

textAlignment

val textAlignment: Container.TextAlignment? = null

textTransform

val textTransform: TextTransformData? = null

width

val width: Size? = 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.

getStoredMedia

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

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

wrappedAsValue

fun Node.wrappedAsValue(): NodeValue