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 --- .../-ajax-options/-init-.html | 43 +++++++ .../-ajax-options/before-send.html | 14 +++ .../-ajax-options/cache.html | 14 +++ .../-ajax-options/clear-on-empty.html | 14 +++ .../-ajax-options/clear-on-error.html | 14 +++ .../-ajax-options/data-type.html | 14 +++ .../-ajax-options/data.html | 14 +++ .../-ajax-options/empty-request.html | 14 +++ .../-ajax-options/http-type.html | 14 +++ .../-ajax-options/index.html | 136 +++++++++++++++++++++ .../-ajax-options/min-length.html | 14 +++ .../-ajax-options/preprocess-data.html | 14 +++ .../-ajax-options/request-delay.html | 14 +++ .../-ajax-options/restore-on-error.html | 14 +++ .../-ajax-options/url.html | 14 +++ 15 files changed, 361 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.form.select/-ajax-options/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-ajax-options/before-send.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-ajax-options/cache.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-ajax-options/clear-on-empty.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-ajax-options/clear-on-error.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-ajax-options/data-type.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-ajax-options/data.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-ajax-options/empty-request.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-ajax-options/http-type.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-ajax-options/index.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-ajax-options/min-length.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-ajax-options/preprocess-data.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-ajax-options/request-delay.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-ajax-options/restore-on-error.html create mode 100644 docs/api/pl.treksoft.kvision.form.select/-ajax-options/url.html (limited to 'docs/api/pl.treksoft.kvision.form.select/-ajax-options') diff --git a/docs/api/pl.treksoft.kvision.form.select/-ajax-options/-init-.html b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/-init-.html new file mode 100644 index 00000000..e19ac29f --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/-init-.html @@ -0,0 +1,43 @@ + + + +AjaxOptions.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.select / AjaxOptions / <init>
+
+

<init>

+ +

AjaxOptions(url: String, preprocessData: (dynamic) -> dynamic, beforeSend: (JQueryXHR) -> dynamic = null, data: dynamic = null, httpType: HTTPTYPE = HTTPTYPE.GET, dataType: DATATYPE = DATATYPE.JSON, minLength: Int = 0, cache: Boolean = true, clearOnEmpty: Boolean = true, clearOnError: Boolean = true, emptyRequest: Boolean = false, requestDelay: Int = AJAX_REQUEST_DELAY, restoreOnError: Boolean = false)

Parameters

+url - the url address

+preprocessData - AjaxBootstrapSelect preprocessOption +option

+beforeSend - JQuery ajax.beforeSend option

+data - JQuery ajax.data option

+httpType - JQuery ajax.type option

+minLength - AjaxBootstrapSelect minLength option

+cache - AjaxBootstrapSelect cache option

+clearOnEmpty - AjaxBootstrapSelect clearOnEmpty option

+clearOnError - AjaxBootstrapSelect clearOnError option

+emptyRequest - AjaxBootstrapSelect emptyRequest option

+requestDelay - AjaxBootstrapSelect requestDelay option

+restoreOnError - AjaxBootstrapSelect restoreOnError +option

Constructor
+

+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-ajax-options/before-send.html b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/before-send.html new file mode 100644 index 00000000..3ce72788 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/before-send.html @@ -0,0 +1,14 @@ + + + +AjaxOptions.beforeSend - kvision + + + +kvision / pl.treksoft.kvision.form.select / AjaxOptions / beforeSend
+
+

beforeSend

+ +val beforeSend: (JQueryXHR) -> dynamic + + diff --git a/docs/api/pl.treksoft.kvision.form.select/-ajax-options/cache.html b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/cache.html new file mode 100644 index 00000000..db1944c7 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/cache.html @@ -0,0 +1,14 @@ + + + +AjaxOptions.cache - kvision + + + +kvision / pl.treksoft.kvision.form.select / AjaxOptions / cache
+
+

cache

+ +val cache: Boolean + + diff --git a/docs/api/pl.treksoft.kvision.form.select/-ajax-options/clear-on-empty.html b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/clear-on-empty.html new file mode 100644 index 00000000..5ee08617 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/clear-on-empty.html @@ -0,0 +1,14 @@ + + + +AjaxOptions.clearOnEmpty - kvision + + + +kvision / pl.treksoft.kvision.form.select / AjaxOptions / clearOnEmpty
+
+

clearOnEmpty

+ +val clearOnEmpty: Boolean + + diff --git a/docs/api/pl.treksoft.kvision.form.select/-ajax-options/clear-on-error.html b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/clear-on-error.html new file mode 100644 index 00000000..81b5784a --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/clear-on-error.html @@ -0,0 +1,14 @@ + + + +AjaxOptions.clearOnError - kvision + + + +kvision / pl.treksoft.kvision.form.select / AjaxOptions / clearOnError
+
+

clearOnError

+ +val clearOnError: Boolean + + diff --git a/docs/api/pl.treksoft.kvision.form.select/-ajax-options/data-type.html b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/data-type.html new file mode 100644 index 00000000..01f60431 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/data-type.html @@ -0,0 +1,14 @@ + + + +AjaxOptions.dataType - kvision + + + +kvision / pl.treksoft.kvision.form.select / AjaxOptions / dataType
+
+

dataType

+ +val dataType: DATATYPE + + diff --git a/docs/api/pl.treksoft.kvision.form.select/-ajax-options/data.html b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/data.html new file mode 100644 index 00000000..037758fb --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/data.html @@ -0,0 +1,14 @@ + + + +AjaxOptions.data - kvision + + + +kvision / pl.treksoft.kvision.form.select / AjaxOptions / data
+
+

data

+ +val data: dynamic + + diff --git a/docs/api/pl.treksoft.kvision.form.select/-ajax-options/empty-request.html b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/empty-request.html new file mode 100644 index 00000000..2c1085c1 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/empty-request.html @@ -0,0 +1,14 @@ + + + +AjaxOptions.emptyRequest - kvision + + + +kvision / pl.treksoft.kvision.form.select / AjaxOptions / emptyRequest
+
+

emptyRequest

+ +val emptyRequest: Boolean + + diff --git a/docs/api/pl.treksoft.kvision.form.select/-ajax-options/http-type.html b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/http-type.html new file mode 100644 index 00000000..8b5247eb --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/http-type.html @@ -0,0 +1,14 @@ + + + +AjaxOptions.httpType - kvision + + + +kvision / pl.treksoft.kvision.form.select / AjaxOptions / httpType
+
+

httpType

+ +val httpType: HTTPTYPE + + diff --git a/docs/api/pl.treksoft.kvision.form.select/-ajax-options/index.html b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/index.html new file mode 100644 index 00000000..3aada582 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/index.html @@ -0,0 +1,136 @@ + + + +AjaxOptions - kvision + + + +kvision / pl.treksoft.kvision.form.select / AjaxOptions
+
+

AjaxOptions

+data class AjaxOptions +

Data class for AJAX options.

Constructors

+ + + + + + + +

<init>

AjaxOptions(url: String, preprocessData: (dynamic) -> dynamic, beforeSend: (JQueryXHR) -> dynamic = null, data: dynamic = null, httpType: HTTPTYPE = HTTPTYPE.GET, dataType: DATATYPE = DATATYPE.JSON, minLength: Int = 0, cache: Boolean = true, clearOnEmpty: Boolean = true, clearOnError: Boolean = true, emptyRequest: Boolean = false, requestDelay: Int = AJAX_REQUEST_DELAY, restoreOnError: Boolean = false)

Properties

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

+ beforeSend +	+`val beforeSend: (JQueryXHR) -> dynamic`
+ cache +	+`val cache: Boolean`
+ clearOnEmpty +	+`val clearOnEmpty: Boolean`
+ clearOnError +	+`val clearOnError: Boolean`
+ data +	+`val data: dynamic`
+ dataType +	+`val dataType: DATATYPE`
+ emptyRequest +	+`val emptyRequest: Boolean`
+ httpType +	+`val httpType: HTTPTYPE`
+ minLength +	+`val minLength: Int`
+ preprocessData +	+`val preprocessData: (dynamic) -> dynamic`
+ requestDelay +	+`val requestDelay: Int`
+ restoreOnError +	+`val restoreOnError: Boolean`
+ url +	+`val url: String`

Extension Functions

+ + + + + + + +

toJs

+fun AjaxOptions.toJs(emptyOption: Boolean): dynamic +

Convert AjaxOptions to JavaScript JSON object.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.select/-ajax-options/min-length.html b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/min-length.html new file mode 100644 index 00000000..81746792 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/min-length.html @@ -0,0 +1,14 @@ + + + +AjaxOptions.minLength - kvision + + + +kvision / pl.treksoft.kvision.form.select / AjaxOptions / minLength
+
+

minLength

+ +val minLength: Int + + diff --git a/docs/api/pl.treksoft.kvision.form.select/-ajax-options/preprocess-data.html b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/preprocess-data.html new file mode 100644 index 00000000..08a0a8ee --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/preprocess-data.html @@ -0,0 +1,14 @@ + + + +AjaxOptions.preprocessData - kvision + + + +kvision / pl.treksoft.kvision.form.select / AjaxOptions / preprocessData
+
+

preprocessData

+ +val preprocessData: (dynamic) -> dynamic + + diff --git a/docs/api/pl.treksoft.kvision.form.select/-ajax-options/request-delay.html b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/request-delay.html new file mode 100644 index 00000000..d1b01119 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/request-delay.html @@ -0,0 +1,14 @@ + + + +AjaxOptions.requestDelay - kvision + + + +kvision / pl.treksoft.kvision.form.select / AjaxOptions / requestDelay
+
+

requestDelay

+ +val requestDelay: Int + + diff --git a/docs/api/pl.treksoft.kvision.form.select/-ajax-options/restore-on-error.html b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/restore-on-error.html new file mode 100644 index 00000000..0abc1431 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/restore-on-error.html @@ -0,0 +1,14 @@ + + + +AjaxOptions.restoreOnError - kvision + + + +kvision / pl.treksoft.kvision.form.select / AjaxOptions / restoreOnError
+
+

restoreOnError

+ +val restoreOnError: Boolean + + diff --git a/docs/api/pl.treksoft.kvision.form.select/-ajax-options/url.html b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/url.html new file mode 100644 index 00000000..787210a8 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.select/-ajax-options/url.html @@ -0,0 +1,14 @@ + + + +AjaxOptions.url - kvision + + + +kvision / pl.treksoft.kvision.form.select / AjaxOptions / url
+
+

url

+ +val url: String + + -- cgit