From 61545b3f1fb1844af350d187edd26285e98f0466 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 26 Feb 2018 14:21:46 +0100 Subject: API documentation update --- docs/api/alltypes/index.html | 299 ++++++++++++++++++++++++------------------- 1 file changed, 167 insertions(+), 132 deletions(-) (limited to 'docs/api/alltypes') diff --git a/docs/api/alltypes/index.html b/docs/api/alltypes/index.html index 97c62758..f9555a14 100644 --- a/docs/api/alltypes/index.html +++ b/docs/api/alltypes/index.html @@ -11,13 +11,6 @@ -pl.treksoft.kvision.html.ALIGN - -

CSS align attributes.

- - - - pl.treksoft.kvision.form.text.AbstractText

Base class for form field text components.

@@ -46,142 +39,142 @@ -pl.treksoft.kvision.hmr.ApplicationBase +pl.treksoft.kvision.html.Align -

Base class for applications.

+

CSS align attributes.

-pl.treksoft.kvision.core.BGATTACH +pl.treksoft.kvision.hmr.ApplicationBase -

Definitions of CSS background attachment options.

+

Base interface for applications.

-pl.treksoft.kvision.core.BGCLIP +pl.treksoft.kvision.core.Background -

Definitions of CSS background clipping options.

+

Type-safe definition of CSS background.

-pl.treksoft.kvision.core.BGORIGIN +pl.treksoft.kvision.data.BaseDataComponent -

Definitions of CSS background origin options.

+

Base abstract class for creating observable data model.

-pl.treksoft.kvision.core.BGREPEAT +pl.treksoft.kvision.core.BgAttach -

Definitions of CSS background repeat options.

+

Definitions of CSS background attachment options.

-pl.treksoft.kvision.core.BGSIZE +pl.treksoft.kvision.core.BgClip -

Definitions of CSS background size.

+

Definitions of CSS background clipping options.

-pl.treksoft.kvision.core.BORDERSTYLE +pl.treksoft.kvision.core.BgOrigin -

Definitions of CSS border styles.

+

Definitions of CSS background origin options.

-pl.treksoft.kvision.html.BUTTONSIZE +pl.treksoft.kvision.core.BgRepeat -

Button sizes.

+

Definitions of CSS background repeat options.

-pl.treksoft.kvision.html.BUTTONSTYLE +pl.treksoft.kvision.core.BgSize -

Button styles.

+

Definitions of CSS background size.

-pl.treksoft.kvision.form.spinner.BUTTONSTYPE +pl.treksoft.kvision.form.BoolFormControl -

Spinner buttons layout types.

+

Base interface of a form control with a boolean value.

-pl.treksoft.kvision.core.Background +pl.treksoft.kvision.core.Border -

Type-safe definition of CSS background.

+

Type-safe definition of CSS border.

-pl.treksoft.kvision.data.BaseDataComponent +pl.treksoft.kvision.core.BorderStyle -

Base abstract class for creating observable data model.

+

Definitions of CSS border styles.

-pl.treksoft.kvision.form.BoolFormControl +pl.treksoft.kvision.html.Button -

Base interface of a form control with a boolean value.

+

Button component.

-pl.treksoft.kvision.core.Border +pl.treksoft.kvision.html.ButtonSize -

Type-safe definition of CSS border.

+

Button sizes.

-pl.treksoft.kvision.html.Button +pl.treksoft.kvision.html.ButtonStyle -

Button component.

+

Button styles.

-pl.treksoft.kvision.form.check.CHECKBOXSTYLE +pl.treksoft.kvision.form.spinner.ButtonsType -

Checkbox style options.

+

Spinner buttons layout types.

-pl.treksoft.kvision.form.check.CHECKINPUTTYPE +pl.treksoft.kvision.form.check.CheckBox -

Type of the check input control (checkbox or radio).

+

The form field component rendered as HTML input type="checkbox".

-pl.treksoft.kvision.core.COLOR +pl.treksoft.kvision.form.check.CheckBoxStyle -

Definitions of CSS color names.

+

Checkbox style options.

-pl.treksoft.kvision.form.check.CheckBox +pl.treksoft.kvision.form.check.CheckInput -

The form field component rendered as HTML input type="checkbox".

+

The basic input component rendered as HTML input type="checkbox" or input type="radio".

-pl.treksoft.kvision.form.check.CheckInput +pl.treksoft.kvision.form.check.CheckInputType -

The basic input component rendered as HTML input type="checkbox" or input type="radio".

+

Type of the check input control (checkbox or radio).

@@ -193,6 +186,13 @@ +pl.treksoft.kvision.core.Col + +

Definitions of CSS color names.

+ + + + pl.treksoft.kvision.core.Color

Type-safe definition of CSS color.

@@ -228,13 +228,6 @@ -pl.treksoft.kvision.form.select.DATATYPE - -

Data type for the AJAX call.

- - - - pl.treksoft.kvision.dropdown.DD

Useful options for use in DropDown's elements parameter.

@@ -242,23 +235,23 @@ -pl.treksoft.kvision.panel.DIRECTION +pl.treksoft.kvision.data.DataComponent -

Split panel direction.

+

Base interface for observable data model.

-pl.treksoft.kvision.data.DataComponent +pl.treksoft.kvision.data.DataContainer -

Base interface for observable data model.

+

A container class with support for observable data model.

-pl.treksoft.kvision.data.DataContainer +pl.treksoft.kvision.form.select.DataType -

A container class with support for observable data model.

+

Data type for the AJAX call.

@@ -297,79 +290,86 @@ -pl.treksoft.kvision.panel.DockPanel +pl.treksoft.kvision.panel.Direction -

The container with dock layout (up, down, left, right and center positions).

+

Split panel direction.

-pl.treksoft.kvision.dropdown.DropDown +pl.treksoft.kvision.html.Div -

Bootstrap dropdown component.

+

Simple component rendered as div.

-pl.treksoft.kvision.panel.FLEXALIGNCONTENT +pl.treksoft.kvision.panel.DockPanel -

CSS flexbox content alignment options.

+

The container with dock layout (up, down, left, right and center positions).

-pl.treksoft.kvision.panel.FLEXALIGNITEMS +pl.treksoft.kvision.dropdown.DropDown -

CSS flexbox alignments options.

+

Bootstrap dropdown component.

-pl.treksoft.kvision.panel.FLEXDIR +pl.treksoft.kvision.form.FieldLabel -

CSS flexbox directions.

+

Helper class for HTML label element.

-pl.treksoft.kvision.panel.FLEXJUSTIFY +pl.treksoft.kvision.panel.FlexAlignContent -

CSS flexbox justification options.

+

CSS flexbox content alignment options.

-pl.treksoft.kvision.panel.FLEXWRAP +pl.treksoft.kvision.panel.FlexAlignItems -

CSS flexbox wrap modes.

+

CSS flexbox alignments options.

-pl.treksoft.kvision.form.spinner.FORCETYPE +pl.treksoft.kvision.panel.FlexDir -

Spinner force rounding types.

+

CSS flexbox directions.

-pl.treksoft.kvision.form.FORMTYPE +pl.treksoft.kvision.panel.FlexJustify -

Bootstrap form layout options.

+

CSS flexbox justification options.

-pl.treksoft.kvision.form.FieldLabel +pl.treksoft.kvision.panel.FlexPanel -

Helper class for HTML label element.

+

The container with CSS flexbox layout support.

-pl.treksoft.kvision.panel.FlexPanel +pl.treksoft.kvision.panel.FlexWrap -

The container with CSS flexbox layout support.

+

CSS flexbox wrap modes.

+ + + + +pl.treksoft.kvision.form.spinner.ForceType + +

Spinner force rounding types.

@@ -395,51 +395,58 @@ -pl.treksoft.kvision.panel.GRIDALIGN +pl.treksoft.kvision.form.FormType + +

Bootstrap form layout options.

+ + + + +pl.treksoft.kvision.panel.GridAlign

CSS grid alignment options.

-pl.treksoft.kvision.panel.GRIDALIGNCONTENT +pl.treksoft.kvision.panel.GridAlignContent

CSS grid content alignment options.

-pl.treksoft.kvision.panel.GRIDFLOW +pl.treksoft.kvision.panel.GridFlow

CSS grid flow options.

-pl.treksoft.kvision.panel.GRIDJUSTIFY +pl.treksoft.kvision.panel.GridJustify

CSS grid justification options.

-pl.treksoft.kvision.panel.GRIDJUSTIFYCONTENT +pl.treksoft.kvision.panel.GridJustifyContent

CSS grid content justification options.

-pl.treksoft.kvision.panel.GRIDSIZE +pl.treksoft.kvision.panel.GridPanel -

Bootstrap grid sizes.

+

The container with CSS grid layout support.

-pl.treksoft.kvision.panel.GridPanel +pl.treksoft.kvision.panel.GridSize -

The container with CSS grid layout support.

+

Bootstrap grid sizes.

@@ -457,13 +464,6 @@ -pl.treksoft.kvision.form.select.HTTPTYPE - -

HTTP protocol type for the AJAX call.

- - - - pl.treksoft.kvision.form.HelpBlock

Helper class for Bootstrap help block element.

@@ -478,43 +478,43 @@ -pl.treksoft.kvision.html.IMAGESHAPE +pl.treksoft.kvision.form.select.HttpType -

Image shapes.

+

HTTP protocol type for the AJAX call.

-pl.treksoft.kvision.form.INPUTSIZE +pl.treksoft.kvision.html.Image -

Input controls sizes.

+

Image component.

-pl.treksoft.kvision.html.Image +pl.treksoft.kvision.html.ImageShape -

Image component.

+

Image shapes.

-kotlin.Int (extensions in package pl.treksoft.kvision.utils) +pl.treksoft.kvision.form.InputSize +

Input controls sizes.

-pl.treksoft.kvision.utils.KvEvent +kotlin.Int (extensions in package pl.treksoft.kvision.utils) -

Helper class for defining custom events.

-pl.treksoft.kvision.html.LISTTYPE +pl.treksoft.kvision.utils.KvEvent -

HTML list types.

+

Helper class for defining custom events.

@@ -540,9 +540,9 @@ -pl.treksoft.kvision.modal.MODALSIZE +pl.treksoft.kvision.html.ListType -

Modal window sizes.

+

HTML list types.

@@ -560,6 +560,13 @@ +pl.treksoft.kvision.modal.ModalSize + +

Modal window sizes.

+ + + + pl.treksoft.kvision.hmr.Module

Helper interface for Hot Module Replacement (HMR).

@@ -581,6 +588,13 @@ +pl.treksoft.kvision.core.Overflow + +

Definitions of CSS overflow options.

+ + + + kotlin.Pair (extensions in package pl.treksoft.kvision.utils) @@ -594,9 +608,9 @@ -pl.treksoft.kvision.form.check.RADIOSTYLE +pl.treksoft.kvision.core.Position -

Radio style options.

+

Definitions of CSS position options.

@@ -615,6 +629,13 @@ +pl.treksoft.kvision.form.check.RadioStyle + +

Radio style options.

+ + + + pl.treksoft.kvision.core.ResString

This type is used for accessing resources with CommonJS require function.

@@ -622,6 +643,13 @@ +pl.treksoft.kvision.core.Resize + +

Definitions of CSS resize options.

+ + + + pl.treksoft.kvision.panel.ResponsiveGridPanel

The container with support for Bootstrap responsive grid layout.

@@ -657,44 +685,44 @@ -pl.treksoft.kvision.form.select.SELECTWIDTHTYPE +pl.treksoft.kvision.form.select.Select -

Select width types. See Bootstrap Select width.

+

The form field component for Select control.

-pl.treksoft.kvision.panel.SIDE +pl.treksoft.kvision.form.select.SelectInput -

Dock layout directions.

+

The basic component for Select control.

-pl.treksoft.kvision.form.select.Select +pl.treksoft.kvision.form.select.SelectOptGroup -

The form field component for Select control.

+

The helper container for adding option groups to Select.

-pl.treksoft.kvision.form.select.SelectInput +pl.treksoft.kvision.form.select.SelectOption -

The basic component for Select control.

+

The helper component for adding options to Select or SelectOptGroup.

-pl.treksoft.kvision.form.select.SelectOptGroup +pl.treksoft.kvision.form.select.SelectWidthType -

The helper container for adding option groups to Select.

+

Select width types. See Bootstrap Select width.

-pl.treksoft.kvision.form.select.SelectOption +pl.treksoft.kvision.panel.Side -

The helper component for adding options to Select or SelectOptGroup.

+

Dock layout directions.

@@ -775,13 +803,6 @@ -pl.treksoft.kvision.form.text.TEXTINPUTTYPE - -

Text input types.

- - - - pl.treksoft.kvision.panel.TabPanel

The container rendering it's children as tabs.

@@ -824,6 +845,13 @@ +pl.treksoft.kvision.form.text.TextInputType + +

Text input types.

+ + + + pl.treksoft.kvision.core.UNIT

Definitions of CSS units.

@@ -850,6 +878,13 @@

This class allows to wrap a component into separately styled DIV element.

+ + +pl.treksoft.kvision.window.Window + +

Floating window container.

+ + -- cgit