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-input/-init-.html | 23 + .../-date-time-input/after-destroy.html | 16 + .../-date-time-input/after-insert.html | 16 + .../-date-time-input/autofocus.html | 21 + .../-date-time-input/blur.html | 15 + .../-date-time-input/change-value.html | 14 + .../-date-time-input/clear-btn.html | 21 + .../-date-time-input/date-time-input.html | 16 + .../-date-time-input/days-of-week-disabled.html | 21 + .../-date-time-input/disabled.html | 22 + .../-date-time-input/focus.html | 15 + .../-date-time-input/format.html | 21 + .../-date-time-input/get-sn-attrs.html | 18 + .../-date-time-input/get-sn-class.html | 18 + .../-date-time-input/get-value-as-string.html | 17 + .../-date-time-input/hide-popup.html | 15 + .../-date-time-input/index.html | 597 +++++++++++++++++++++ .../-date-time-input/minute-step.html | 21 + .../-date-time-input/name.html | 22 + .../-date-time-input/placeholder.html | 21 + .../-date-time-input/readonly.html | 21 + .../-date-time-input/refresh-date-picker.html | 14 + .../-date-time-input/refresh-state.html | 14 + .../-date-time-input/render.html | 18 + .../-date-time-input/show-meridian.html | 21 + .../-date-time-input/show-popup.html | 15 + .../-date-time-input/size.html | 22 + .../-date-time-input/today-btn.html | 21 + .../-date-time-input/today-highlight.html | 21 + .../-date-time-input/value.html | 21 + .../-date-time-input/week-start.html | 21 + 31 files changed, 1159 insertions(+) create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/-init-.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/after-destroy.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/after-insert.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/autofocus.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/blur.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/change-value.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/clear-btn.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/date-time-input.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/days-of-week-disabled.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/disabled.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/focus.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/format.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/get-sn-attrs.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/get-sn-class.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/get-value-as-string.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/hide-popup.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/index.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/minute-step.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/name.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/placeholder.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/readonly.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/refresh-date-picker.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/refresh-state.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/render.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/show-meridian.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/show-popup.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/size.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/today-btn.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/today-highlight.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/value.html create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/week-start.html (limited to 'api/kvision/pl.treksoft.kvision.form.time/-date-time-input') diff --git a/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/-init-.html b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/-init-.html new file mode 100644 index 00000000..49547cce --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/-init-.html @@ -0,0 +1,23 @@ + + + +DateTimeInput.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTimeInput / <init>
+
+

<init>

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

Parameters

+

+value - date/time input value

+

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

+

+classes - a set of CSS class names

+

Constructor
+

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/after-destroy.html b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/after-destroy.html new file mode 100644 index 00000000..36547ae2 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/after-destroy.html @@ -0,0 +1,16 @@ + + + +DateTimeInput.afterDestroy - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTimeInput / afterDestroy
+
+

afterDestroy

+ +protected open fun afterDestroy(): Unit +

Overrides Widget.afterDestroy

+

Method called after destroying Snabbdom vnode.

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/after-insert.html b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/after-insert.html new file mode 100644 index 00000000..6cbf8093 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/after-insert.html @@ -0,0 +1,16 @@ + + + +DateTimeInput.afterInsert - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTimeInput / afterInsert
+
+

afterInsert

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

Overrides Widget.afterInsert

+

Method called after inserting Snabbdom vnode into the DOM.

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/autofocus.html b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/autofocus.html new file mode 100644 index 00000000..bbdaa979 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/autofocus.html @@ -0,0 +1,21 @@ + + + +DateTimeInput.autofocus - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTimeInput / autofocus
+
+

autofocus

+ +var autofocus: Boolean? +

Determines if the text input is automatically focused.

+

Getter
+

Determines if the text input is automatically focused.

+

+

Setter
+

Determines if the text input is automatically focused.

+

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/blur.html b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/blur.html new file mode 100644 index 00000000..98968f48 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/blur.html @@ -0,0 +1,15 @@ + + + +DateTimeInput.blur - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTimeInput / blur
+
+

blur

+ +open fun blur(): Unit +

Makes the input element blur.

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/change-value.html b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/change-value.html new file mode 100644 index 00000000..bbaa5718 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/change-value.html @@ -0,0 +1,14 @@ + + + +DateTimeInput.changeValue - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTimeInput / changeValue
+
+

changeValue

+ +protected open fun changeValue(): Unit + + diff --git a/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/clear-btn.html b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/clear-btn.html new file mode 100644 index 00000000..9caedf09 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/clear-btn.html @@ -0,0 +1,21 @@ + + + +DateTimeInput.clearBtn - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTimeInput / clearBtn
+
+

clearBtn

+ +var clearBtn: Boolean +

Determines if Clear button should be visible.

+

Getter
+

Determines if Clear button should be visible.

+

+

Setter
+

Determines if Clear button should be visible.

+

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/date-time-input.html b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/date-time-input.html new file mode 100644 index 00000000..40a1ab19 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/date-time-input.html @@ -0,0 +1,16 @@ + + + +DateTimeInput.dateTimeInput - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTimeInput / dateTimeInput
+
+

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.

+

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

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/days-of-week-disabled.html b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/days-of-week-disabled.html new file mode 100644 index 00000000..a2eb611d --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/days-of-week-disabled.html @@ -0,0 +1,21 @@ + + + +DateTimeInput.daysOfWeekDisabled - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTimeInput / daysOfWeekDisabled
+
+

daysOfWeekDisabled

+ +var daysOfWeekDisabled: Array<Int> +

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

+

Getter
+

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

+

+

Setter
+

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

+

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/disabled.html b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/disabled.html new file mode 100644 index 00000000..fccaea04 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/disabled.html @@ -0,0 +1,22 @@ + + + +DateTimeInput.disabled - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTimeInput / disabled
+
+

disabled

+ +open var disabled: Boolean +

Overrides FormInput.disabled

+

Determines if the field is disabled.

+

Getter
+

Determines if the field is disabled.

+

+

Setter
+

Determines if the field is disabled.

+

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/focus.html b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/focus.html new file mode 100644 index 00000000..6397a6ab --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/focus.html @@ -0,0 +1,15 @@ + + + +DateTimeInput.focus - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTimeInput / focus
+
+

focus

+ +open fun focus(): Unit +

Makes the input element focused.

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/format.html b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/format.html new file mode 100644 index 00000000..abe86341 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/format.html @@ -0,0 +1,21 @@ + + + +DateTimeInput.format - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTimeInput / format
+
+

format

+ +var format: String +

Date/time format.

+

Getter
+

Date/time format.

+

+

Setter
+

Date/time format.

+

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/get-sn-attrs.html b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/get-sn-attrs.html new file mode 100644 index 00000000..cb36049b --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/get-sn-attrs.html @@ -0,0 +1,18 @@ + + + +DateTimeInput.getSnAttrs - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTimeInput / getSnAttrs
+
+

getSnAttrs

+ +protected open fun getSnAttrs(): List<StringPair> +

Overrides Widget.getSnAttrs

+

Returns list of element attributes in the form of a List.

+

Return
+list of element attributes

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/get-sn-class.html b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/get-sn-class.html new file mode 100644 index 00000000..05b1667d --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/get-sn-class.html @@ -0,0 +1,18 @@ + + + +DateTimeInput.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTimeInput / 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/kvision/pl.treksoft.kvision.form.time/-date-time-input/get-value-as-string.html b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/get-value-as-string.html new file mode 100644 index 00000000..ccb47de8 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/get-value-as-string.html @@ -0,0 +1,17 @@ + + + +DateTimeInput.getValueAsString - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTimeInput / getValueAsString
+
+

getValueAsString

+ +fun getValueAsString(): String? +

Get value of date/time input control as String

+

Return
+value as a String

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/hide-popup.html b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/hide-popup.html new file mode 100644 index 00000000..0f885ccc --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/hide-popup.html @@ -0,0 +1,15 @@ + + + +DateTimeInput.hidePopup - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTimeInput / hidePopup
+
+

hidePopup

+ +open fun hidePopup(): Unit +

Hides date/time chooser popup.

+ + diff --git a/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/index.html b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/index.html new file mode 100644 index 00000000..926e5ec6 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.form.time/-date-time-input/index.html @@ -0,0 +1,597 @@ + + + +DateTimeInput - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTimeInput
+
+

DateTimeInput

+open class DateTimeInput : Widget, FormInput +

Basic date/time chooser component.

+

Constructors

+ + + + + + + +
+

<init>

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

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

autofocus

+		 +var autofocus: Boolean? +

Determines if the text 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.

+
+

disabled

+		 +open var disabled: Boolean +

Determines if the field is disabled.

+
+

format

+		 +var format: String +

Date/time format.

+
+

minuteStep

+		 +var minuteStep: Int +

The increment used to build the hour view.

+
+

name

+		 +open var name: String? +

The name attribute of the generated HTML input element.

+
+

placeholder

+		 +var placeholder: String? +

The placeholder for the date/time input.

+
+

readonly

+		 +var readonly: Boolean? +

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

+
+

showMeridian

+		 +var showMeridian: Boolean +

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

+
+

size

+		 +open var size: InputSize? +

The size of the input.

+
+

todayBtn

+		 +var todayBtn: Boolean +

Determines if Today button should be visible.

+
+

todayHighlight

+		 +var todayHighlight: Boolean +

Determines if the current day should be highlighted.

+
+

value

+		 +var value: Date? +

Date/time input value.

+
+

weekStart

+		 +var weekStart: Int +

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

+
+

Inherited Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

draggable

+		 +var draggable: Boolean? +

Determines if the current widget is draggable.

+
+

eventTarget

+		 +var eventTarget: Widget?
+

id

+		 +var id: String? +

An ID attribute of generated HTML element.

+
+

lastLanguage

+		 +var lastLanguage: String?
+

parent

+		 +open var parent: Container? +

Parent of the current component.

+
+

role

+		 +var role: String? +

A role attribute of generated HTML element.

+
+

surroundingSpan

+		 +var surroundingSpan: Boolean
+

title

+		 +var title: String? +

A title attribute of generated HTML element.

+
+

visible

+		 +open var visible: Boolean +

Visibility state of the current component.

+
+

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

afterDestroy

+		 +open fun afterDestroy(): Unit +

Method called after destroying Snabbdom vnode.

+
+

afterInsert

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

Method called after inserting Snabbdom vnode into the DOM.

+
+

blur

+		 +open fun blur(): Unit +

Makes the input element blur.

+
+

changeValue

+		 +open fun changeValue(): Unit
+

focus

+		 +open fun focus(): Unit +

Makes the input element focused.

+
+

getSnAttrs

+		 +open fun getSnAttrs(): List<StringPair> +

Returns list of element attributes in the form of a List.

+
+

getSnClass

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

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

+
+

getValueAsString

+		 +fun getValueAsString(): String? +

Get value of date/time input control as String

+
+

hidePopup

+		 +open fun hidePopup(): Unit +

Hides date/time chooser popup.

+
+

refreshDatePicker

+		 +open fun refreshDatePicker(): Unit
+

refreshState

+		 +open fun refreshState(): Unit
+

render

+		 +open fun render(): VNode +

Renders current component as a Snabbdom vnode.

+
+

showPopup

+		 +open fun showPopup(): Unit +

Open date/time chooser popup.

+
+

Inherited Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

addCssClass

+		 +open fun addCssClass(css: String): Widget +

Adds given value to the set of CSS classes generated in html code of current component.

+
+

addSurroundingCssClass

+		 +open fun addSurroundingCssClass(css: String): Widget +

Adds given value to the set of CSS classes generated in html code of parent component.

+
+

afterCreate

+		 +open fun afterCreate(node: VNode): Unit +

Method called after creating Snabbdom vnode.

+
+

afterPostpatch

+		 +open fun afterPostpatch(node: VNode): Unit +

Method called after updating Snabbdom vnode.

+
+

clearDragDropData

+		 +open fun clearDragDropData(): Unit +

Clears D&D data for the current widget. It also makes it not draggable.

+
+

dispatchEvent

+		 +open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?
+

getElement

+		 +open fun getElement(): Node? +

Returns DOM element bound to the current component.

+
+

getElementJQuery

+		 +open fun getElementJQuery(): JQuery? +

Returns JQuery element bound to the current component.

+
+

getElementJQueryD

+		 +open fun getElementJQueryD(): dynamic +

Returns JQuery element bound to the current component as a dynamic type.

+
+

getSnHooks

+		 +open fun getSnHooks(): Hooks? +

Returns list of hooks in the form of a Snabbdom Hooks object.

+
+

getSnOn

+		 +open fun getSnOn(): On? +

Returns list of event handlers in the form of a Snabbdom On object.

+
+

hide

+		 +open fun hide(): Widget +

Makes current widget invisible.

+
+

removeCssClass

+		 +open fun removeCssClass(css: String): Widget +

Removes given value from the set of CSS classes generated in html code of current component.

+
+

removeEventListeners

+		 +open fun removeEventListeners(): Widget +

Removes all event listeners from current widget.

+
+

removeSurroundingCssClass

+		 +open fun removeSurroundingCssClass(css: String): Widget +

Removes given value from the set of CSS classes generated in html code of parent component.

+
+

render

+		 +open fun render(elementName: String): VNode
+open fun render(elementName: String, children: Array<dynamic>): VNode +

Renders current component as a Snabbdom vnode.

+
+

setContextMenu

+		 +open fun setContextMenu(contextMenu: ContextMenu): Widget +

Sets context menu for the current widget.

+
+

setDragDropData

+		 +open fun setDragDropData(format: String, data: String): Unit +

Sets D&D data for the current widget. It also makes it draggable.

+
+

setDropTarget

+		 +open fun setDropTarget(format: String, callback: (