From a70acf853de62d0754ca95aa4103712b82afdef8 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Wed, 17 Oct 2018 18:40:15 +0200 Subject: API Documentation for KVision 0.0.18 --- .../-date-form-control/get-value-as-string.html | 16 ++ .../-date-form-control/get-value.html | 18 +++ .../-date-form-control/index.html | 165 +++++++++++++++++++++ .../-date-form-control/set-value.html | 19 +++ .../-date-form-control/value.html | 15 ++ .../-form-control/index.html | 4 +- api/pl.treksoft.kvision.form/-form-panel/add.html | 6 +- .../-form-panel/get-content.html | 22 --- .../-form-panel/index.html | 13 +- api/pl.treksoft.kvision.form/-form/add.html | 6 +- .../-form/get-content.html | 22 --- api/pl.treksoft.kvision.form/-form/index.html | 13 +- .../-k-date-form-control/get-value-as-string.html | 16 -- .../-k-date-form-control/get-value.html | 18 --- .../-k-date-form-control/index.html | 165 --------------------- .../-k-date-form-control/set-value.html | 19 --- .../-k-date-form-control/value.html | 15 -- .../-k-files-form-control/get-value.html | 2 +- .../-k-files-form-control/index.html | 4 +- .../-k-files-form-control/value.html | 2 +- api/pl.treksoft.kvision.form/index.html | 18 +-- 21 files changed, 258 insertions(+), 320 deletions(-) create mode 100644 api/pl.treksoft.kvision.form/-date-form-control/get-value-as-string.html create mode 100644 api/pl.treksoft.kvision.form/-date-form-control/get-value.html create mode 100644 api/pl.treksoft.kvision.form/-date-form-control/index.html create mode 100644 api/pl.treksoft.kvision.form/-date-form-control/set-value.html create mode 100644 api/pl.treksoft.kvision.form/-date-form-control/value.html delete mode 100644 api/pl.treksoft.kvision.form/-form-panel/get-content.html delete mode 100644 api/pl.treksoft.kvision.form/-form/get-content.html delete mode 100644 api/pl.treksoft.kvision.form/-k-date-form-control/get-value-as-string.html delete mode 100644 api/pl.treksoft.kvision.form/-k-date-form-control/get-value.html delete mode 100644 api/pl.treksoft.kvision.form/-k-date-form-control/index.html delete mode 100644 api/pl.treksoft.kvision.form/-k-date-form-control/set-value.html delete mode 100644 api/pl.treksoft.kvision.form/-k-date-form-control/value.html (limited to 'api/pl.treksoft.kvision.form') diff --git a/api/pl.treksoft.kvision.form/-date-form-control/get-value-as-string.html b/api/pl.treksoft.kvision.form/-date-form-control/get-value-as-string.html new file mode 100644 index 00000000..8ec76a28 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-date-form-control/get-value-as-string.html @@ -0,0 +1,16 @@ + + + +DateFormControl.getValueAsString - kvision + + + +kvision / pl.treksoft.kvision.form / DateFormControl / getValueAsString
+
+

getValueAsString

+ +open fun getValueAsString(): String? +

Overrides FormControl.getValueAsString

Returns the value of the control as a String.

+ + diff --git a/api/pl.treksoft.kvision.form/-date-form-control/get-value.html b/api/pl.treksoft.kvision.form/-date-form-control/get-value.html new file mode 100644 index 00000000..9f2ce3e6 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-date-form-control/get-value.html @@ -0,0 +1,18 @@ + + + +DateFormControl.getValue - kvision + + + +kvision / pl.treksoft.kvision.form / DateFormControl / getValue
+
+

getValue

+ +open fun getValue(): Date? +

Overrides FormControl.getValue

Returns the value of the control.

Return
+the value

+ + diff --git a/api/pl.treksoft.kvision.form/-date-form-control/index.html b/api/pl.treksoft.kvision.form/-date-form-control/index.html new file mode 100644 index 00000000..50ea07c0 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-date-form-control/index.html @@ -0,0 +1,165 @@ + + + +DateFormControl - kvision + + + +kvision / pl.treksoft.kvision.form / DateFormControl
+
+

DateFormControl

+interface DateFormControl : FormControl +

Base interface of a form control with a date value.

Properties

+ + + + + + + +

value

+abstract var value: Date? +

Date value.

Inherited Properties

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

+ disabled +	+`open var disabled: Boolean` + Determines if the field is disabled. +
+ flabel +	+`abstract val flabel: FieldLabel` + Form field label. +
+ input +	+`abstract val input: FormInput` + The actual input component. +
+ name +	+`open var name: String?` + The name attribute of the generated HTML input element. +
+ size +	+`open var size: InputSize?` + Input control field size. +
+ validationInfo +	+`abstract val validationInfo: HelpBlock` + Validation info component. +
+ validatorError +	+`open var validatorError: String?` + Validator error message. +

Functions

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

+ getValue +	+`open fun getValue(): Date?` + Returns the value of the control. +
+ getValueAsString +	+`open fun getValueAsString(): String?` + Returns the value of the control as a String. +
+ setValue +	+`open fun setValue(v: Any?): Unit` + Sets the value of the control. +

Inherited Functions

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

+ blur +	+`abstract fun blur(): Unit` + Makes the input element blur. +
+ focus +	+`abstract fun focus(): Unit` + Makes the input element focused. +

Inheritors

+ + + + + + + +

DateTime

+open class DateTime : SimplePanel, DateFormControl +

Form field date/time chooser component.

+ + diff --git a/api/pl.treksoft.kvision.form/-date-form-control/set-value.html b/api/pl.treksoft.kvision.form/-date-form-control/set-value.html new file mode 100644 index 00000000..7dd2477e --- /dev/null +++ b/api/pl.treksoft.kvision.form/-date-form-control/set-value.html @@ -0,0 +1,19 @@ + + + +DateFormControl.setValue - kvision + + + +kvision / pl.treksoft.kvision.form / DateFormControl / setValue
+
+

setValue

+ +open fun setValue(v: Any?): Unit +

Overrides FormControl.setValue

Sets the value of the control.

Parameters

+v - the value

+ + diff --git a/api/pl.treksoft.kvision.form/-date-form-control/value.html b/api/pl.treksoft.kvision.form/-date-form-control/value.html new file mode 100644 index 00000000..0d6d2079 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-date-form-control/value.html @@ -0,0 +1,15 @@ + + + +DateFormControl.value - kvision + + + +kvision / pl.treksoft.kvision.form / DateFormControl / value
+
+

value

+ +abstract var value: Date? +

Date value.

+ + diff --git a/api/pl.treksoft.kvision.form/-form-control/index.html b/api/pl.treksoft.kvision.form/-form-control/index.html index 2881e185..4c36da49 100644 --- a/api/pl.treksoft.kvision.form/-form-control/index.html +++ b/api/pl.treksoft.kvision.form/-form-control/index.html @@ -233,10 +233,10 @@ -

KDateFormControl

DateFormControl

-interface KDateFormControl : FormControl +interface DateFormControl : FormControl

Base interface of a form control with a date value.

diff --git a/api/pl.treksoft.kvision.form/-form-panel/add.html b/api/pl.treksoft.kvision.form/-form-panel/add.html index 55663b95..49c88d13 100644 --- a/api/pl.treksoft.kvision.form/-form-panel/add.html +++ b/api/pl.treksoft.kvision.form/-form-panel/add.html @@ -62,8 +62,8 @@ current form panel

validator - optional validation function

Return
current form panel

- -

open fun <C : KDateFormControl> add(key: KProperty1<K, KDate?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): FormPanel<K>

+ +

open fun <C : DateFormControl> add(key: KProperty1<K, Date?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): FormPanel<K>

Adds a date control to the form panel.

Parameters

@@ -81,7 +81,7 @@ current form panel

Return
current form panel

open fun <C : KFilesFormControl> add(key: KProperty1<K, List<KFile>?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): FormPanel<K>

open fun <C : KFilesFormControl> add(key: KProperty1<K, List<KFile>?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): FormPanel<K>

Adds a files control to the form panel.

Parameters

diff --git a/api/pl.treksoft.kvision.form/-form-panel/get-content.html b/api/pl.treksoft.kvision.form/-form-panel/get-content.html deleted file mode 100644 index 6e97ae04..00000000 --- a/api/pl.treksoft.kvision.form/-form-panel/get-content.html +++ /dev/null @@ -1,22 +0,0 @@ - - - -FormPanel.getContent - kvision - - - -kvision / pl.treksoft.kvision.form / FormPanel / getContent
-
-

getContent

- -suspend fun getContent(key: KProperty1<K, List<KFile>?>, kFile: KFile): KFile -

Returns an object with the content of the file.

Parameters

-key - key identifier of the control

-kFile - object identifying the file

Return
-KFile object

- - diff --git a/api/pl.treksoft.kvision.form/-form-panel/index.html b/api/pl.treksoft.kvision.form/-form-panel/index.html index 655893e4..03973484 100644 --- a/api/pl.treksoft.kvision.form/-form-panel/index.html +++ b/api/pl.treksoft.kvision.form/-form-panel/index.html @@ -122,9 +122,9 @@

Adds a boolean control to the form panel.

open fun <C : NumberFormControl> add(key: KProperty1<K, Number?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): FormPanel<K>

Adds a number control to the form panel.

open fun <C : KDateFormControl> add(key: KProperty1<K, KDate?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): FormPanel<K>

open fun <C : DateFormControl> add(key: KProperty1<K, Date?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): FormPanel<K>

Adds a date control to the form panel.

open fun <C : KFilesFormControl> add(key: KProperty1<K, List<KFile>?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): FormPanel<K>

open fun <C : KFilesFormControl> add(key: KProperty1<K, List<KFile>?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): FormPanel<K>

Adds a files control to the form panel.

@@ -155,15 +155,6 @@ -

getContent

- - -suspend fun getContent(key: KProperty1<K, List<KFile>?>, kFile: KFile): KFile -

Returns an object with the content of the file.

- - - -

getControl

diff --git a/api/pl.treksoft.kvision.form/-form/add.html b/api/pl.treksoft.kvision.form/-form/add.html index 54194e62..d1322272 100644 --- a/api/pl.treksoft.kvision.form/-form/add.html +++ b/api/pl.treksoft.kvision.form/-form/add.html @@ -62,8 +62,8 @@ current form

validator - optional validation function

Return
current form

- -

fun <C : KDateFormControl> add(key: KProperty1<K, KDate?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): Form<K>

+ +

fun <C : DateFormControl> add(key: KProperty1<K, Date?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): Form<K>

Adds a date control to the form.

Parameters

@@ -81,7 +81,7 @@ current form

Return
current form

fun <C : KFilesFormControl> add(key: KProperty1<K, List<KFile>?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): Form<K>

fun <C : KFilesFormControl> add(key: KProperty1<K, List<KFile>?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): Form<K>

Adds a files control to the form.

Parameters

diff --git a/api/pl.treksoft.kvision.form/-form/get-content.html b/api/pl.treksoft.kvision.form/-form/get-content.html deleted file mode 100644 index 90b6feeb..00000000 --- a/api/pl.treksoft.kvision.form/-form/get-content.html +++ /dev/null @@ -1,22 +0,0 @@ - - - -Form.getContent - kvision - - - -kvision / pl.treksoft.kvision.form / Form / getContent
-
-

getContent

- -suspend fun getContent(key: KProperty1<K, List<KFile>?>, kFile: KFile): KFile -

Returns file with the content read.

Parameters

-key - key identifier of the control

-kFile - object identifying the file

Return
-KFile object

- - diff --git a/api/pl.treksoft.kvision.form/-form/index.html b/api/pl.treksoft.kvision.form/-form/index.html index 3de71e84..693f2c30 100644 --- a/api/pl.treksoft.kvision.form/-form/index.html +++ b/api/pl.treksoft.kvision.form/-form/index.html @@ -38,9 +38,9 @@

Adds a boolean control to the form.

fun <C : NumberFormControl> add(key: KProperty1<K, Number?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): Form<K>

Adds a number control to the form.

fun <C : KDateFormControl> add(key: KProperty1<K, KDate?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): Form<K>

fun <C : DateFormControl> add(key: KProperty1<K, Date?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): Form<K>

Adds a date control to the form.

fun <C : KFilesFormControl> add(key: KProperty1<K, List<KFile>?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): Form<K>

fun <C : KFilesFormControl> add(key: KProperty1<K, List<KFile>?>, control: C, required: Boolean = false, requiredMessage: String? = null, validatorMessage: (C) -> String? = null, validator: (C) -> Boolean? = null): Form<K>

Adds a files control to the form.

@@ -64,15 +64,6 @@ -

getContent

- - -suspend fun getContent(key: KProperty1<K, List<KFile>?>, kFile: KFile): KFile -

Returns file with the content read.

- - - -

getControl

diff --git a/api/pl.treksoft.kvision.form/-k-date-form-control/get-value-as-string.html b/api/pl.treksoft.kvision.form/-k-date-form-control/get-value-as-string.html deleted file mode 100644 index 677bcda1..00000000 --- a/api/pl.treksoft.kvision.form/-k-date-form-control/get-value-as-string.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -KDateFormControl.getValueAsString - kvision - - - -kvision / pl.treksoft.kvision.form / KDateFormControl / getValueAsString
-
-

getValueAsString

- -open fun getValueAsString(): String? -

Overrides FormControl.getValueAsString

Returns the value of the control as a String.

- - diff --git a/api/pl.treksoft.kvision.form/-k-date-form-control/get-value.html b/api/pl.treksoft.kvision.form/-k-date-form-control/get-value.html deleted file mode 100644 index 80fe5c8b..00000000 --- a/api/pl.treksoft.kvision.form/-k-date-form-control/get-value.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -KDateFormControl.getValue - kvision - - - -kvision / pl.treksoft.kvision.form / KDateFormControl / getValue
-
-

getValue

- -open fun getValue(): KDate? -

Overrides FormControl.getValue

Returns the value of the control.

Return
-the value

- - diff --git a/api/pl.treksoft.kvision.form/-k-date-form-control/index.html b/api/pl.treksoft.kvision.form/-k-date-form-control/index.html deleted file mode 100644 index a14754e7..00000000 --- a/api/pl.treksoft.kvision.form/-k-date-form-control/index.html +++ /dev/null @@ -1,165 +0,0 @@ - - - -KDateFormControl - kvision - - - -kvision / pl.treksoft.kvision.form / KDateFormControl
-
-

KDateFormControl

-interface KDateFormControl : FormControl -

Base interface of a form control with a date value.

Properties

- - - - - - - -

value

-abstract var value: KDate? -

Date value.

Inherited Properties

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

- disabled -	-`open var disabled: Boolean` - Determines if the field is disabled. -
- flabel -	-`abstract val flabel: FieldLabel` - Form field label. -
- input -	-`abstract val input: FormInput` - The actual input component. -
- name -	-`open var name: String?` - The name attribute of the generated HTML input element. -
- size -	-`open var size: InputSize?` - Input control field size. -
- validationInfo -	-`abstract val validationInfo: HelpBlock` - Validation info component. -
- validatorError -	-`open var validatorError: String?` - Validator error message. -

Functions

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

- getValue -	-`open fun getValue(): KDate?` - Returns the value of the control. -
- getValueAsString -	-`open fun getValueAsString(): String?` - Returns the value of the control as a String. -
- setValue -	-`open fun setValue(v: Any?): Unit` - Sets the value of the control. -

Inherited Functions

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

- blur -	-`abstract fun blur(): Unit` - Makes the input element blur. -
- focus -	-`abstract fun focus(): Unit` - Makes the input element focused. -

Inheritors

- - - - - - - -

DateTime

-open class DateTime : SimplePanel, KDateFormControl -

Form field date/time chooser component.

- - diff --git a/api/pl.treksoft.kvision.form/-k-date-form-control/set-value.html b/api/pl.treksoft.kvision.form/-k-date-form-control/set-value.html deleted file mode 100644 index 3e102567..00000000 --- a/api/pl.treksoft.kvision.form/-k-date-form-control/set-value.html +++ /dev/null @@ -1,19 +0,0 @@ - - - -KDateFormControl.setValue - kvision - - - -kvision / pl.treksoft.kvision.form / KDateFormControl / setValue
-
-

setValue

- -open fun setValue(v: Any?): Unit -

Overrides FormControl.setValue

Sets the value of the control.

Parameters

-v - the value

- - diff --git a/api/pl.treksoft.kvision.form/-k-date-form-control/value.html b/api/pl.treksoft.kvision.form/-k-date-form-control/value.html deleted file mode 100644 index 252a1296..00000000 --- a/api/pl.treksoft.kvision.form/-k-date-form-control/value.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -KDateFormControl.value - kvision - - - -kvision / pl.treksoft.kvision.form / KDateFormControl / value
-
-

value

- -abstract var value: KDate? -

Date value.

- - diff --git a/api/pl.treksoft.kvision.form/-k-files-form-control/get-value.html b/api/pl.treksoft.kvision.form/-k-files-form-control/get-value.html index 83d54534..cfc28f64 100644 --- a/api/pl.treksoft.kvision.form/-k-files-form-control/get-value.html +++ b/api/pl.treksoft.kvision.form/-k-files-form-control/get-value.html @@ -9,7 +9,7 @@

getValue

-open fun getValue(): List<KFile>? +open fun getValue(): List<KFile>?

Overrides FormControl.getValue

Returns the value of the control.

Return
diff --git a/api/pl.treksoft.kvision.form/-k-files-form-control/index.html b/api/pl.treksoft.kvision.form/-k-files-form-control/index.html index 410e07c5..056d1394 100644 --- a/api/pl.treksoft.kvision.form/-k-files-form-control/index.html +++ b/api/pl.treksoft.kvision.form/-k-files-form-control/index.html @@ -18,7 +18,7 @@

value

-abstract var value: List<KFile>? +abstract var value: List<KFile>?

List of files value.

@@ -100,7 +100,7 @@

getValue

-open fun getValue(): List<KFile>? +open fun getValue(): List<KFile>?

Returns the value of the control.

diff --git a/api/pl.treksoft.kvision.form/-k-files-form-control/value.html b/api/pl.treksoft.kvision.form/-k-files-form-control/value.html index 4b62a422..0692906c 100644 --- a/api/pl.treksoft.kvision.form/-k-files-form-control/value.html +++ b/api/pl.treksoft.kvision.form/-k-files-form-control/value.html @@ -9,7 +9,7 @@

value

-abstract var value: List<KFile>? +abstract var value: List<KFile>?

List of files value.

diff --git a/api/pl.treksoft.kvision.form/index.html b/api/pl.treksoft.kvision.form/index.html index a63807cd..67028c16 100644 --- a/api/pl.treksoft.kvision.form/index.html +++ b/api/pl.treksoft.kvision.form/index.html @@ -24,6 +24,15 @@ validation.

DateFormControl

+ + +interface DateFormControl : FormControl +

Base interface of a form control with a date value.

+ + + +

FieldLabel

@@ -121,15 +130,6 @@ validation.

KDateFormControl

- - -interface KDateFormControl : FormControl -

Base interface of a form control with a date value.

- - - -

KFilesFormControl

-- cgit