From d8cd67062b8de6e8398dc6dfd00d201200c82414 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Fri, 9 Feb 2018 13:40:35 +0100 Subject: API doc and readme --- .../-form-control/disabled.html | 15 ++ .../-form-control/flabel.html | 15 ++ .../-form-control/get-value-as-string.html | 15 ++ .../-form-control/get-value.html | 17 ++ .../-form-control/index.html | 237 +++++++++++++++++++++ .../-form-control/input.html | 15 ++ .../-form-control/set-value.html | 18 ++ .../-form-control/size.html | 15 ++ .../-form-control/validation-info.html | 15 ++ .../-form-control/validator-error.html | 15 ++ 10 files changed, 377 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.form/-form-control/disabled.html create mode 100644 docs/api/pl.treksoft.kvision.form/-form-control/flabel.html create mode 100644 docs/api/pl.treksoft.kvision.form/-form-control/get-value-as-string.html create mode 100644 docs/api/pl.treksoft.kvision.form/-form-control/get-value.html create mode 100644 docs/api/pl.treksoft.kvision.form/-form-control/index.html create mode 100644 docs/api/pl.treksoft.kvision.form/-form-control/input.html create mode 100644 docs/api/pl.treksoft.kvision.form/-form-control/set-value.html create mode 100644 docs/api/pl.treksoft.kvision.form/-form-control/size.html create mode 100644 docs/api/pl.treksoft.kvision.form/-form-control/validation-info.html create mode 100644 docs/api/pl.treksoft.kvision.form/-form-control/validator-error.html (limited to 'docs/api/pl.treksoft.kvision.form/-form-control') diff --git a/docs/api/pl.treksoft.kvision.form/-form-control/disabled.html b/docs/api/pl.treksoft.kvision.form/-form-control/disabled.html new file mode 100644 index 00000000..ac5dc5aa --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form/-form-control/disabled.html @@ -0,0 +1,15 @@ + + + +FormControl.disabled - kvision + + + +kvision / pl.treksoft.kvision.form / FormControl / disabled
+
+

disabled

+ +abstract var disabled: Boolean +

Determines if the field is disabled.

+ + diff --git a/docs/api/pl.treksoft.kvision.form/-form-control/flabel.html b/docs/api/pl.treksoft.kvision.form/-form-control/flabel.html new file mode 100644 index 00000000..51e4d46e --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form/-form-control/flabel.html @@ -0,0 +1,15 @@ + + + +FormControl.flabel - kvision + + + +kvision / pl.treksoft.kvision.form / FormControl / flabel
+
+

flabel

+ +abstract val flabel: FieldLabel +

Form field label.

+ + diff --git a/docs/api/pl.treksoft.kvision.form/-form-control/get-value-as-string.html b/docs/api/pl.treksoft.kvision.form/-form-control/get-value-as-string.html new file mode 100644 index 00000000..671320bf --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form/-form-control/get-value-as-string.html @@ -0,0 +1,15 @@ + + + +FormControl.getValueAsString - kvision + + + +kvision / pl.treksoft.kvision.form / FormControl / getValueAsString
+
+

getValueAsString

+ +abstract fun getValueAsString(): String? +

Returns the value of the control as a String.

+ + diff --git a/docs/api/pl.treksoft.kvision.form/-form-control/get-value.html b/docs/api/pl.treksoft.kvision.form/-form-control/get-value.html new file mode 100644 index 00000000..6ac2fc1e --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form/-form-control/get-value.html @@ -0,0 +1,17 @@ + + + +FormControl.getValue - kvision + + + +kvision / pl.treksoft.kvision.form / FormControl / getValue
+
+

getValue

+ +abstract fun getValue(): Any? +

Returns the value of the control.

Return
+the value

+ + diff --git a/docs/api/pl.treksoft.kvision.form/-form-control/index.html b/docs/api/pl.treksoft.kvision.form/-form-control/index.html new file mode 100644 index 00000000..f5e493f4 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form/-form-control/index.html @@ -0,0 +1,237 @@ + + + +FormControl - kvision + + + +kvision / pl.treksoft.kvision.form / FormControl
+
+

FormControl

+interface FormControl : Component +

Base interface of a form control.

Properties

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

+ disabled +	+`abstract var disabled: Boolean` + Determines if the field is disabled. +
+ flabel +	+`abstract val flabel: FieldLabel` + Form field label. +
+ input +	+`abstract val input: Component` + The actual input component. +
+ size +	+`abstract var size: INPUTSIZE?` + Input control size. +
+ validationInfo +	+`abstract val validationInfo: HelpBlock` + Validation info component. +
+ validatorError +	+`open var validatorError: String?` + Validator error message. +

Inherited Properties

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

+ parent +	+`abstract var parent: Component?` + Parent of the current component. +
+ visible +	+`abstract var visible: Boolean` + Visibility state of the current component. +

Functions

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

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

Inherited Functions

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

+ addCssClass +	+`abstract fun addCssClass(css: String): Component` + Adds given value to the set of CSS classes generated in html code of current component. +
+ addSurroundingCssClass +	+`abstract fun addSurroundingCssClass(css: String): Component` + Adds given value to the set of CSS classes generated in html code of parent component. +
+ getElement +	+`abstract fun getElement(): Node?` + Returns DOM element bound to the current component. +
+ getElementJQuery +	+`abstract fun getElementJQuery(): JQuery?` + Returns JQuery element bound to the current component. +
+ getElementJQueryD +	+`abstract fun getElementJQueryD(): dynamic` + Returns JQuery element bound to the current component as a dynamic type. +
+ removeCssClass +	+`abstract fun removeCssClass(css: String): Component` + Removes given value from the set of CSS classes generated in html code of current component. +
+ removeSurroundingCssClass +	+`abstract fun removeSurroundingCssClass(css: String): Component` + Removes given value from the set of CSS classes generated in html code of parent component. +

Inheritors

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

+ BoolFormControl +	+`interface BoolFormControl : FormControl` + Base interface of a form control with a boolean value. +
+ DateFormControl +	+`interface DateFormControl : FormControl` + Base interface of a form control with a date value. +
+ NumberFormControl +	+`interface NumberFormControl : FormControl` + Base interface of a form control with a numeric value. +
+ StringFormControl +	+`interface StringFormControl : FormControl` + Base interface of a form control with a text value. +

+ + diff --git a/docs/api/pl.treksoft.kvision.form/-form-control/input.html b/docs/api/pl.treksoft.kvision.form/-form-control/input.html new file mode 100644 index 00000000..6ed80ddd --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form/-form-control/input.html @@ -0,0 +1,15 @@ + + + +FormControl.input - kvision + + + +kvision / pl.treksoft.kvision.form / FormControl / input
+
+

input

+ +abstract val input: Component +

The actual input component.

+ + diff --git a/docs/api/pl.treksoft.kvision.form/-form-control/set-value.html b/docs/api/pl.treksoft.kvision.form/-form-control/set-value.html new file mode 100644 index 00000000..ab425936 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form/-form-control/set-value.html @@ -0,0 +1,18 @@ + + + +FormControl.setValue - kvision + + + +kvision / pl.treksoft.kvision.form / FormControl / setValue
+
+

setValue

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

Sets the value of the control.

Parameters

+v - the value

+ + diff --git a/docs/api/pl.treksoft.kvision.form/-form-control/size.html b/docs/api/pl.treksoft.kvision.form/-form-control/size.html new file mode 100644 index 00000000..cb844a2a --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form/-form-control/size.html @@ -0,0 +1,15 @@ + + + +FormControl.size - kvision + + + +kvision / pl.treksoft.kvision.form / FormControl / size
+
+

size

+ +abstract var size: INPUTSIZE? +

Input control size.

+ + diff --git a/docs/api/pl.treksoft.kvision.form/-form-control/validation-info.html b/docs/api/pl.treksoft.kvision.form/-form-control/validation-info.html new file mode 100644 index 00000000..e477d349 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form/-form-control/validation-info.html @@ -0,0 +1,15 @@ + + + +FormControl.validationInfo - kvision + + + +kvision / pl.treksoft.kvision.form / FormControl / validationInfo
+
+

validationInfo

+ +abstract val validationInfo: HelpBlock +

Validation info component.

+ + diff --git a/docs/api/pl.treksoft.kvision.form/-form-control/validator-error.html b/docs/api/pl.treksoft.kvision.form/-form-control/validator-error.html new file mode 100644 index 00000000..9af55095 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form/-form-control/validator-error.html @@ -0,0 +1,15 @@ + + + +FormControl.validatorError - kvision + + + +kvision / pl.treksoft.kvision.form / FormControl / validatorError
+
+

validatorError

+ +open var validatorError: String? +

Validator error message.

+ + -- cgit