kvision / pl.treksoft.kvision.form.time / DateTime

DateTime

open class DateTime : SimplePanel, KDateFormControl

Form field date/time chooser component.

Constructors

<init>

DateTime(value: KDate? = 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: KDate?

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(): KDate?

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: KDate? = 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.