From fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 26 Oct 2019 00:17:24 +0200 Subject: API documentation for KVision 2.0.0 --- .../-date-time-input/autofocus.html | 6 - .../-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/disabled-dates.html | 21 + .../-date-time-input/disabled.html | 6 - .../-date-time-input/enabled-dates.html | 21 + .../-date-time-input/get-sn-attrs.html | 18 - .../-date-time-input/ignore-readonly.html | 21 + .../-date-time-input/index.html | 884 +++++++++++++++------ .../-date-time-input/max-date.html | 21 + .../-date-time-input/min-date.html | 21 + .../-date-time-input/minute-step.html | 21 - .../-date-time-input/name.html | 6 - .../-date-time-input/placeholder.html | 6 - .../-date-time-input/readonly.html | 6 - .../-date-time-input/refresh-state.html | 14 - .../-date-time-input/render.html | 18 - .../-date-time-input/show-clear.html | 21 + .../-date-time-input/show-close.html | 21 + .../-date-time-input/show-meridian.html | 21 - .../-date-time-input/show-today-button.html | 21 + .../-date-time-input/side-by-side.html | 21 + .../-date-time-input/size.html | 6 - .../-date-time-input/stepping.html | 21 + .../-date-time-input/today-btn.html | 21 - .../-date-time-input/today-highlight.html | 21 - .../-date-time-input/toggle-popup.html | 15 + .../-date-time-input/validation-status.html | 16 + .../-date-time-input/value.html | 6 - .../-date-time-input/week-start.html | 21 - 31 files changed, 895 insertions(+), 478 deletions(-) delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/change-value.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/clear-btn.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/date-time-input.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/disabled-dates.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/enabled-dates.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/get-sn-attrs.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/ignore-readonly.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/max-date.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/min-date.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/minute-step.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/refresh-state.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/render.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/show-clear.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/show-close.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/show-meridian.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/show-today-button.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/side-by-side.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/stepping.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/today-btn.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/today-highlight.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/toggle-popup.html create mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/validation-status.html delete mode 100644 api/pl.treksoft.kvision.form.time/-date-time-input/week-start.html (limited to 'api/pl.treksoft.kvision.form.time/-date-time-input') 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 bbdaa979..db39e3d2 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 @@ -11,11 +11,5 @@ 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/pl.treksoft.kvision.form.time/-date-time-input/change-value.html b/api/pl.treksoft.kvision.form.time/-date-time-input/change-value.html deleted file mode 100644 index bbaa5718..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time-input/change-value.html +++ /dev/null @@ -1,14 +0,0 @@ - - - -DateTimeInput.changeValue - kvision - - - -kvision / pl.treksoft.kvision.form.time / DateTimeInput / changeValue
-
-

changeValue

- -protected open fun changeValue(): Unit - - diff --git a/api/pl.treksoft.kvision.form.time/-date-time-input/clear-btn.html b/api/pl.treksoft.kvision.form.time/-date-time-input/clear-btn.html deleted file mode 100644 index 9caedf09..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time-input/clear-btn.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/pl.treksoft.kvision.form.time/-date-time-input/date-time-input.html b/api/pl.treksoft.kvision.form.time/-date-time-input/date-time-input.html deleted file mode 100644 index 284dec31..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time-input/date-time-input.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -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/pl.treksoft.kvision.form.time/-date-time-input/disabled-dates.html b/api/pl.treksoft.kvision.form.time/-date-time-input/disabled-dates.html new file mode 100644 index 00000000..85ea9c43 --- /dev/null +++ b/api/pl.treksoft.kvision.form.time/-date-time-input/disabled-dates.html @@ -0,0 +1,21 @@ + + + +DateTimeInput.disabledDates - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTimeInput / disabledDates
+
+

disabledDates

+ +var disabledDates: Array<Date> +

An array of disabled dates.

+

Getter
+

An array of disabled dates.

+

+

Setter
+

An array of disabled dates.

+

+ + 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 fccaea04..12c81e49 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 @@ -12,11 +12,5 @@ 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/pl.treksoft.kvision.form.time/-date-time-input/enabled-dates.html b/api/pl.treksoft.kvision.form.time/-date-time-input/enabled-dates.html new file mode 100644 index 00000000..c23a244c --- /dev/null +++ b/api/pl.treksoft.kvision.form.time/-date-time-input/enabled-dates.html @@ -0,0 +1,21 @@ + + + +DateTimeInput.enabledDates - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTimeInput / enabledDates
+
+

enabledDates

+ +var enabledDates: Array<Date> +

An array of enabled dates.

+

Getter
+

An array of enabled dates.

+

+

Setter
+

An array of enabled dates.

+

+ + diff --git a/api/pl.treksoft.kvision.form.time/-date-time-input/get-sn-attrs.html b/api/pl.treksoft.kvision.form.time/-date-time-input/get-sn-attrs.html deleted file mode 100644 index cb36049b..00000000 --- a/api/pl.treksoft.kvision.form.time/-date-time-input/get-sn-attrs.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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/pl.treksoft.kvision.form.time/-date-time-input/ignore-readonly.html b/api/pl.treksoft.kvision.form.time/-date-time-input/ignore-readonly.html new file mode 100644 index 00000000..56a5bdec --- /dev/null +++ b/api/pl.treksoft.kvision.form.time/-date-time-input/ignore-readonly.html @@ -0,0 +1,21 @@ + + + +DateTimeInput.ignoreReadonly - kvision + + + +kvision / pl.treksoft.kvision.form.time / DateTimeInput / ignoreReadonly
+
+

ignoreReadonly

+ +var ignoreReadonly: Boolean +

Allow date picker for readonly component.

+

Getter
+

Allow date picker for readonly component.

+

+

Setter
+

Allow date picker for readonly component.

+

+ + 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 c4690ad6..504d9f9a 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,7 +8,7 @@ kvision / pl.treksoft.kvision.form.time / DateTimeInput

DateTimeInput

-open class DateTimeInput : Widget, FormInput +open class DateTimeInput : SimplePanel, FormInput

Basic date/time chooser component.

Constructors

@@ -36,15 +36,6 @@ - - - - + + + + + + + + + + + + + + + + @@ -108,11 +135,38 @@ + + + + + + + + + + + + @@ -126,20 +180,20 @@ @@ -151,592 +205,962 @@

Date/time input value.

+ +
-

clearBtn

-		 -var clearBtn: Boolean -

Determines if Clear button should be visible.

-

daysOfWeekDisabled

 @@ -63,6 +54,24 @@
+

disabledDates

+		 +var disabledDates: Array<Date> +

An array of disabled dates.

+
+

enabledDates

+		 +var enabledDates: Array<Date> +

An array of enabled dates.

+

format

 @@ -72,11 +81,29 @@
-

minuteStep

+

ignoreReadonly

 -var minuteStep: Int -

The increment used to build the hour view.

+var ignoreReadonly: Boolean +

Allow date picker for readonly component.

+
+

maxDate

+		 +var maxDate: Date? +

Prevents date selection after this date.

+
+

minDate

+		 +var minDate: Date? +

Prevents date selection before this date.
-

showMeridian

+

showClear

+		 +var showClear: Boolean +

Determines if Clear button should be visible.

+
+

showClose

+		 +var showClose: Boolean +

Determines if Close button should be visible.

+
+

showTodayButton

 -var showMeridian: Boolean -

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

+var showTodayButton: Boolean +

Determines if Today button should be visible.

+
+

sideBySide

+		 +var sideBySide: Boolean +

Shows date and time pickers side by side.
-

todayBtn

+

stepping

 -var todayBtn: Boolean -

Determines if Today button should be visible.

+var stepping: Int +

The increment used to build the hour view.
-

todayHighlight

+

validationStatus

 -var todayHighlight: Boolean -

Determines if the current day should be highlighted.

+open var validationStatus: ValidationStatus? +

The validation status of the input.
+

Inherited Properties

+ + +val children: MutableList<Component>
-

weekStart

+

children

 -var weekStart: Int -

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

-
-

Inherited Properties

+

Functions

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

Method called after inserting Snabbdom vnode into the DOM.

+ +open fun focus(): Unit +

Makes the input element focused.

+ +fun getValueAsString(): String? +

Get value of date/time input control as String

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

Toggles date/time chooser popup.

+ + +
-

draggable

+

afterDestroy

 -var draggable: Boolean? -

Determines if the current widget is draggable.

+open fun afterDestroy(): Unit +

Method called after destroying Snabbdom vnode.
-

eventTarget

+

afterInsert

 -var eventTarget: Widget?
-

id

+

blur

 -var id: String? -

An ID attribute of generated HTML element.

+open fun blur(): Unit +

Makes the input element blur.
-

lastLanguage

+

focus

 -var lastLanguage: String?
-

parent

+

getSnClass

 -open var parent: Container? -

Parent of the current component.

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

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

popoverOptions

+

getValueAsString

 -var popoverOptions: PopoverOptions?
-

role

+

hidePopup

 -var role: String? -

A role attribute of generated HTML element.

+open fun hidePopup(): Unit +

Hides date/time chooser popup.
-

surroundingSpan

+

refreshDatePicker

 -var surroundingSpan: Boolean
-

title

+

showPopup

 -var title: String? -

A title attribute of generated HTML element.

+open fun showPopup(): Unit +

Open date/time chooser popup.
-

tooltipOptions

+

togglePopup

 -var tooltipOptions: TooltipOptions?
+

Inherited Functions

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

Adds a list of components to the current container.

+ + + + + + + + + + + + + + + + + + + + + + + + +
-

visible

+

add

 -open var visible: Boolean -

Visibility state of the current component.

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

Adds given component to the current container.
-

vnode

+

addAll

 -var vnode: VNode?
+

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.

+
-

Functions

+

Extension Functions

+ + + + + + + + + + + + +fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, classes: Set<String> = setOf(), init: (Button.() -> Unit)? = null): Button +

DSL builder extension function.

+
-

afterDestroy

+

addBsBgColor

 -open fun afterDestroy(): Unit -

Method called after destroying Snabbdom vnode.

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

addBsBorder

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

afterInsert

+

addBsClearfix

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

Method called after inserting Snabbdom vnode into the DOM.

+fun Component.addBsClearfix(): Unit
+

addBsColor

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

blur

+

addBsRounded

 -open fun blur(): Unit -

Makes the input element blur.

+fun Component.addBsRounded(vararg bsRounded: BsRounded): Unit
+

bold

+		 +fun Container.bold(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Bold.() -> Unit)? = null): Bold +

DSL builder extension function.
-

changeValue

+

button

 -open fun changeValue(): Unit
-

focus

+

buttonGroup

 -open fun focus(): Unit -

Makes the input element focused.

+fun Container.buttonGroup(size: ButtonGroupSize? = null, vertical: Boolean = false, classes: Set<String> = setOf(), init: (ButtonGroup.() -> Unit)? = null): ButtonGroup +

DSL builder extension function.
-

getSnAttrs

+

canvas

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

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

+fun Container.canvas(canvasWidth: Int? = null, canvasHeight: Int? = null, classes: Set<String> = setOf(), init: (Canvas.() -> Unit)