From 806edfceeefe7fda47924f97237974e99fe28a02 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 2 Apr 2018 01:35:47 +0200 Subject: API documentantion update --- .../-form-panel/-init-.html | 10 ++- .../-form-panel/action.html | 21 ++++++ api/pl.treksoft.kvision.form/-form-panel/add.html | 16 +++++ .../-form-panel/autocomplete.html | 21 ++++++ .../-form-panel/enctype.html | 21 ++++++ .../-form-panel/form-panel.html | 4 +- .../-form-panel/get-sn-attrs.html | 18 +++++ .../-form-panel/index.html | 78 +++++++++++++++++++++- .../-form-panel/method.html | 21 ++++++ api/pl.treksoft.kvision.form/-form-panel/name.html | 21 ++++++ .../-form-panel/novalidate.html | 21 ++++++ .../-form-panel/target.html | 21 ++++++ 12 files changed, 267 insertions(+), 6 deletions(-) create mode 100644 api/pl.treksoft.kvision.form/-form-panel/action.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/autocomplete.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/enctype.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/get-sn-attrs.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/method.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/name.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/novalidate.html create mode 100644 api/pl.treksoft.kvision.form/-form-panel/target.html (limited to 'api/pl.treksoft.kvision.form/-form-panel') diff --git a/api/pl.treksoft.kvision.form/-form-panel/-init-.html b/api/pl.treksoft.kvision.form/-form-panel/-init-.html index 754f2a51..e2eb6cf7 100644 --- a/api/pl.treksoft.kvision.form/-form-panel/-init-.html +++ b/api/pl.treksoft.kvision.form/-form-panel/-init-.html @@ -8,11 +8,17 @@ kvision / pl.treksoft.kvision.form / FormPanel / <init>

<init>

- -FormPanel(type: FormType? = null, classes: Set<String> = setOf(), modelFactory: (Map<String, Any?>) -> K) + +FormPanel(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, classes: Set<String> = setOf(), modelFactory: (Map<String, Any?>) -> K)

Parameters

K - model class type

+

+method - HTTP method

+

+action - the URL address to send data

+

+enctype - form encoding type

type - form layout

diff --git a/api/pl.treksoft.kvision.form/-form-panel/action.html b/api/pl.treksoft.kvision.form/-form-panel/action.html new file mode 100644 index 00000000..0c8c0b9c --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/action.html @@ -0,0 +1,21 @@ + + + +FormPanel.action - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / action
+
+

action

+ +var action: String? +

The URL address to send data.

+

Getter
+

The URL address to send data.

+

+

Setter
+

The URL address to send data.

+

+ + diff --git a/api/pl.treksoft.kvision.form/-form-panel/add.html b/api/pl.treksoft.kvision.form/-form-panel/add.html index 4d325c15..0c9fd3ca 100644 --- a/api/pl.treksoft.kvision.form/-form-panel/add.html +++ b/api/pl.treksoft.kvision.form/-form-panel/add.html @@ -72,5 +72,21 @@ current form panel

validator - optional validation function

Return
current form panel

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

Adds a files control to the form panel.

+

Parameters

+

+key - key identifier of the control

+

+control - the files form control

+

+required - determines if the control is required

+

+validatorMessage - optional function returning validation message

+

+validator - optional validation function

+

Return
+current form panel

diff --git a/api/pl.treksoft.kvision.form/-form-panel/autocomplete.html b/api/pl.treksoft.kvision.form/-form-panel/autocomplete.html new file mode 100644 index 00000000..ac2784b1 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/autocomplete.html @@ -0,0 +1,21 @@ + + + +FormPanel.autocomplete - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / autocomplete
+
+

autocomplete

+ +var autocomplete: Boolean? +

Determines if the form should have autocomplete.

+

Getter
+

Determines if the form should have autocomplete.

+

+

Setter
+

Determines if the form should have autocomplete.

+

+ + diff --git a/api/pl.treksoft.kvision.form/-form-panel/enctype.html b/api/pl.treksoft.kvision.form/-form-panel/enctype.html new file mode 100644 index 00000000..a1bb7f09 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/enctype.html @@ -0,0 +1,21 @@ + + + +FormPanel.enctype - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / enctype
+
+

enctype

+ +var enctype: FormEnctype? +

The form encoding type.

+

Getter
+

The form encoding type.

+

+

Setter
+

The form encoding type.

+

+ + diff --git a/api/pl.treksoft.kvision.form/-form-panel/form-panel.html b/api/pl.treksoft.kvision.form/-form-panel/form-panel.html index 6410911f..11590ed4 100644 --- a/api/pl.treksoft.kvision.form/-form-panel/form-panel.html +++ b/api/pl.treksoft.kvision.form/-form-panel/form-panel.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.form / FormPanel / formPanel

formPanel

- -fun <K> Container.formPanel(type: FormType? = null, classes: Set<String> = setOf(), modelFactory: (Map<String, Any?>) -> K): FormPanel<K> + +fun <K> Container.formPanel(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, classes: Set<String> = setOf(), modelFactory: (Map<String, Any?>) -> K): FormPanel<K>

DSL builder extension function.

It takes the same parameters as the constructor of the built component.

diff --git a/api/pl.treksoft.kvision.form/-form-panel/get-sn-attrs.html b/api/pl.treksoft.kvision.form/-form-panel/get-sn-attrs.html new file mode 100644 index 00000000..6a222e89 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/get-sn-attrs.html @@ -0,0 +1,18 @@ + + + +FormPanel.getSnAttrs - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / 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/-form-panel/index.html b/api/pl.treksoft.kvision.form/-form-panel/index.html index 2a99b314..8268f58f 100644 --- a/api/pl.treksoft.kvision.form/-form-panel/index.html +++ b/api/pl.treksoft.kvision.form/-form-panel/index.html @@ -18,7 +18,7 @@

<init>

-FormPanel(type: FormType? = null, classes: Set<String> = setOf(), modelFactory: (Map<String, Any?>) -> K) +FormPanel(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, classes: Set<String> = setOf(), modelFactory: (Map<String, Any?>) -> K) @@ -27,6 +27,69 @@ +

action

+ + +var action: String? +

The URL address to send data.

+ + + + +

autocomplete

+ + +var autocomplete: Boolean? +

Determines if the form should have autocomplete.

+ + + + +

enctype

+ + +var enctype: FormEnctype? +

The form encoding type.

+ + + + +

method

+ + +var method: FormMethod? +

HTTP method.

+ + + + +

name

+ + +var name: String? +

The form name.

+ + + + +

novalidate

+ + +var novalidate: Boolean? +

Determines if the form is not validated.

+ + + + +

target

+ + +var target: FormTarget? +

The form target.

+ + + +

validator

@@ -61,6 +124,8 @@

Adds a number control to the form panel.

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

Adds a date control to the form panel.

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

Adds a files control to the form panel.

@@ -117,6 +182,15 @@ +

getSnAttrs

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

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

+ + + +

getSnClass

@@ -238,7 +312,7 @@

formPanel

-fun <K> Container.formPanel(type: FormType? = null, classes: Set<String> = setOf(), modelFactory: (Map<String, Any?>) -> K): FormPanel<K> +fun <K> Container.formPanel(method: FormMethod? = null, action: String? = null, enctype: FormEnctype? = null, type: FormType? = null, classes: Set<String> = setOf(), modelFactory: (Map<String, Any?>) -> K): FormPanel<K>

DSL builder extension function.

diff --git a/api/pl.treksoft.kvision.form/-form-panel/method.html b/api/pl.treksoft.kvision.form/-form-panel/method.html new file mode 100644 index 00000000..7ca06019 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/method.html @@ -0,0 +1,21 @@ + + + +FormPanel.method - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / method
+
+

method

+ +var method: FormMethod? +

HTTP method.

+

Getter
+

HTTP method.

+

+

Setter
+

HTTP method.

+

+ + diff --git a/api/pl.treksoft.kvision.form/-form-panel/name.html b/api/pl.treksoft.kvision.form/-form-panel/name.html new file mode 100644 index 00000000..6bd945d4 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/name.html @@ -0,0 +1,21 @@ + + + +FormPanel.name - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / name
+
+

name

+ +var name: String? +

The form name.

+

Getter
+

The form name.

+

+

Setter
+

The form name.

+

+ + diff --git a/api/pl.treksoft.kvision.form/-form-panel/novalidate.html b/api/pl.treksoft.kvision.form/-form-panel/novalidate.html new file mode 100644 index 00000000..fdd7b2f5 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/novalidate.html @@ -0,0 +1,21 @@ + + + +FormPanel.novalidate - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / novalidate
+
+

novalidate

+ +var novalidate: Boolean? +

Determines if the form is not validated.

+

Getter
+

Determines if the form is not validated.

+

+

Setter
+

Determines if the form is not validated.

+

+ + diff --git a/api/pl.treksoft.kvision.form/-form-panel/target.html b/api/pl.treksoft.kvision.form/-form-panel/target.html new file mode 100644 index 00000000..97f36931 --- /dev/null +++ b/api/pl.treksoft.kvision.form/-form-panel/target.html @@ -0,0 +1,21 @@ + + + +FormPanel.target - kvision + + + +kvision / pl.treksoft.kvision.form / FormPanel / target
+
+

target

+ +var target: FormTarget? +

The form target.

+

Getter
+

The form target.

+

+

Setter
+

The form target.

+

+ + -- cgit