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/index.html | 597 +++++++++++++++++++++ 1 file changed, 597 insertions(+) create mode 100644 api/kvision/pl.treksoft.kvision.form.time/-date-time-input/index.html (limited to 'api/kvision/pl.treksoft.kvision.form.time/-date-time-input/index.html') 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: (DragEvent) -> Unit): Unit` +`open fun setDropTarget(formats: Set<String>? = null, callback: (DragEvent) -> Unit): Unit` + Sets the current widget as a D&D drop target. +
+ setDropTargetData +	+`open fun setDropTargetData(format: String, callback: (String?) -> Unit): Unit` + Sets the current widget as a D&D drop target with helper callback accepting String data. +
+ 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. +
+ show +	+`open fun show(): Widget` + Makes current widget visible. +
+ toggleVisible +	+`open fun toggleVisible(): Widget` + Toggles visibility of current widget. +
+ translate +	+`fun translate(text: String?): String?`

Companion Object Functions

+ + + + + + + +

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.

+ + -- cgit