From fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 26 Oct 2019 00:17:24 +0200 Subject: API documentation for KVision 2.0.0 --- api/pl.treksoft.kvision.core/-container/index.html | 735 +++++++++++++++++++++ 1 file changed, 735 insertions(+) (limited to 'api/pl.treksoft.kvision.core/-container') diff --git a/api/pl.treksoft.kvision.core/-container/index.html b/api/pl.treksoft.kvision.core/-container/index.html index 56cf68c7..83d2bcf8 100644 --- a/api/pl.treksoft.kvision.core/-container/index.html +++ b/api/pl.treksoft.kvision.core/-container/index.html @@ -200,6 +200,104 @@ +

addBsBgColor

+ + +fun Component.addBsBgColor(bsBgColor: BsBgColor): Unit + + + +

addBsBorder

+ + +fun Component.addBsBorder(vararg bsBorder: BsBorder): Unit + + + +

addBsClearfix

+ + +fun Component.addBsClearfix(): Unit + + + +

addBsColor

+ + +fun Component.addBsColor(bsColor: BsColor): Unit + + + +

addBsRounded

+ + +fun Component.addBsRounded(vararg bsRounded: BsRounded): Unit + + + +

bold

+ + +fun Container.bold(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Bold.() -> Unit)? = null): Bold +

DSL builder extension function.

+ + + + +

button

+ + +fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, classes: Set<String> = setOf(), init: (Button.() -> Unit)? = null): Button +

DSL builder extension function.

+ + + + +

buttonGroup

+ + +fun Container.buttonGroup(size: ButtonGroupSize? = null, vertical: Boolean = false, classes: Set<String> = setOf(), init: (ButtonGroup.() -> Unit)? = null): ButtonGroup +

DSL builder extension function.

+ + + + +

canvas

+ + +fun Container.canvas(canvasWidth: Int? = null, canvasHeight: Int? = null, classes: Set<String> = setOf(), init: (Canvas.() -> Unit)? = null): Canvas +

DSL builder extension function.

+ + + + +

chart

+ + +fun Container.chart(configuration: Configuration, chartWidth: Int? = null, chartHeight: Int? = null, classes: Set<String> = setOf(), init: (Chart.() -> Unit)? = null): Chart +

DSL builder extension function.

+ + + + +

checkBox

+ + +fun Container.checkBox(value: Boolean = false, name: String? = null, label: String? = null, rich: Boolean = false, init: (CheckBox.() -> Unit)? = null): CheckBox +

DSL builder extension function.

+ + + + +

checkBoxInput

+ + +fun Container.checkBoxInput(value: Boolean = false, classes: Set<String> = setOf(), init: (CheckInput.() -> Unit)? = null): CheckBoxInput +

DSL builder extension function.

+ + + +

createInstance

@@ -207,6 +305,643 @@

Helper function for creating JavaScript objects from dynamic constructors.

+ + +

dataContainer

+ + +fun <M, C : Component, CONT : Container> Container.dataContainer(model: MutableList<M>, factory: (M, Int, MutableList<M>) -> C, container: CONT, containerAdd: (CONT.(C, M) -> Unit)? = null, filter: ((M) -> Boolean)? = null, sorter: ((M) -> Comparable<*>?)? = null, sorterType: () -> SorterType = { SorterType.ASC }, init: (DataContainer<M, C, CONT>.() -> Unit)? = null): DataContainer<M, C, CONT> +

DSL builder extension function.

+fun <M, C : Component> Container.dataContainer(model: MutableList<M>, factory: (M, Int, MutableList<M>) -> C, containerAdd: (VPanel.(C, M) -> Unit)? = null, filter: ((M) -> Boolean)? = null, sorter: ((M) -> Comparable<*>?)? = null, sorterType: () -> SorterType = { SorterType.ASC }, init: (DataContainer<M, C, VPanel>.() -> Unit)? = null): DataContainer<M, C, VPanel> +

DSL builder extension function with VPanel default.

+ + + + +

dateTime

+ + +fun Container.dateTime(value: Date? = null, name: String? = null, format: String = "YYYY-MM-DD HH:mm", label: String? = null, rich: Boolean = false, init: (DateTime.() -> Unit)? = null): DateTime +

DSL builder extension function.

+ + + + +

dateTimeInput

+ + +fun Container.dateTimeInput(value: Date? = null, format: String = "YYYY-MM-DD HH:mm", classes: Set<String> = setOf(), init: (DateTimeInput.() -> Unit)? = null): DateTimeInput +

DSL builder extension function.

+ + + + +

div

+ + +fun Container.div(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Div.() -> Unit)? = null): Div +

DSL builder extension function.

+ + + + +

dockPanel

+ + +fun Container.dockPanel(classes: Set<String> = setOf(), init: (DockPanel.() -> Unit)? = null): DockPanel +

DSL builder extension function.

+ + + + +

dropDown

+ + +fun Container.dropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, direction: Direction = Direction.DROPDOWN, disabled: Boolean = false, forNavbar: Boolean = false, forDropDown: Boolean = false, classes: Set<String> = setOf(), init: (DropDown.() -> Unit)? = null): DropDown +

DSL builder extension function.

+ + + + +

fieldLabel

+ + +fun Container.fieldLabel(forId: String, content: String? = null, rich: Boolean = false, classes: Set<String> = setOf("control-label"), init: (FieldLabel.() -> Unit)? = null): FieldLabel +

DSL builder extension function.

+ + + + +

flexPanel

+ + +fun Container.flexPanel(direction: FlexDir? = null, wrap: FlexWrap? = null, justify: FlexJustify? = null, alignItems: FlexAlignItems? = null, alignContent: FlexAlignContent? = null, spacing: Int? = null, classes: Set<String> = setOf(), init: (FlexPanel.() -> Unit)? = null): FlexPanel +

DSL builder extension function.

+ + + + +

footer

+ + +fun Container.footer(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Footer.() -> Unit)? = null): Footer +

DSL builder extension function.

+ + + + +

formPanel

+ + +fun <K : Any> Container.formPanel(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, condensed: Boolean = false, classes: Set<String> = setOf(), init: (FormPanel<K>.() -> Unit)? = null): FormPanel<K> +

DSL builder extension function.

+ + + + +

gridPanel

+ + +fun Container.gridPanel(autoColumns: String? = null, autoRows: String? = null, autoFlow: GridFlow? = null, templateColumns: String? = null, templateRows: String? = null, templateAreas: List<String>? = null, columnGap: Int? = null, rowGap: Int? = null, justifyItems: GridJustify? = null, alignItems: GridAlign? = null, justifyContent: GridJustifyContent? = null, alignContent: GridAlignContent? = null, classes: Set<String> = setOf(), init: (GridPanel.() -> Unit)? = null): GridPanel +

DSL builder extension function.

+ + + + +

h1

+ + +fun Container.h1(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (H1.() -> Unit)? = null): H1 +

DSL builder extension function.

+ + + + +

h2

+ + +fun Container.h2(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (H2.() -> Unit)? = null): H2 +

DSL builder extension function.

+ + + + +

h3

+ + +fun Container.h3(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (H3.() -> Unit)? = null): H3 +

DSL builder extension function.

+ + + + +

h4

+ + +fun Container.h4(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (H4.() -> Unit)? = null): H4 +

DSL builder extension function.

+ + + + +

h5

+ + +fun Container.h5(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (H5.() -> Unit)? = null): H5 +

DSL builder extension function.

+ + + + +

h6

+ + +fun Container.h6(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (H6.() -> Unit)? = null): H6 +

DSL builder extension function.

+ + + + +

header

+ + +fun Container.header(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Header.() -> Unit)? = null): Header +

DSL builder extension function.

+ + + + +

hPanel

+ + +fun Container.hPanel(wrap: FlexWrap? = null, justify: FlexJustify? = null, alignItems: FlexAlignItems? = null, spacing: Int? = null, classes: Set<String> = setOf(), init: (HPanel.() -> Unit)? = null): HPanel +

DSL builder extension function.

+ + + + +

icon

+ + +fun Container.icon(icon: String, init: (Icon.() -> Unit)? = null): Icon +

DSL builder extension function.

+ + + + +

iframe

+ + +fun Container.iframe(src: String? = null, srcdoc: String? = null, name: String? = null, iframeWidth: Int? = null, iframeHeight: Int? = null, sandbox: Set<Sandbox>? = null, classes: Set<String> = setOf(), init: (Iframe.() -> Unit)? = null): Iframe +

DSL builder extension function.

+ + + + +

image

+ + +fun Container.image(src: ResString, alt: String? = null, responsive: Boolean = false, shape: ImageShape? = null, centered: Boolean = false, classes: Set<String> = setOf(), init: (Image.() -> Unit)? = null): Image +

DSL builder extension function.

+ + + + +

link

+ + +fun Container.link(label: String, url: String? = null, icon: String? = null, image: ResString? = null, classes: Set<String> = setOf(), init: (Link.() -> Unit)? = null): Link +

DSL builder extension function.

+ + + + +

listTag

+ + +fun Container.listTag(type: ListType, elements: List<String>? = null, rich: Boolean = false, classes: Set<String> = setOf(), init: (ListTag.() -> Unit)? = null): ListTag +

DSL builder extension function.

+ + + + +

navbar

+ + +fun Container.navbar(label: String? = null, type: NavbarType? = null, expand: NavbarExpand? = NavbarExpand.LG, nColor: NavbarColor = NavbarColor.LIGHT, bgColor: BsBgColor = BsBgColor.LIGHT, classes: Set<String> = setOf(), init: (Navbar.() -> Unit)? = null): Navbar +

DSL builder extension function.

+ + + + +

p

+ + +fun Container.p(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (P.() -> Unit)? = null): P +

DSL builder extension function.

+ + + + +

password

+ + +fun Container.password(value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false, init: (Password.() -> Unit)? = null): Password +

DSL builder extension function.

+ + + + +

progressBar

+ + +fun Container.progressBar(progress: Int, min: Int = DEFAULT_MIN, max: Int = DEFAULT_MAX, style: ProgressBarStyle? = null, striped: Boolean = false, animated: Boolean = false, content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (ProgressBar.() -> Unit)? = null): ProgressBar +

DSL builder extension function.

+ + + + +

radio

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

DSL builder extension function.

+ + + + +

radioGroup

+ + +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.

+ + + + +

radioGroupInput

+ + +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.

+ + + + +

radioInput

+ + +fun Container.radioInput(value: Boolean = false, classes: Set<String> = setOf(), init: (CheckInput.() -> Unit)? = null): RadioInput +

DSL builder extension function.

+ + + + +

removeBsBgColor

+ + +fun Component.removeBsBgColor(bsBgColor: BsBgColor): Unit + + + +

removeBsBorder

+ + +fun Component.removeBsBorder(vararg bsBorder: BsBorder): Unit + + + +

removeBsClearfix

+ + +fun Component.removeBsClearfix(): Unit + + + +

removeBsColor

+ + +fun Component.removeBsColor(bsColor: BsColor): Unit + + + +

removeBsRounded

+ + +fun Component.removeBsRounded(vararg bsRounded: BsRounded): Unit + + + +

responsiveGridPanel

+ + +fun Container.responsiveGridPanel(gridSize: GridSize = GridSize.MD, rows: Int = 0, cols: Int = 0, align: Align? = null, classes: Set<String> = setOf(), init: (ResponsiveGridPanel.() -> Unit)? = null): ResponsiveGridPanel +

DSL builder extension function.

+ + + + +

richText

+ + +fun Container.richText(value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false, init: (RichText.() -> Unit)? = null): RichText +

DSL builder extension function.

+ + + + +

richTextInput

+ + +fun Container.richTextInput(value: String? = null, classes: Set<String> = setOf(), init: (RichTextInput.() -> Unit)? = null): RichTextInput +

DSL builder extension function.

+ + + + +

section

+ + +fun Container.section(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Section.() -> Unit)? = null): Section +

DSL builder extension function.

+ + + + +

select

+ + +fun Container.select(options: List<StringPair>? = null, value: String? = null, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false, init: (Select.() -> Unit)? = null): Select +

DSL builder extension function.

+ + + + +

selectInput

+ + +fun Container.selectInput(options: List<StringPair>? = null, value: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, classes: Set<String> = setOf(), init: (SelectInput.() -> Unit)? = null): SelectInput +

DSL builder extension function.

+ + + + +

selectRemote

+ + +fun <T : Any> Container.selectRemote(value: String? = null, serviceManager: KVServiceManager<T>, function: suspend T.(String?, String?, String?) -> List<<ERROR CLASS>>, stateFunction: (() -> String)? = null, name: String? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, label: String? = null, rich: Boolean = false, init: (SelectRemote<T>.() -> Unit)? = null): SelectRemote<T> +

DSL builder extension function.

+ + + + +

selectRemoteInput

+ + +fun <T : Any> Container.selectRemoteInput(value: String? = null, serviceManager: KVServiceManager<T>, function: suspend T.(String?, String?, String?) -> List<<ERROR CLASS>>, stateFunction: (() -> String)? = null, multiple: Boolean = false, ajaxOptions: AjaxOptions? = null, classes: Set<String> = setOf(), init: (SelectRemoteInput<T>.() -> Unit)? = null): SelectRemoteInput<T> +

DSL builder extension function.

+ + + + +

simplePanel

+ + +fun Container.simplePanel(classes: Set<String> = setOf(), init: (SimplePanel.() -> Unit)? = null): SimplePanel +

DSL builder extension function.

+ + + + +

simpleSelect

+ + +fun Container.simpleSelect(options: List<StringPair>? = null, value: String? = null, emptyOption: Boolean = false, name: String? = null, label: String? = null, rich: Boolean = false, init: (SimpleSelect.() -> Unit)? = null): SimpleSelect +

DSL builder extension function.

+ + + + +

simpleSelectInput

+ + +fun Container.simpleSelectInput(options: List<StringPair>? = null, value: String? = null, emptyOption: Boolean = false, classes: Set<String> = setOf(), init: (SimpleSelectInput.() -> Unit)? = null): SimpleSelectInput +

DSL builder extension function.

+ + + + +

span

+ + +fun Container.span(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Span.() -> Unit)? = null): Span +

DSL builder extension function.

+ + + + +

spinner

+ + +fun Container.spinner(value: Number? = null, name: String? = null, min: Int? = null, max: Int? = null, step: Double = DEFAULT_STEP, decimals: Int = 0, buttonsType: ButtonsType = ButtonsType.VERTICAL, forceType: ForceType = ForceType.NONE, buttonStyle: ButtonStyle? = null, label: String? = null, rich: Boolean = false, init: (Spinner.() -> Unit)? = null): Spinner +

DSL builder extension function.

+ + + + +

spinnerInput

+ + +fun Container.spinnerInput(value: Number? = null, min: Int? = null, max: Int? = null, step: Double = DEFAULT_STEP, decimals: Int = 0, buttonsType: ButtonsType = ButtonsType.VERTICAL, forceType: ForceType = ForceType.NONE, buttonStyle: ButtonStyle? = null, classes: Set<String> = setOf(), init: (SpinnerInput.() -> Unit)? = null): SpinnerInput +

DSL builder extension function.

+ + + + +

splitPanel

+ + +fun Container.splitPanel(direction: Direction = Direction.VERTICAL, classes: Set<String> = setOf(), init: (SplitPanel.() -> Unit)? = null): SplitPanel +

DSL builder extension function.

+ + + + +

stackPanel

+ + +fun Container.stackPanel(activateLast: Boolean = true, classes: Set<String> = setOf(), init: (StackPanel.() -> Unit)? = null): StackPanel +

DSL builder extension function.

+ + + + +

stateBinding

+ + +fun <S : Any, CONT : Container> CONT.stateBinding(observableState: ObservableState<S>, factory: CONT.(S) -> Unit): StateBinding<S, CONT, Unit> +

DSL builder extension function.

+ + + + +

stateUpdate

+ + +fun <S : Any, CONT : Container, CONTENT> CONT.stateUpdate(observableState: ObservableState<S>, factory: CONT.(S) -> CONTENT): Updateable<S, CONTENT> +

DSL builder extension function for updateable redux content.

+ + + + +

table

+ + +fun Container.table(headerNames: List<String>? = null, types: Set<TableType> = setOf(), caption: String? = null, responsiveType: ResponsiveType? = null, theadType: TheadType? = null, classes: Set<String> = setOf(), init: (Table.() -> Unit)? = null): Table +

DSL builder extension function.

+ + + + +

tabPanel

+ + +fun Container.tabPanel(tabPosition: TabPosition = TabPosition.TOP, sideTabSize: SideTabSize = SideTabSize.SIZE_3, scrollableTabs: Boolean = false, classes: Set<String> = setOf(), init: (TabPanel.() -> Unit)? = null): TabPanel +

DSL builder extension function.

+ + + + +

tabulator

+ + +fun <T : Any> Container.tabulator(data: List<T>? = null, dataUpdateOnEdit: Boolean = true, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), classes: Set<String> = setOf(), init: (Tabulator<T>.() -> Unit)? = null): Tabulator<T> +

DSL builder extension function.

+fun <T : Any, S : Any, A> Container.tabulator(store: ReduxStore<S, A>, dataFactory: (S) -> List<T>, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), classes: Set<String> = setOf(), init: (Tabulator<T>.() -> Unit)? = null): Tabulator<T> +

DSL builder extension function for general redux store.

+fun <T : Any, A> Container.tabulator(store: ReduxStore<List<T>, A>, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), classes: Set<String> = setOf(), init: (Tabulator<T>.() -> Unit)? = null): Tabulator<T> +

DSL builder extension function for dedicated redux store (backed with a list).

+fun <T : Any> Container.tabulator(options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), classes: Set<String> = setOf(), init: (Tabulator<T>.() -> Unit)? = null): Tabulator<T> +

DSL builder extension function for dynamic data (send within options parameter).

+ + + + +

tabulatorRemote

+ + +fun <T : Any, E : Any> Container.tabulatorRemote(serviceManager: KVServiceManager<E>, function: suspend E.(Int?, Int?, List<<ERROR CLASS>>?, List<<ERROR CLASS>>?) -> <ERROR CLASS><T>, options: TabulatorOptions<T> = TabulatorOptions(), types: Set<TableType> = setOf(), classes: Set<String> = setOf(), init: (TabulatorRemote<T, E>.() -> Unit)? = null): TabulatorRemote<T, E> +

DSL builder extension function.

+ + + + +

tag

+ + +fun Container.tag(type: TAG, content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), attributes: Map<String, String> = mapOf(), init: (Tag.() -> Unit)? = null): Tag +

DSL builder extension function.

+ + + + +

text

+ + +fun Container.text(type: TextInputType = TextInputType.TEXT, value: String? = null, name: String? = null, label: String? = null, rich: Boolean = false, init: (Text.() -> Unit)? = null): Text +

DSL builder extension function.

+ + + + +

textArea

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

DSL builder extension function.

+ + + + +

textAreaInput

+ + +fun Container.textAreaInput(cols: Int? = null, rows: Int? = null, value: String? = null, classes: Set<String> = setOf(), init: (TextAreaInput.() -> Unit)? = null): TextAreaInput +

DSL builder extension function.

+ + + + +

textInput

+ + +fun Container.textInput(type: TextInputType = TextInputType.TEXT, value: String? = null, classes: Set<String> = setOf(), init: (TextInput.() -> Unit)? = null): TextInput +

DSL builder extension function.

+ + + + +

toolbar

+ + +fun Container.toolbar(size: ButtonGroupSize? = null, spacing: Int = 2, vertical: Boolean = false, classes: Set<String> = setOf(), init: (Toolbar.() -> Unit)? = null): Toolbar +

DSL builder extension function.

+ + + + +

upload

+ + +fun Container.upload(uploadUrl: String? = null, multiple: Boolean = false, label: String? = null, rich: Boolean = false, init: (Upload.() -> Unit)? = null): Upload +

DSL builder extension function.

+ + + + +

uploadInput

+ + +fun Container.uploadInput(uploadUrl: String? = null, multiple: Boolean = false, classes: Set<String> = setOf(), init: (UploadInput.() -> Unit)? = null): UploadInput +

DSL builder extension function.

+ + + + +

vPanel

+ + +fun Container.vPanel(justify: FlexJustify? = null, alignItems: FlexAlignItems? = null, spacing: Int? = null, classes: Set<String> = setOf(), init: (VPanel.() -> Unit)? = null): VPanel +

DSL builder extension function.

+ + + + +

widget

+ + +fun Container.widget(classes: Set<String> = setOf(), init: (Widget.() -> Unit)? = null): Widget +

DSL builder extension function.

+ + + + +

widgetWrapper

+ + +fun Container.widgetWrapper(wrapped: Component?, classes: Set<String> = setOf(), init: (WidgetWrapper.() -> Unit)? = null): WidgetWrapper +

DSL builder extension function.

+ + + + +

window

+ + +fun Container.window(caption: String? = null, contentWidth: CssSize? = CssSize(0, UNIT.auto), contentHeight: CssSize? = CssSize(0, UNIT.auto), isResizable: Boolean = true, isDraggable: Boolean = true, closeButton: Boolean = false, maximizeButton: Boolean = false, minimizeButton: Boolean = false, icon: String? = null, classes: Set<String> = setOf(), init: (Window.() -> Unit)? = null): Window +

DSL builder extension function.

+ +

Inheritors

-- cgit