kvision/io.kvision.core/Container

Container

interface Container : Component(source)

Base interface for all containers.

Inheritors

Properties

Link copied to clipboard
abstract var parent: Container?

Parent of the current component.

Link copied to clipboard
abstract var visible: Boolean

Visibility state of the current component.

Functions

Link copied to clipboard
abstract fun add(child: Component)

Adds given component to the current container.

abstract fun add(position: Int, child: Component)

Adds given component to the current container at the given position.

Link copied to clipboard
abstract fun addAfterCreateHook(hook: (VNode) -> Unit): Boolean

The supplied function is called after the component DOM element is created.

Link copied to clipboard
abstract fun addAfterDestroyHook(hook: () -> Unit): Boolean

The supplied function is called after the component is removed from the DOM.

Link copied to clipboard
abstract fun addAfterInsertHook(hook: (VNode) -> Unit): Boolean

The supplied function is called after the component is inserted into the DOM.

Link copied to clipboard
abstract fun addAll(children: List<Component>)

Adds a list of components to the current container.

Link copied to clipboard
abstract fun addBeforeDisposeHook(hook: () -> Unit): Boolean

The supplied function is called before the component is disposed.

Link copied to clipboard
abstract fun addCssClass(css: String)

Adds given value to the set of CSS classes generated in html code of current component.

Link copied to clipboard
abstract fun addCssStyle(css: Style)

Adds given style object to the set of CSS classes generated in html code of current component.

Link copied to clipboard
fun Container.address(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Address.() -> Unit? = null): Address

DSL builder extension function.

Link copied to clipboard
abstract fun addSurroundingCssClass(css: String)

Adds given value to the set of CSS classes generated in html code of parent component.

Link copied to clipboard
abstract fun addSurroundingCssStyle(css: Style)

Adds given style object to the set of CSS classes generated in html code of parent component.

Link copied to clipboard
fun Container.article(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Article.() -> Unit? = null): Article

DSL builder extension function.

Link copied to clipboard
fun Container.b(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: B.() -> Unit? = null): B

DSL builder extension function.

Link copied to clipboard
open fun blur()

Makes the element blur.

Link copied to clipboard
fun Container.br(className: String? = null, init: Br.() -> Unit? = null): Br

DSL builder extension function.

Link copied to clipboard
fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, separator: String? = null, labelFirst: Boolean = true, className: String? = null, init: Button.() -> Unit? = null): Button

DSL builder extension function.

Link copied to clipboard
fun Container.canvas(canvasWidth: Int? = null, canvasHeight: Int? = null, className: String? = null, init: Canvas.() -> Unit? = null): Canvas

DSL builder extension function.

Link copied to clipboard
fun Container.checkBox(value: Boolean = false, name: String? = null, labelFirst: Boolean = false, label: String? = null, rich: Boolean = false, init: CheckBox.() -> Unit? = null): CheckBox

DSL builder extension function.

Link copied to clipboard
fun Container.checkBoxInput(value: Boolean = false, className: String? = null, init: CheckBoxInput.() -> Unit? = null): CheckBoxInput

DSL builder extension function.

Link copied to clipboard
abstract fun clearAfterCreateHooks()

Remove all after create hooks functions.

Link copied to clipboard
abstract fun clearAfterDestroyHooks()

Remove all after destroy hooks functions.

Link copied to clipboard
abstract fun clearAfterInsertHooks()

Remove all after insert hooks functions.

Link copied to clipboard
abstract fun clearBeforeDisposeHooks()

Remove all before dispose hooks functions.

Link copied to clipboard
fun Container.code(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Code.() -> Unit? = null): Code

DSL builder extension function.

Link copied to clipboard
fun Container.customTag(elementName: String, content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, attributes: Map<String, String>? = null, init: CustomTag.() -> Unit? = null): CustomTag

DSL builder extension function.

Link copied to clipboard
abstract fun disposeAll()

Removes all children from the current container and disposes them.

Link copied to clipboard
fun Container.div(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Div.() -> Unit? = null): Div

DSL builder extension function.

Link copied to clipboard
fun Container.dockPanel(className: String? = null, init: DockPanel.() -> Unit? = null): DockPanel

DSL builder extension function.

Link copied to clipboard
fun Container.em(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Em.() -> Unit? = null): Em

DSL builder extension function.

Link copied to clipboard
fun Container.fieldLabel(forId: String, content: String? = null, rich: Boolean = false, className: String? = null, init: FieldLabel.() -> Unit? = null): FieldLabel

DSL builder extension function.

Link copied to clipboard
fun Container.fieldset(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Fieldset.() -> Unit? = null): Fieldset

DSL builder extension function.

Link copied to clipboard
fun Container.fieldsetPanel(legend: String? = null, className: String? = null, init: FieldsetPanel.() -> Unit? = null): FieldsetPanel

DSL builder extension function.

Link copied to clipboard
fun Container.figcaption(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Figcaption.() -> Unit? = null): Figcaption

DSL builder extension function.

Link copied to clipboard
fun Container.figure(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Figure.() -> Unit? = null): Figure

DSL builder extension function.

Link copied to clipboard
fun Container.flexPanel(direction: FlexDirection? = null, wrap: FlexWrap? = null, justify: JustifyContent? = null, alignItems: AlignItems? = null, alignContent: AlignContent? = null, spacing: Int? = null, useWrappers: Boolean = false, className: String? = null, init: FlexPanel.() -> Unit? = null): FlexPanel

DSL builder extension function.

Link copied to clipboard
open fun focus()

Makes the element focused.

Link copied to clipboard
fun Container.footer(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Footer.() -> Unit? = null): Footer

DSL builder extension function.

Link copied to clipboard
fun Container.form(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, condensed: Boolean = false, horizRatio: FormHorizontalRatio = FormHorizontalRatio.RATIO_2, className: String? = null, init: FormPanel<Map<String, Any?>>.() -> Unit? = null): FormPanel<Map<String, Any?>>

DSL builder extension function.

Link copied to clipboard
inline fun <K : Any> Container.formPanel(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, condensed: Boolean = false, horizRatio: FormHorizontalRatio = FormHorizontalRatio.RATIO_2, className: String? = null, customSerializers: Map<KClass<*>, KSerializer<*>>? = null, noinline init: FormPanel<K>.() -> Unit? = null): FormPanel<K>

DSL builder extension function.

Link copied to clipboard
fun <T> Container.genericRadioGroup(options: List<Pair<T, String>>? = null, value: T? = null, name: String? = null, inline: Boolean = false, label: String? = null, rich: Boolean = false, toStr: (T) -> String = { it.toString() }, fromStr: (String) -> T? = { @Suppress("UNCHECKED_CAST") it as? T }, init: GenericRadioGroup<T>.() -> Unit? = null): GenericRadioGroup<T>

DSL builder extension function.

Link copied to clipboard
fun <T> Container.genericRadioGroupInput(options: List<Pair<T, String>>? = null, value: T? = null, name: String? = null, inline: Boolean = false, toStr: (T) -> String = { it.toString() }, fromStr: (String) -> T? = { @Suppress("UNCHECKED_CAST") it as? T }, init: GenericRadioGroupInput<T>.() -> Unit? = null): GenericRadioGroupInput<T>

DSL builder extension function.

Link copied to clipboard
abstract fun getAttribute(name: String): String?

Returns the value of an additional attribute.

Link copied to clipboard
abstract fun getChildren(): List<Component>

Returns a list of children of the current container.

Link copied to clipboard
abstract fun getElement(): HTMLElement?

Returns DOM element bound to the current component.

Link copied to clipboard
abstract fun getElementD(): dynamic

Returns DOM element bound to the current component as a dynamic type.

Link copied to clipboard
fun Container.gridPanel(autoColumns: String? = null, autoRows: String? = null, autoFlow: GridAutoFlow? = null, templateColumns: String? = null, templateRows: String? = null, templateAreas: List<String>? = null, columnGap: Int? = null, rowGap: Int? = null, justifyItems: JustifyItems? = null, alignItems: AlignItems? = null, justifyContent: JustifyContent? = null, alignContent: AlignContent? = null, useWrappers: Boolean = false, className: String? = null, init: GridPanel.() -> Unit? = null): GridPanel

DSL builder extension function.

Link copied to clipboard
fun Container.h1(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H1.() -> Unit? = null): H1

DSL builder extension function.

Link copied to clipboard
fun Container.h2(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H2.() -> Unit? = null): H2

DSL builder extension function.

Link copied to clipboard
fun Container.h3(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H3.() -> Unit? = null): H3

DSL builder extension function.

Link copied to clipboard
fun Container.h4(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H4.() -> Unit? = null): H4

DSL builder extension function.

Link copied to clipboard
fun Container.h5(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H5.() -> Unit? = null): H5

DSL builder extension function.

Link copied to clipboard
fun Container.h6(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: H6.() -> Unit? = null): H6

DSL builder extension function.

Link copied to clipboard
abstract fun hasCssClass(css: String): Boolean

Checks whether the given value is present in the set of CSS classes.

Link copied to clipboard
fun Container.header(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Header.() -> Unit? = null): Header

DSL builder extension function.

Link copied to clipboard
fun Container.hPanel(wrap: FlexWrap? = null, justify: JustifyContent? = null, alignItems: AlignItems? = null, spacing: Int? = null, useWrappers: Boolean = false, className: String? = null, init: HPanel.() -> Unit? = null): HPanel

DSL builder extension function.

Link copied to clipboard
fun Container.i(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: I.() -> Unit? = null): I

DSL builder extension function.

Link copied to clipboard
fun Container.icon(icon: String, init: Icon.() -> Unit? = null): Icon

DSL builder extension function.

Link copied to clipboard
fun Container.iframe(src: String? = null, srcdoc: String? = null, name: String? = null, iframeWidth: Int? = null, iframeHeight: Int? = null, sandbox: Set<Sandbox>? = null, className: String? = null, init: Iframe.() -> Unit? = null): Iframe

DSL builder extension function.

Link copied to clipboard
fun Container.image(src: ResString?, alt: String? = null, responsive: Boolean = false, shape: ImageShape? = null, centered: Boolean = false, className: String? = null, init: Image.() -> Unit? = null): Image

DSL builder extension function.

Link copied to clipboard
fun Container.input(type: InputType? = null, className: String? = null, init: Input.() -> Unit? = null): Input

DSL builder extension function.

Link copied to clipboard
open operator fun invoke(vararg children: Component)

Operator function for adding children in a DSL style.

Link copied to clipboard
fun Container.label(content: String? = null, rich: Boolean = false, forId: String? = null, className: String? = null, init: Label.() -> Unit? = null): Label

DSL builder extension function.

Link copied to clipboard
fun Container.li(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Li.() -> Unit? = null): Li

DSL builder extension function.

Link copied to clipboard
fun Container.link(label: String, url: String? = null, icon: String? = null, image: ResString? = null, separator: String? = null, labelFirst: Boolean = true, target: String? = null, dataNavigo: Boolean? = null, className: String? = null, init: Link.() -> Unit? = null): Link

DSL builder extension function.

Link copied to clipboard
fun Container.listTag(type: ListType, elements: List<String>? = null, rich: Boolean = false, className: String? = null, init: ListTag.() -> Unit? = null): ListTag

DSL builder extension function.

Link copied to clipboard
fun Container.main(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Main.() -> Unit? = null): Main

DSL builder extension function.

Link copied to clipboard
fun Container.nav(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Nav.() -> Unit? = null): Nav

DSL builder extension function.

Link copied to clipboard
fun Container.numeric(value: Number? = null, name: String? = null, min: Number? = null, max: Number? = null, decimals: Int = 2, decimalSeparator: Char = I18n.detectDecimalSeparator(), label: String? = null, rich: Boolean = false, init: Numeric.() -> Unit? = null): Numeric

DSL builder extension function.

Link copied to clipboard
fun Container.numericInput(value: Number? = null, min: Number? = null, max: Number? = null, decimals: Int = 2, decimalSeparator: Char = I18n.detectDecimalSeparator(), className: String? = null, init: NumericInput.() -> Unit? = null): NumericInput

DSL builder extension function.

Link copied to clipboard
fun Container.ol(elements: List<String>? = null, rich: Boolean = false, className: String? = null, init: Ol.() -> Unit? = null): Ol

DSL builder extension function.

Link copied to clipboard
fun Container.p(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: P.() -> Unit? = null): P

DSL builder extension function.

Link copied to clipboard
fun Container.password(value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false, floating: Boolean = false, init: Password.() -> Unit? = null): Password

DSL builder extension function.

Link copied to clipboard
fun Container.radio(value: Boolean = false, extraValue: String? = null, name: String? = null, labelFirst: Boolean = false, label: String? = null, rich: Boolean = false, init: Radio.() -> Unit? = null): Radio

DSL builder extension function.

Link copied to clipboard
fun Container.radioGroup(options: List<StringPair>? = null, value: String? = null, name: String? = null, inline: Boolean = false, label: String? = null, rich: Boolean = false, init: RadioGroup.() -> Unit? = null): RadioGroup

DSL builder extension function.

Link copied to clipboard
fun Container.radioGroupInput(options: List<StringPair>? = null, value: String? = null, name: String? = null, inline: Boolean = false, init: RadioGroupInput.() -> Unit? = null): RadioGroupInput

DSL builder extension function.

Link copied to clipboard
fun Container.radioInput(value: Boolean = false, className: String? = null, init: RadioInput.() -> Unit? = null): RadioInput

DSL builder extension function.

Link copied to clipboard
fun Container.range(value: Number? = null, name: String? = null, min: Number = 0, max: Number = 100, step: Number = RANGE_DEFAULT_STEP, label: String? = null, rich: Boolean = false, init: Range.() -> Unit? = null): Range

DSL builder extension function.

Link copied to clipboard
fun Container.rangeInput(value: Number? = null, min: Number = 0, max: Number = 100, step: Number = RANGE_DEFAULT_STEP, className: String? = null, init: RangeInput.() -> Unit? = null): RangeInput

DSL builder extension function.

Link copied to clipboard
abstract fun remove(child: Component)

Removes given component from the current container.

Link copied to clipboard
abstract fun removeAfterCreateHook(hook: (VNode) -> Unit): Boolean

Remove the after create hook function (the same function reference must be used).

Link copied to clipboard
abstract fun removeAfterDestroyHook(hook: () -> Unit): Boolean

Remove the after destroy hook function (the same function reference must be used).

Link copied to clipboard
abstract fun removeAfterInsertHook(hook: (VNode) -> Unit): Boolean

Remove the after insert hook function (the same function reference must be used).

Link copied to clipboard
abstract fun removeAll()

Removes all children from the current container.

Link copied to clipboard
abstract fun removeAt(position: Int)

Removes child component from the current container at the given position.

Link copied to clipboard
abstract fun removeAttribute(name: String)

Removes the value of additional attribute.

Link copied to clipboard
abstract fun removeBeforeDisposeHook(hook: () -> Unit): Boolean

Remove the before dispose hook function (the same function reference must be used).

Link copied to clipboard
abstract fun removeCssClass(css: String)

Removes given value from the set of CSS classes generated in html code of current component.

Link copied to clipboard
abstract fun removeCssStyle(css: Style)

Removes given style object from the set of CSS classes generated in html code of current component.

Link copied to clipboard
abstract fun removeSurroundingCssClass(css: String)

Removes given value from the set of CSS classes generated in html code of parent component.

Link copied to clipboard
abstract fun removeSurroundingCssStyle(css: Style)

Removes given style object from the set of CSS classes generated in html code of parent component.

Link copied to clipboard
fun Container.section(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Section.() -> Unit? = null): Section

DSL builder extension function.

Link copied to clipboard
fun Container.select(options: List<StringPair>? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, name: String? = null, label: String? = null, rich: Boolean = false, floating: Boolean = false, init: Select.() -> Unit? = null): Select

DSL builder extension function.

Link copied to clipboard
fun Container.selectInput(options: List<StringPair>? = null, value: String? = null, emptyOption: Boolean = false, multiple: Boolean = false, selectSize: Int? = null, className: String? = null, init: SelectInput.() -> Unit? = null): SelectInput

DSL builder extension function.

Link copied to clipboard
abstract fun setAttribute(name: String, value: String)

Sets the value of additional attribute.

Link copied to clipboard
fun Container.simplePanel(vararg styles: Style, init: SimplePanel.() -> Unit? = null): SimplePanel

DSL builder extension function with Style support

fun Container.simplePanel(className: String? = null, init: SimplePanel.() -> Unit? = null): SimplePanel

DSL builder extension function.

Link copied to clipboard
abstract fun <T> singleRender(block: () -> T): T

Executes given function within a single rendering process.

Link copied to clipboard
abstract fun singleRenderAsync(block: () -> Unit)

Executes given function within a single rendering process asynchronously.

Link copied to clipboard
fun Container.small(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Small.() -> Unit? = null): Small

DSL builder extension function.

Link copied to clipboard
fun Container.span(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Span.() -> Unit? = null): Span

DSL builder extension function.

Link copied to clipboard
fun Container.spinner(value: Number? = null, name: String? = null, min: Int? = null, max: Int? = null, step: Int = SPINNER_DEFAULT_STEP, label: String? = null, rich: Boolean = false, init: Spinner.() -> Unit? = null): Spinner

DSL builder extension function.

Link copied to clipboard
fun Container.spinnerInput(value: Number? = null, min: Int? = null, max: Int? = null, step: Int = SPINNER_DEFAULT_STEP, className: String? = null, init: SpinnerInput.() -> Unit? = null): SpinnerInput

DSL builder extension function.

Link copied to clipboard
fun Container.splitPanel(direction: Direction = Direction.VERTICAL, className: String? = null, init: SplitPanel.() -> Unit? = null): SplitPanel

DSL builder extension function.

Link copied to clipboard
fun Container.stackPanel(activateLast: Boolean = true, className: String? = null, init: StackPanel.() -> Unit? = null): StackPanel

DSL builder extension function.

Link copied to clipboard
fun Container.strong(content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Strong.() -> Unit? = null): Strong

DSL builder extension function.

Link copied to clipboard
fun Container.table(className: String? = null, init: Table.() -> Unit? = null): Table

DSL builder extension function.

Link copied to clipboard
fun Container.tag(type: TAG, content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, attributes: Map<String, String>? = null, init: Tag.() -> Unit? = null): Tag

DSL builder extension function.

Link copied to clipboard
fun Container.text(type: InputType = InputType.TEXT, value: String? = null, name: String? = null, maxlength: Int? = null, label: String? = null, rich: Boolean = false, floating: Boolean = false, init: Text.() -> Unit? = null): Text

DSL builder extension function.

Link copied to clipboard
fun Container.textArea(cols: Int? = null, rows: Int? = null, value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false, floating: Boolean = false, init: TextArea.() -> Unit? = null): TextArea

DSL builder extension function.

Link copied to clipboard
fun Container.textAreaInput(cols: Int? = null, rows: Int? = null, value: String? = null, className: String? = null, init: TextAreaInput.() -> Unit? = null): TextAreaInput

DSL builder extension function.

Link copied to clipboard
fun Container.textInput(type: InputType = InputType.TEXT, value: String? = null, maxlength: Int? = null, className: String? = null, init: TextInput.() -> Unit? = null): TextInput

DSL builder extension function.

Link copied to clipboard
fun Container.textNode(content: String, rich: Boolean = false, init: TextNode.() -> Unit? = null): TextNode

DSL builder extension function.

Link copied to clipboard
fun Container.time(datetime: String, content: String? = null, rich: Boolean = false, align: Align? = null, className: String? = null, init: Time.() -> Unit? = null): Time

DSL builder extension function.

Link copied to clipboard
fun Container.tr(className: String? = null, init: Tr.() -> Unit? = null): Tr

DSL builder extension function.

Link copied to clipboard
fun Container.triStateCheckBox(value: Boolean? = null, name: String? = null, labelFirst: Boolean = false, label: String? = null, rich: Boolean = false, init: TriStateCheckBox.() -> Unit? = null): TriStateCheckBox

DSL builder extension function.

Link copied to clipboard
fun Container.triStateCheckBoxInput(value: Boolean = false, className: String? = null, init: TriStateCheckBoxInput.() -> Unit? = null): TriStateCheckBoxInput

DSL builder extension function.

Link copied to clipboard
fun Container.ul(elements: List<String>? = null, rich: Boolean = false, className: String? = null, init: Ul.() -> Unit? = null): Ul

DSL builder extension function.

Link copied to clipboard
open operator fun String.unaryPlus()

An operator to add a text node to the container.

Link copied to clipboard
fun Container.upload(multiple: Boolean = false, accept: List<String>? = null, capture: Capture? = null, label: String? = null, rich: Boolean = false, init: Upload.() -> Unit? = null): Upload

DSL builder extension function.

Link copied to clipboard
fun Container.uploadInput(multiple: Boolean = false, accept: List<String>? = null, capture: Capture? = null, className: String? = null, init: UploadInput.() -> Unit? = null): UploadInput

DSL builder extension function.

Link copied to clipboard
fun Container.vPanel(justify: JustifyContent? = null, alignItems: AlignItems? = null, spacing: Int? = null, useWrappers: Boolean = false, className: String? = null, init: VPanel.() -> Unit? = null): VPanel

DSL builder extension function.

Link copied to clipboard
fun Container.widget(className: String? = null, init: Widget.() -> Unit? = null): Widget

DSL builder extension function.