From 0365722f8549ee93918be99da1b9f901cf0b2c8d Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Fri, 13 Mar 2020 01:05:20 +0100 Subject: API documentation for KVision 3.5.2 --- .../-date-time-input/-init-.html | 2 +- .../-date-time-input/after-destroy.html | 3 +- .../-date-time-input/after-insert.html | 3 +- .../-date-time-input/autofocus.html | 2 +- .../-date-time-input/blur.html | 3 +- .../-date-time-input/days-of-week-disabled.html | 2 +- .../-date-time-input/disabled-dates.html | 2 +- .../-date-time-input/disabled.html | 3 +- .../-date-time-input/enabled-dates.html | 2 +- .../-date-time-input/focus.html | 3 +- .../-date-time-input/format.html | 2 +- .../-date-time-input/get-sn-class.html | 3 +- .../-date-time-input/get-value-as-string.html | 2 +- .../-date-time-input/hide-popup.html | 2 +- .../-date-time-input/ignore-readonly.html | 2 +- .../-date-time-input/index.html | 851 ++++++++++----------- .../-date-time-input/max-date.html | 2 +- .../-date-time-input/min-date.html | 2 +- .../-date-time-input/name.html | 3 +- .../-date-time-input/placeholder.html | 2 +- .../-date-time-input/readonly.html | 2 +- .../-date-time-input/refresh-date-picker.html | 2 +- .../-date-time-input/show-clear.html | 2 +- .../-date-time-input/show-close.html | 2 +- .../-date-time-input/show-popup.html | 2 +- .../-date-time-input/show-today-button.html | 2 +- .../-date-time-input/side-by-side.html | 2 +- .../-date-time-input/size.html | 3 +- .../-date-time-input/stepping.html | 2 +- .../-date-time-input/toggle-popup.html | 2 +- .../-date-time-input/validation-status.html | 3 +- .../-date-time-input/value.html | 2 +- 32 files changed, 416 insertions(+), 506 deletions(-) (limited to 'api/pl.treksoft.kvision.form.time/-date-time-input') diff --git a/api/pl.treksoft.kvision.form.time/-date-time-input/-init-.html b/api/pl.treksoft.kvision.form.time/-date-time-input/-init-.html index 49547cce..ced2103e 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time-input/-init-.html +++ b/api/pl.treksoft.kvision.form.time/-date-time-input/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.time / DateTimeInput / <init>

<init>

- +(js) DateTimeInput(value: Date? = null, format: String = "YYYY-MM-DD HH:mm", classes: Set<String> = setOf())

Parameters

diff --git a/api/pl.treksoft.kvision.form.time/-date-time-input/after-destroy.html b/api/pl.treksoft.kvision.form.time/-date-time-input/after-destroy.html index 36547ae2..66cd403b 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time-input/after-destroy.html +++ b/api/pl.treksoft.kvision.form.time/-date-time-input/after-destroy.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.time / DateTimeInput / afterDestroy

afterDestroy

- +(js) protected open fun afterDestroy(): Unit -

Overrides Widget.afterDestroy

Method called after destroying Snabbdom vnode.

diff --git a/api/pl.treksoft.kvision.form.time/-date-time-input/after-insert.html b/api/pl.treksoft.kvision.form.time/-date-time-input/after-insert.html index 6cbf8093..1a4eda2a 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time-input/after-insert.html +++ b/api/pl.treksoft.kvision.form.time/-date-time-input/after-insert.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.time / DateTimeInput / afterInsert

afterInsert

- +(js) protected open fun afterInsert(node: VNode): Unit -

Overrides Widget.afterInsert

Method called after inserting Snabbdom vnode into the DOM.

diff --git a/api/pl.treksoft.kvision.form.time/-date-time-input/autofocus.html b/api/pl.treksoft.kvision.form.time/-date-time-input/autofocus.html index db39e3d2..be18508c 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time-input/autofocus.html +++ b/api/pl.treksoft.kvision.form.time/-date-time-input/autofocus.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.time / DateTimeInput / autofocus

autofocus

- +(js) var autofocus: Boolean?

Determines if the text input is automatically focused.

diff --git a/api/pl.treksoft.kvision.form.time/-date-time-input/blur.html b/api/pl.treksoft.kvision.form.time/-date-time-input/blur.html index 418a28b6..889b64b9 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time-input/blur.html +++ b/api/pl.treksoft.kvision.form.time/-date-time-input/blur.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.time / DateTimeInput / blur

blur

- +(js) open fun blur(): Unit -

Overrides FormInput.blur

Makes the input element blur.

diff --git a/api/pl.treksoft.kvision.form.time/-date-time-input/days-of-week-disabled.html b/api/pl.treksoft.kvision.form.time/-date-time-input/days-of-week-disabled.html index a2eb611d..10533d38 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time-input/days-of-week-disabled.html +++ b/api/pl.treksoft.kvision.form.time/-date-time-input/days-of-week-disabled.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.time / DateTimeInput / daysOfWeekDisabled

daysOfWeekDisabled

- +(js) var daysOfWeekDisabled: Array<Int>

Days of the week that should be disabled. Multiple values should be comma separated.

Getter
diff --git a/api/pl.treksoft.kvision.form.time/-date-time-input/disabled-dates.html b/api/pl.treksoft.kvision.form.time/-date-time-input/disabled-dates.html index 85ea9c43..6a3f7539 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time-input/disabled-dates.html +++ b/api/pl.treksoft.kvision.form.time/-date-time-input/disabled-dates.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.time / DateTimeInput / disabledDates

disabledDates

- +(js) var disabledDates: Array<Date>

An array of disabled dates.

Getter
diff --git a/api/pl.treksoft.kvision.form.time/-date-time-input/disabled.html b/api/pl.treksoft.kvision.form.time/-date-time-input/disabled.html index 12c81e49..2be09c8c 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time-input/disabled.html +++ b/api/pl.treksoft.kvision.form.time/-date-time-input/disabled.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.time / DateTimeInput / disabled

disabled

- +(js) open var disabled: Boolean -

Overrides FormInput.disabled

Determines if the field is disabled.

diff --git a/api/pl.treksoft.kvision.form.time/-date-time-input/enabled-dates.html b/api/pl.treksoft.kvision.form.time/-date-time-input/enabled-dates.html index c23a244c..07966485 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time-input/enabled-dates.html +++ b/api/pl.treksoft.kvision.form.time/-date-time-input/enabled-dates.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.time / DateTimeInput / enabledDates

enabledDates

- +(js) var enabledDates: Array<Date>

An array of enabled dates.

Getter
diff --git a/api/pl.treksoft.kvision.form.time/-date-time-input/focus.html b/api/pl.treksoft.kvision.form.time/-date-time-input/focus.html index a6cb4d2f..9f05037d 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time-input/focus.html +++ b/api/pl.treksoft.kvision.form.time/-date-time-input/focus.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.time / DateTimeInput / focus

focus

- +(js) open fun focus(): Unit -

Overrides FormInput.focus

Makes the input element focused.

diff --git a/api/pl.treksoft.kvision.form.time/-date-time-input/format.html b/api/pl.treksoft.kvision.form.time/-date-time-input/format.html index abe86341..d7af1f42 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time-input/format.html +++ b/api/pl.treksoft.kvision.form.time/-date-time-input/format.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.time / DateTimeInput / format

format

- +(js) var format: String

Date/time format.

Getter
diff --git a/api/pl.treksoft.kvision.form.time/-date-time-input/get-sn-class.html b/api/pl.treksoft.kvision.form.time/-date-time-input/get-sn-class.html index 05b1667d..bfa7a175 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time-input/get-sn-class.html +++ b/api/pl.treksoft.kvision.form.time/-date-time-input/get-sn-class.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.time / DateTimeInput / getSnClass

getSnClass

- +(js) protected open fun getSnClass(): List<StringBoolPair> -

Overrides Widget.getSnClass

Returns list of CSS class names for current widget in the form of a List.

Return
list of CSS class names

diff --git a/api/pl.treksoft.kvision.form.time/-date-time-input/get-value-as-string.html b/api/pl.treksoft.kvision.form.time/-date-time-input/get-value-as-string.html index ccb47de8..c3b740f8 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time-input/get-value-as-string.html +++ b/api/pl.treksoft.kvision.form.time/-date-time-input/get-value-as-string.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.time / DateTimeInput / getValueAsString

getValueAsString

- +(js) fun getValueAsString(): String?

Get value of date/time input control as String

Return
diff --git a/api/pl.treksoft.kvision.form.time/-date-time-input/hide-popup.html b/api/pl.treksoft.kvision.form.time/-date-time-input/hide-popup.html index 0f885ccc..39a4a302 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time-input/hide-popup.html +++ b/api/pl.treksoft.kvision.form.time/-date-time-input/hide-popup.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.time / DateTimeInput / hidePopup

hidePopup

- +(js) open fun hidePopup(): Unit

Hides date/time chooser popup.

diff --git a/api/pl.treksoft.kvision.form.time/-date-time-input/ignore-readonly.html b/api/pl.treksoft.kvision.form.time/-date-time-input/ignore-readonly.html index 56a5bdec..0e2296e5 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time-input/ignore-readonly.html +++ b/api/pl.treksoft.kvision.form.time/-date-time-input/ignore-readonly.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.time / DateTimeInput / ignoreReadonly

ignoreReadonly

- +(js) var ignoreReadonly: Boolean

Allow date picker for readonly component.

Getter
diff --git a/api/pl.treksoft.kvision.form.time/-date-time-input/index.html b/api/pl.treksoft.kvision.form.time/-date-time-input/index.html index 971dbc56..1f3bc514 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time-input/index.html +++ b/api/pl.treksoft.kvision.form.time/-date-time-input/index.html @@ -8,14 +8,15 @@ kvision / pl.treksoft.kvision.form.time / DateTimeInput

DateTimeInput

-open class DateTimeInput : SimplePanel, FormInput +(js) open class DateTimeInput : SimplePanel, FormInput

Basic date/time chooser component.

Constructors

@@ -27,195 +28,183 @@ +var autofocus: Boolean? +var daysOfWeekDisabled: Array<Int> +open var disabled: Boolean +var disabledDates: Array<Date> +var enabledDates: Array<Date> +var format: String +var ignoreReadonly: Boolean +var maxDate: Date? +var minDate: Date? +open var name: String? +var placeholder: String? +var readonly: Boolean? +var showClear: Boolean +var showClose: Boolean +var showTodayButton: Boolean +var sideBySide: Boolean +open var size: InputSize? +var stepping: Int +open var validationStatus: ValidationStatus? - - -
-

<init>

+(js) +

<init>

 DateTimeInput(value: Date? = null, format: String = "YYYY-MM-DD HH:mm", classes: Set<String> = setOf())
-

autofocus

+(js) +

autofocus

 -var autofocus: Boolean?

Determines if the text input is automatically focused.

-
-

daysOfWeekDisabled

+(js) +

daysOfWeekDisabled

 -var daysOfWeekDisabled: Array<Int>

Days of the week that should be disabled. Multiple values should be comma separated.

-
-

disabled

+(js) +

disabled

 -open var disabled: Boolean

Determines if the field is disabled.

-
-

disabledDates

+(js) +

disabledDates

 -var disabledDates: Array<Date>

An array of disabled dates.

-
-

enabledDates

+(js) +

enabledDates

 -var enabledDates: Array<Date>

An array of enabled dates.

-
-

format

+(js) +

format

 -var format: String

Date/time format.

-
-

ignoreReadonly

+(js) +

ignoreReadonly

 -var ignoreReadonly: Boolean

Allow date picker for readonly component.

-
-

maxDate

+(js) +

maxDate

 -var maxDate: Date?

Prevents date selection after this date.

-
-

minDate

+(js) +

minDate

 -var minDate: Date?

Prevents date selection before this date.

-
-

name

+(js) +

name

 -open var name: String?

The name attribute of the generated HTML input element.

-
-

placeholder

+(js) +

placeholder

 -var placeholder: String?

The placeholder for the date/time input.

-
-

readonly

+(js) +

readonly

 -var readonly: Boolean?

Determines if the date/time input is read-only.

-
-

showClear

+(js) +

showClear

 -var showClear: Boolean

Determines if Clear button should be visible.

-
-

showClose

+(js) +

showClose

 -var showClose: Boolean

Determines if Close button should be visible.

-
-

showTodayButton

+(js) +

showTodayButton

 -var showTodayButton: Boolean

Determines if Today button should be visible.

-
-

sideBySide

+(js) +

sideBySide

 -var sideBySide: Boolean

Shows date and time pickers side by side.

-
-

size

+(js) +

size

 -open var size: InputSize?

The size of the input.

-
-

stepping

+(js) +

stepping

 -var stepping: Int

The increment used to build the hour view.

-
-

validationStatus

+(js) +

validationStatus

 -open var validationStatus: ValidationStatus?

The validation status of the input.

-
-

value

+(js) +

value

 -var value: Date?

Date/time input value.

-
-

Inherited Properties

- - - - - +var value: Date?
-

children

-		 -val children: MutableList<Component>
@@ -224,168 +213,92 @@ -

afterDestroy

+(js) +

afterDestroy

-open fun afterDestroy(): Unit

Method called after destroying Snabbdom vnode.

- +open fun afterDestroy(): Unit -

afterInsert

+(js) +

afterInsert

-open fun afterInsert(node: VNode): Unit

Method called after inserting Snabbdom vnode into the DOM.

- +open fun afterInsert(node: VNode): Unit -

blur

+(js) +

blur

-open fun blur(): Unit

Makes the input element blur.

- +open fun blur(): Unit -

focus

+(js) +

focus

-open fun focus(): Unit

Makes the input element focused.

- +open fun focus(): Unit -

getSnClass

+(js) +

getSnClass

-open fun getSnClass(): List<StringBoolPair>

Returns list of CSS class names for current widget in the form of a List.

- +open fun getSnClass(): List<StringBoolPair> -

getValueAsString

+(js) +

getValueAsString

-fun getValueAsString(): String?

Get value of date/time input control as String

- +fun getValueAsString(): String? -

hidePopup

+(js) +

hidePopup

-open fun hidePopup(): Unit

Hides date/time chooser popup.

- +open fun hidePopup(): Unit -

refreshDatePicker

+(js) +

refreshDatePicker

open fun refreshDatePicker(): Unit -

showPopup

+(js) +

showPopup

-open fun showPopup(): Unit

Open date/time chooser popup.

- +open fun showPopup(): Unit -

togglePopup

+(js) +

togglePopup

-open fun togglePopup(): Unit

Toggles date/time chooser popup.

- - - - -

Inherited Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +open fun togglePopup(): Unit
-

add

-		 -open fun add(child: Component): SimplePanel -

Adds given component to the current container.

-
-

addAll

-		 -open fun addAll(children: List<Component>): SimplePanel -

Adds a list of components to the current container.

-
-

addInternal

-		 -fun addInternal(child: Component): SimplePanel -

Protected and final method to add given component to the current container.

-
-

childrenVNodes

-		 -open fun childrenVNodes(): Array<VNode> -

Returns the array of the children Snabbdom vnodes.

-
-

getChildren

-		 -open fun getChildren(): List<Component> -

Returns a list of children of the current container.

-
-

remove

-		 -open fun remove(child: Component): SimplePanel -

Removes given component from the current container.

-
-

removeAll

-		 -open fun removeAll(): SimplePanel -

Removes all children from the current container.

-
-

render

-		 -open fun render(): VNode -

Renders current component as a Snabbdom vnode.

-
@@ -394,24 +307,27 @@ -

changeFlow

+(js) +

changeFlow

-val <T : Widget> T.changeFlow: <ERROR CLASS><T> +val <T : Widget> T.changeFlow: Flow<T> -

clickFlow

+(js) +

clickFlow

-val <T : Widget> T.clickFlow: <ERROR CLASS><T> +val <T : Widget> T.clickFlow: Flow<T> -

inputFlow

+(js) +

inputFlow

-val <T : Widget> T.inputFlow: <ERROR CLASS><T> +val <T : Widget> T.inputFlow: Flow<T> @@ -420,867 +336,870 @@ -

addBsBgColor

+(js) +

addBsBgColor

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

addBsBorder

+(js) +

addBsBorder

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

addBsClearfix

+(js) +

addBsClearfix

fun Component.addBsClearfix(): Unit -

addBsColor

+(js) +

addBsColor

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

addBsRounded

+(js) +

addBsRounded

fun Component.addBsRounded(vararg bs