From fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 26 Oct 2019 00:17:24 +0200 Subject: API documentation for KVision 2.0.0 --- .../-upload-input/get-content.html | 24 ---- .../-upload-input/index.html | 124 +++++++++++++++++---- .../-upload-input/upload-input.html | 16 --- .../-upload-input/validation-status.html | 22 ++++ 4 files changed, 125 insertions(+), 61 deletions(-) delete mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/get-content.html delete mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/upload-input.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/validation-status.html (limited to 'api/pl.treksoft.kvision.form.upload/-upload-input') diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/get-content.html b/api/pl.treksoft.kvision.form.upload/-upload-input/get-content.html deleted file mode 100644 index d24d4aed..00000000 --- a/api/pl.treksoft.kvision.form.upload/-upload-input/get-content.html +++ /dev/null @@ -1,24 +0,0 @@ - - - -UploadInput.getContent - kvision - - - -kvision / pl.treksoft.kvision.form.upload / UploadInput / getContent
-
-

getContent

- -suspend fun <K : Any> Form<K>.getContent(key: KProperty1<K, List<KFile>?>, kFile: KFile): KFile
- -suspend fun <K : Any> FormPanel<K>.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.upload/-upload-input/index.html b/api/pl.treksoft.kvision.form.upload/-upload-input/index.html index 968c3e21..30d9f1c7 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload-input/index.html +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/index.html @@ -199,6 +199,15 @@ If not set the upload button action will default to form submission.

+

validationStatus

+ + +open var validationStatus: ValidationStatus? +

The validation status of the input.

+ + + +

value

@@ -277,6 +286,15 @@ If not set the upload button action will default to form submission.

+

tabindex

+ + +var tabindex: Int? +

A tabindex attribute of generated HTML element.

+ + + +

title

@@ -685,15 +703,6 @@ If not set the upload button action will default to form submission.

-

setContextMenu

- - -open fun setContextMenu(contextMenu: ContextMenu): Widget -

Sets context menu for the current widget.

- - - -

setDragDropData

@@ -783,33 +792,53 @@ If not set the upload button action will default to form submission.

-

Companion Object Functions

+

Extension Functions

+ + + + + + + + + + + + + + + + - -
-

getContent

+

addBsBgColor

+		 +fun Component.addBsBgColor(bsBgColor: BsBgColor): Unit
+

addBsBorder

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

Returns file with the content read.

+fun Component.addBsBorder(vararg bsBorder: BsBorder): Unit
+

addBsClearfix

 +fun Component.addBsClearfix(): Unit
-

uploadInput

+

addBsColor

 -fun Container.uploadInput(uploadUrl: String? = null, multiple: Boolean = false, classes: Set<String> = setOf(), init: (UploadInput.() -> Unit)? = null): UploadInput +fun Component.addBsColor(bsColor: BsColor): Unit
+

addBsRounded

+		 +fun Component.addBsRounded(vararg bsRounded: BsRounded): Unit
+

contextMenu

+		 +fun Widget.contextMenu(fixedPosition: Boolean = false, classes: Set<String> = setOf(), init: (ContextMenu.() -> Unit)? = null): ContextMenu

DSL builder extension function.
-

Extension Functions

- - + + + + + + + + + + + + + + + + + + + + + + + + + + + +

createInstance

@@ -819,6 +848,59 @@ If not set the upload button action will default to form submission.

Helper function for creating JavaScript objects from dynamic constructors.
+

removeBsBgColor

+		 +fun Component.removeBsBgColor(bsBgColor: BsBgColor): Unit
+

removeBsBorder

+		 +fun Component.removeBsBorder(vararg bsBorder: BsBorder): Unit
+

removeBsClearfix

+		 +fun Component.removeBsClearfix(): Unit
+

removeBsColor

+		 +fun Component.removeBsColor(bsColor: BsColor): Unit
+

removeBsRounded

+		 +fun Component.removeBsRounded(vararg bsRounded: BsRounded): Unit
+

setContextMenu

+		 +fun Widget.setContextMenu(contextMenu: ContextMenu): Widget +

Sets context menu for the current widget.

+
+

style

+		 +fun Widget.style(className: String? = null, init: (Style.() -> Unit)? = null): Style +

DSL builder extension function.

+
diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/upload-input.html b/api/pl.treksoft.kvision.form.upload/-upload-input/upload-input.html deleted file mode 100644 index 99f9a13a..00000000 --- a/api/pl.treksoft.kvision.form.upload/-upload-input/upload-input.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -UploadInput.uploadInput - kvision - - - -kvision / pl.treksoft.kvision.form.upload / UploadInput / uploadInput
-
-

uploadInput

- -fun Container.uploadInput(uploadUrl: String? = null, multiple: Boolean = false, classes: Set<String> = setOf(), init: (UploadInput.() -> Unit)? = null): UploadInput -

DSL builder extension function.

-

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

- - diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/validation-status.html b/api/pl.treksoft.kvision.form.upload/-upload-input/validation-status.html new file mode 100644 index 00000000..0edf9786 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/validation-status.html @@ -0,0 +1,22 @@ + + + +UploadInput.validationStatus - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / validationStatus
+
+

validationStatus

+ +open var validationStatus: ValidationStatus? +

Overrides FormInput.validationStatus

+

The validation status of the input.

+

Getter
+

The validation status of the input.

+

+

Setter
+

The validation status of the input.

+

+ + -- cgit