From 7c2850063697f94a0d8b8d8f8588136dd4b3d05e Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 21 Oct 2018 23:59:34 +0200 Subject: API documentation for KVision 0.0.19 --- .../-date-time/-init-.html | 27 -- .../-date-time/autofocus.html | 15 - .../-date-time/blur.html | 16 - .../-date-time/clear-btn.html | 15 - .../-date-time/date-time.html | 16 - .../-date-time/days-of-week-disabled.html | 15 - .../-date-time/flabel.html | 16 - .../-date-time/focus.html | 16 - .../-date-time/format.html | 15 - .../-date-time/get-sn-class.html | 18 - .../-date-time/get-value-as-string.html | 16 - .../-date-time/hide-popup.html | 15 - .../-date-time/index.html | 372 --------------------- .../-date-time/input.html | 16 - .../-date-time/label.html | 15 - .../-date-time/minute-step.html | 15 - .../-date-time/placeholder.html | 15 - .../-date-time/readonly.html | 15 - .../-date-time/remove-event-listeners.html | 18 - .../-date-time/rich.html | 15 - .../-date-time/set-event-listener.html | 54 --- .../-date-time/show-meridian.html | 15 - .../-date-time/show-popup.html | 15 - .../-date-time/today-btn.html | 15 - .../-date-time/today-highlight.html | 15 - .../-date-time/validation-info.html | 16 - .../-date-time/value.html | 16 - .../-date-time/week-start.html | 15 - 28 files changed, 842 deletions(-) delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/-init-.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/autofocus.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/blur.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/clear-btn.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/date-time.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/days-of-week-disabled.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/flabel.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/focus.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/format.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/get-sn-class.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/get-value-as-string.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/hide-popup.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/index.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/input.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/label.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/minute-step.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/placeholder.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/readonly.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/remove-event-listeners.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/rich.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/set-event-listener.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/show-meridian.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/show-popup.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/today-btn.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/today-highlight.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/validation-info.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/value.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time/week-start.html (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 deleted file mode 100644 index 75de1fb7..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/-init-.html +++ /dev/null @@ -1,27 +0,0 @@ - - - -DateTime.<init> - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime / <init>
-
-

<init>

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

Parameters

-

-value - date/time input value

-

-name - the name attribute of the generated HTML input element

-

-format - date/time format (default YYYY-MM-DD HH:mm)

-

-label - label text bound to the input element

-

-rich - determines if label can contain HTML code

-

Constructor
-

- - diff --git a/api/pl.treksoft.kvision.form.time/-date-time/autofocus.html b/api/pl.treksoft.kvision.form.time/-date-time/autofocus.html deleted file mode 100644 index 7114e220..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/autofocus.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -DateTime.autofocus - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime / autofocus
-
-

autofocus

- -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 deleted file mode 100644 index 499cf820..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/blur.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -DateTime.blur - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime / blur
-
-

blur

- -open fun blur(): Unit -

Overrides FormControl.blur

-

Makes the input element blur.

- - diff --git a/api/pl.treksoft.kvision.form.time/-date-time/clear-btn.html b/api/pl.treksoft.kvision.form.time/-date-time/clear-btn.html deleted file mode 100644 index e4ba22de..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/clear-btn.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -DateTime.clearBtn - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime / clearBtn
-
-

clearBtn

- -var clearBtn: Boolean -

Determines if Clear button should be visible.

- - diff --git a/api/pl.treksoft.kvision.form.time/-date-time/date-time.html b/api/pl.treksoft.kvision.form.time/-date-time/date-time.html deleted file mode 100644 index 718c8eaf..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/date-time.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -DateTime.dateTime - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime / dateTime
-
-

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.

-

It takes the same parameters as the constructor of the built component.

- - 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 deleted file mode 100644 index ab9639ac..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/days-of-week-disabled.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -DateTime.daysOfWeekDisabled - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime / daysOfWeekDisabled
-
-

daysOfWeekDisabled

- -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/flabel.html b/api/pl.treksoft.kvision.form.time/-date-time/flabel.html deleted file mode 100644 index 3ff85b02..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/flabel.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -DateTime.flabel - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime / flabel
-
-

flabel

- -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 deleted file mode 100644 index 91a1e22f..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/focus.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -DateTime.focus - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime / focus
-
-

focus

- -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 deleted file mode 100644 index 3532f083..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/format.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -DateTime.format - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime / format
-
-

format

- -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 deleted file mode 100644 index 7d7912f3..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/get-sn-class.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -DateTime.getSnClass - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime / getSnClass
-
-

getSnClass

- -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 deleted file mode 100644 index 8901d009..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/get-value-as-string.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -DateTime.getValueAsString - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime / getValueAsString
-
-

getValueAsString

- -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 deleted file mode 100644 index 6b768d20..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/hide-popup.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -DateTime.hidePopup - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime / hidePopup
-
-

hidePopup

- -open fun hidePopup(): Unit -

Hides date/time chooser popup.

- - diff --git a/api/pl.treksoft.kvision.form.time/-date-time/index.html b/api/pl.treksoft.kvision.form.time/-date-time/index.html deleted file mode 100644 index e31348af..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/index.html +++ /dev/null @@ -1,372 +0,0 @@ - - - -DateTime - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime
-
-

DateTime

-open class DateTime : SimplePanel, DateFormControl -

Form field date/time chooser component.

-

Constructors

- - - - - - - -
-

<init>

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

Properties

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

autofocus

-		 -var autofocus: Boolean? -

Determines if the date/time input is automatically focused.

-
-

clearBtn

-		 -var clearBtn: Boolean -

Determines if Clear button should be visible.

-
-

daysOfWeekDisabled

-		 -var daysOfWeekDisabled: Array<Int> -

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

-
-

flabel

-		 -val flabel: FieldLabel -

Form field label.

-
-

format

-		 -var format: String -

Date/time format.

-
-

input

-		 -val input: DateTimeInput -

The actual input component.

-
-

label

-		 -var label: String? -

The label text bound to the input element.

-
-

minuteStep

-		 -var minuteStep: Int -

The increment used to build the hour view.

-
-

placeholder

-		 -var placeholder: String? -

The placeholder for the date/time input.

-
-

readonly

-		 -var readonly: Boolean? -

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

-
-

rich

-		 -var rich: Boolean -

Determines if label can contain HTML code.

-
-

showMeridian

-		 -var showMeridian: Boolean -

Determines if meridian views are visible in day and hour views.

-
-

todayBtn

-		 -var todayBtn: Boolean -

Determines if Today button should be visible.

-
-

todayHighlight

-		 -var todayHighlight: Boolean -

Determines if the current day should be highlighted.

-
-

validationInfo

-		 -val validationInfo: HelpBlock -

Validation info component.

-
-

value

-		 -open var value: Date? -

Date/time input value.

-
-

weekStart

-		 -var weekStart: Int -

Day of the week start. 0 (Sunday) to 6 (Saturday).

-
-

Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

blur

-		 -open fun blur(): Unit -

Makes the input element blur.

-
-

focus

-		 -open fun focus(): Unit -

Makes the input element focused.

-
-

getSnClass

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

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

-
-

getValueAsString

-		 -open fun getValueAsString(): String? -

Returns the value of the control as a String.

-
-

hidePopup

-		 -open fun hidePopup(): Unit -

Hides date/time chooser popup.

-
-

removeEventListeners

-		 -open fun removeEventListeners(): Widget -

Removes all event listeners from current widget.

-
-

setEventListener

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

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

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

Sets an event listener for current widget.

-
-

showPopup

-		 -open fun showPopup(): Unit -

Open date/time chooser popup.

-
-

Inherited Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

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.

-
-

Companion Object Functions

- - - - - - - -
-

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.

-
- - diff --git a/api/pl.treksoft.kvision.form.time/-date-time/input.html b/api/pl.treksoft.kvision.form.time/-date-time/input.html deleted file mode 100644 index a8da2e0c..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/input.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -DateTime.input - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime / input
-
-

input

- -val input: DateTimeInput -

Overrides FormControl.input

-

The actual input component.

- - diff --git a/api/pl.treksoft.kvision.form.time/-date-time/label.html b/api/pl.treksoft.kvision.form.time/-date-time/label.html deleted file mode 100644 index 0357010e..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/label.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -DateTime.label - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime / label
-
-

label

- -var label: String? -

The label text bound to the input element.

- - diff --git a/api/pl.treksoft.kvision.form.time/-date-time/minute-step.html b/api/pl.treksoft.kvision.form.time/-date-time/minute-step.html deleted file mode 100644 index 5073b48e..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/minute-step.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -DateTime.minuteStep - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime / minuteStep
-
-

minuteStep

- -var minuteStep: Int -

The increment used to build the hour view.

- - diff --git a/api/pl.treksoft.kvision.form.time/-date-time/placeholder.html b/api/pl.treksoft.kvision.form.time/-date-time/placeholder.html deleted file mode 100644 index f59806f7..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/placeholder.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -DateTime.placeholder - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime / placeholder
-
-

placeholder

- -var placeholder: String? -

The placeholder for the date/time input.

- - diff --git a/api/pl.treksoft.kvision.form.time/-date-time/readonly.html b/api/pl.treksoft.kvision.form.time/-date-time/readonly.html deleted file mode 100644 index c39736fe..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/readonly.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -DateTime.readonly - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime / readonly
-
-

readonly

- -var readonly: Boolean? -

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

- - diff --git a/api/pl.treksoft.kvision.form.time/-date-time/remove-event-listeners.html b/api/pl.treksoft.kvision.form.time/-date-time/remove-event-listeners.html deleted file mode 100644 index 895dbb10..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/remove-event-listeners.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -DateTime.removeEventListeners - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime / removeEventListeners
-
-

removeEventListeners

- -open fun removeEventListeners(): Widget -

Overrides Widget.removeEventListeners

-

Removes all event listeners from current widget.

-

Return
-current widget

- - diff --git a/api/pl.treksoft.kvision.form.time/-date-time/rich.html b/api/pl.treksoft.kvision.form.time/-date-time/rich.html deleted file mode 100644 index 9b6fb236..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/rich.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -DateTime.rich - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime / rich
-
-

rich

- -var rich: Boolean -

Determines if label can contain HTML code.

- - diff --git a/api/pl.treksoft.kvision.form.time/-date-time/set-event-listener.html b/api/pl.treksoft.kvision.form.time/-date-time/set-event-listener.html deleted file mode 100644 index 40d2ae32..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/set-event-listener.html +++ /dev/null @@ -1,54 +0,0 @@ - - - -DateTime.setEventListener - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTime / setEventListener
-
-

setEventListener

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

Overrides Widget.setEventListener

-

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

-

Parameters

-

-T - widget type

-

-block - event handler

-

Return
-

current widget

- - -

Example:

- - -
    button.setEventListener<Button> {
-        dblclick = {
-            Alert.show("Button double clicked!")
-            // self is of type Button here
-        }
-    }

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

Overrides Widget.setEventListener

-

Sets an event listener for current widget.

-

Parameters

-

-block - event handler

-

Return
-

current widget

- - -

Example:

- - -
    button.setEventListener {
-        dblclick = {
-            Alert.show("Button double clicked!")
-            // self is of type Widget here
-        }
-    }

- - diff --git a/api/pl.treksoft.kvision.form.time/-date-time/show-meridian.html b/api/pl.treksoft.kvision.form.time/-date-time/show-meridian.html deleted file mode 100644 index 790fc0e3..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time/show-meridian.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -DateTime.showMeridian - kvision - - - -kvision / pl.treksoft.kvision.form.time /