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/-init-.html | 2 +- .../-date-time/autofocus.html | 2 +- .../-date-time/blur.html | 3 +- .../-date-time/days-of-week-disabled.html | 2 +- .../-date-time/disabled-dates.html | 2 +- .../-date-time/enabled-dates.html | 2 +- .../-date-time/flabel.html | 3 +- .../-date-time/focus.html | 3 +- .../-date-time/format.html | 2 +- .../-date-time/get-sn-class.html | 3 +- .../-date-time/get-value-as-string.html | 3 +- .../-date-time/hide-popup.html | 2 +- .../-date-time/ignore-readonly.html | 2 +- .../-date-time/index.html | 878 +++++++++------------ .../-date-time/input.html | 3 +- .../-date-time/invalid-feedback.html | 3 +- .../-date-time/label.html | 2 +- .../-date-time/max-date.html | 2 +- .../-date-time/min-date.html | 2 +- .../-date-time/placeholder.html | 2 +- .../-date-time/readonly.html | 2 +- .../-date-time/remove-event-listener.html | 3 +- .../-date-time/remove-event-listeners.html | 3 +- .../-date-time/rich.html | 2 +- .../-date-time/set-event-listener.html | 5 +- .../-date-time/show-clear.html | 2 +- .../-date-time/show-close.html | 2 +- .../-date-time/show-popup.html | 2 +- .../-date-time/show-today-button.html | 2 +- .../-date-time/side-by-side.html | 2 +- .../-date-time/stepping.html | 2 +- .../-date-time/toggle-popup.html | 2 +- .../-date-time/value.html | 3 +- 33 files changed, 422 insertions(+), 533 deletions(-) (limited to 'api/pl.treksoft.kvision.form.time/-date-time') diff --git a/api/pl.treksoft.kvision.form.time/-date-time/-init-.html b/api/pl.treksoft.kvision.form.time/-date-time/-init-.html index 75de1fb7..3754ae34 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time/-init-.html +++ b/api/pl.treksoft.kvision.form.time/-date-time/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.time / DateTime / <init>

<init>

- +(js) DateTime(value: Date? = null, name: String? = null, format: String = "YYYY-MM-DD HH:mm", label: String? = null, rich: Boolean = false)

Parameters

diff --git a/api/pl.treksoft.kvision.form.time/-date-time/autofocus.html b/api/pl.treksoft.kvision.form.time/-date-time/autofocus.html index 7114e220..0bb7585a 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time/autofocus.html +++ b/api/pl.treksoft.kvision.form.time/-date-time/autofocus.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.time / DateTime / autofocus

autofocus

- +(js) var autofocus: Boolean?

Determines if the date/time input is automatically focused.

diff --git a/api/pl.treksoft.kvision.form.time/-date-time/blur.html b/api/pl.treksoft.kvision.form.time/-date-time/blur.html index 499cf820..0321f72e 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time/blur.html +++ b/api/pl.treksoft.kvision.form.time/-date-time/blur.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.time / DateTime / blur

blur

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

Overrides FormControl.blur

Makes the input element blur.

diff --git a/api/pl.treksoft.kvision.form.time/-date-time/days-of-week-disabled.html b/api/pl.treksoft.kvision.form.time/-date-time/days-of-week-disabled.html index ab9639ac..2132c67d 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time/days-of-week-disabled.html +++ b/api/pl.treksoft.kvision.form.time/-date-time/days-of-week-disabled.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.time / DateTime / daysOfWeekDisabled

daysOfWeekDisabled

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

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

diff --git a/api/pl.treksoft.kvision.form.time/-date-time/disabled-dates.html b/api/pl.treksoft.kvision.form.time/-date-time/disabled-dates.html index df0ab973..cc7494f5 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time/disabled-dates.html +++ b/api/pl.treksoft.kvision.form.time/-date-time/disabled-dates.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.time / DateTime / disabledDates

disabledDates

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

An array of disabled dates.

diff --git a/api/pl.treksoft.kvision.form.time/-date-time/enabled-dates.html b/api/pl.treksoft.kvision.form.time/-date-time/enabled-dates.html index 6e92d71b..4ff5cd62 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time/enabled-dates.html +++ b/api/pl.treksoft.kvision.form.time/-date-time/enabled-dates.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.time / DateTime / enabledDates

enabledDates

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

An array of enabled dates.

diff --git a/api/pl.treksoft.kvision.form.time/-date-time/flabel.html b/api/pl.treksoft.kvision.form.time/-date-time/flabel.html index 3ff85b02..f2ef5455 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time/flabel.html +++ b/api/pl.treksoft.kvision.form.time/-date-time/flabel.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.time / DateTime / flabel

flabel

- +(js) val flabel: FieldLabel -

Overrides FormControl.flabel

Form field label.

diff --git a/api/pl.treksoft.kvision.form.time/-date-time/focus.html b/api/pl.treksoft.kvision.form.time/-date-time/focus.html index 91a1e22f..3233fa98 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time/focus.html +++ b/api/pl.treksoft.kvision.form.time/-date-time/focus.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.time / DateTime / focus

focus

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

Overrides FormControl.focus

Makes the input element focused.

diff --git a/api/pl.treksoft.kvision.form.time/-date-time/format.html b/api/pl.treksoft.kvision.form.time/-date-time/format.html index 3532f083..52aa3a5a 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time/format.html +++ b/api/pl.treksoft.kvision.form.time/-date-time/format.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.time / DateTime / format

format

- +(js) var format: String

Date/time format.

diff --git a/api/pl.treksoft.kvision.form.time/-date-time/get-sn-class.html b/api/pl.treksoft.kvision.form.time/-date-time/get-sn-class.html index 7d7912f3..2e9c9a72 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time/get-sn-class.html +++ b/api/pl.treksoft.kvision.form.time/-date-time/get-sn-class.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.time / DateTime / 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/get-value-as-string.html b/api/pl.treksoft.kvision.form.time/-date-time/get-value-as-string.html index 8901d009..f44ac1a0 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time/get-value-as-string.html +++ b/api/pl.treksoft.kvision.form.time/-date-time/get-value-as-string.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.time / DateTime / getValueAsString

getValueAsString

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

Overrides DateFormControl.getValueAsString

Returns the value of the control as a String.

diff --git a/api/pl.treksoft.kvision.form.time/-date-time/hide-popup.html b/api/pl.treksoft.kvision.form.time/-date-time/hide-popup.html index 6b768d20..25609898 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time/hide-popup.html +++ b/api/pl.treksoft.kvision.form.time/-date-time/hide-popup.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.time / DateTime / hidePopup

hidePopup

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

Hides date/time chooser popup.

diff --git a/api/pl.treksoft.kvision.form.time/-date-time/ignore-readonly.html b/api/pl.treksoft.kvision.form.time/-date-time/ignore-readonly.html index 05c1de36..7bffc9b6 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time/ignore-readonly.html +++ b/api/pl.treksoft.kvision.form.time/-date-time/ignore-readonly.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.time / DateTime / ignoreReadonly

ignoreReadonly

- +(js) var ignoreReadonly: Boolean

Allow date picker for readonly component..

diff --git a/api/pl.treksoft.kvision.form.time/-date-time/index.html b/api/pl.treksoft.kvision.form.time/-date-time/index.html index 3fc8d155..3ee2ecc7 100644 --- a/api/pl.treksoft.kvision.form.time/-date-time/index.html +++ b/api/pl.treksoft.kvision.form.time/-date-time/index.html @@ -8,14 +8,15 @@ kvision / pl.treksoft.kvision.form.time / DateTime

DateTime

-open class DateTime : SimplePanel, DateFormControl +(js) open class DateTime : SimplePanel, DateFormControl

Form field date/time chooser component.

Constructors

@@ -27,204 +28,192 @@ +var autofocus: Boolean? +var daysOfWeekDisabled: Array<Int> +var disabledDates: Array<Date> +var enabledDates: Array<Date> +val flabel: FieldLabel +var format: String +var ignoreReadonly: Boolean +val input: DateTimeInput +val invalidFeedback: InvalidFeedback +var label: String? +var maxDate: Date? +var minDate: Date? +var placeholder: String? +var readonly: Boolean? +var rich: Boolean +var showClear: Boolean +var showClose: Boolean +var showTodayButton: Boolean +var sideBySide: Boolean +var stepping: Int - - -
-

<init>

+(js) +

<init>

 DateTime(value: Date? = null, name: String? = null, format: String = "YYYY-MM-DD HH:mm", label: String? = null, rich: Boolean = false)
-

autofocus

+(js) +

autofocus

 -var autofocus: Boolean?

Determines if the date/time 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.

-
-

disabledDates

+(js) +

disabledDates

 -var disabledDates: Array<Date>

An array of disabled dates.

-
-

enabledDates

+(js) +

enabledDates

 -var enabledDates: Array<Date>

An array of enabled dates.

-
-

flabel

+(js) +

flabel

 -val flabel: FieldLabel

Form field label.

-
-

format

+(js) +

format

 -var format: String

Date/time format.

-
-

ignoreReadonly

+(js) +

ignoreReadonly

 -var ignoreReadonly: Boolean

Allow date picker for readonly component..

-
-

input

+(js) +

input

 -val input: DateTimeInput

The actual input component.

-
-

invalidFeedback

+(js) +

invalidFeedback

 -val invalidFeedback: InvalidFeedback

Invalid feedback component.

-
-

label

+(js) +

label

 -var label: String?

The label text bound to the input element.

-
-

maxDate

+(js) +

maxDate

 -var maxDate: Date?

Prevents date selection after this date.

-
-

minDate

+(js) +

minDate

 -var minDate: Date?

Prevents date selection before this date.

-
-

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.

-
-

rich

+(js) +

rich

 -var rich: Boolean

Determines if label can contain HTML code.

-
-

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.

-
-

stepping

+(js) +

stepping

 -var stepping: Int

The increment used to build the hour view.

-
-

value

+(js) +

value

 -open var value: Date?

Date/time input value.

-
-

Inherited Properties

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

children

-		 -val children: MutableList<Component>
@@ -233,188 +222,93 @@ -

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

-open fun getValueAsString(): String?

Returns the value of the control as a String.

- +open fun getValueAsString(): String? -

hidePopup

+(js) +

hidePopup

-open fun hidePopup(): Unit

Hides date/time chooser popup.

- +open fun hidePopup(): Unit -

removeEventListener

+(js) +

removeEventListener

-open fun removeEventListener(id: Int): Widget

Removes event listener from current widget.

- +open fun removeEventListener(id: Int): Widget -

removeEventListeners

+(js) +

removeEventListeners

-open fun removeEventListeners(): Widget

Removes all event listeners from current widget.

- +open fun removeEventListeners(): Widget -

setEventListener

+(js) +

setEventListener

-open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Int

Sets an event listener for current widget, keeping the actual type of component.

- +open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Int -

showPopup

+(js) +

showPopup

-open fun showPopup(): Unit

Open date/time chooser popup.

- +open fun showPopup(): Unit -

togglePopup

+(js) +

togglePopup

-open fun togglePopup(): Unit

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

-
-

getValue

-		 -open fun getValue(): Date? -

Returns the value of the control.

-
-

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.

-
-

setValue

-		 -open fun setValue(v: Any?): Unit -

Sets the value of the control.

-
@@ -423,24 +317,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> @@ -449,867 +346,870 @@ -

addBsBgColor

+(js) +

addBsBgColor

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

addBsBorder

+(js) +

addBsBorder

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

addBsClearfix

+(js) +

addBsClearfix

fun