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 --- .../-upload-input/-init-.html | 23 + .../-upload-input/after-destroy.html | 16 + .../-upload-input/after-insert.html | 16 + .../-upload-input/allowed-file-extensions.html | 21 + .../-upload-input/allowed-file-types.html | 21 + .../-upload-input/blur.html | 15 + .../-upload-input/browse-on-zone-click.html | 21 + .../-upload-input/cancel.html | 15 + .../-upload-input/clear-input.html | 15 + .../-upload-input/disabled.html | 22 + .../-upload-input/drop-zone-enabled.html | 21 + .../-upload-input/explorer-theme.html | 21 + .../-upload-input/focus.html | 15 + .../-upload-input/get-sn-attrs.html | 18 + .../-upload-input/get-sn-class.html | 18 + .../-upload-input/get-value-as-string.html | 17 + .../-upload-input/index.html | 623 +++++++++++++++++++++ .../-upload-input/lock.html | 15 + .../-upload-input/multiple.html | 21 + .../-upload-input/name.html | 22 + .../-upload-input/prefer-iconic-preview.html | 21 + .../-upload-input/render.html | 18 + .../-upload-input/required.html | 21 + .../-upload-input/reset-input.html | 15 + .../-upload-input/show-browse.html | 21 + .../-upload-input/show-cancel.html | 21 + .../-upload-input/show-caption.html | 21 + .../-upload-input/show-preview.html | 21 + .../-upload-input/show-remove.html | 21 + .../-upload-input/show-upload.html | 21 + .../-upload-input/size.html | 22 + .../-upload-input/unlock.html | 15 + .../-upload-input/upload-extra-data.html | 21 + .../-upload-input/upload-input.html | 16 + .../-upload-input/upload-url.html | 24 + .../-upload-input/upload.html | 15 + .../-upload-input/value.html | 15 + .../-upload/-init-.html | 25 + .../-upload/allowed-file-extensions.html | 15 + .../-upload/allowed-file-types.html | 15 + .../-upload/blur.html | 16 + .../-upload/browse-on-zone-click.html | 15 + .../-upload/cancel.html | 15 + .../-upload/clear-input.html | 15 + .../-upload/drop-zone-enabled.html | 15 + .../-upload/explorer-theme.html | 15 + .../-upload/flabel.html | 16 + .../-upload/focus.html | 16 + .../-upload/get-sn-class.html | 18 + .../-upload/get-value-as-string.html | 16 + .../-upload/idc.html | 14 + .../-upload/index.html | 461 +++++++++++++++ .../-upload/input.html | 16 + .../-upload/label.html | 15 + .../-upload/lock.html | 15 + .../-upload/multiple.html | 15 + .../-upload/prefer-iconic-preview.html | 15 + .../-upload/remove-event-listeners.html | 18 + .../-upload/required.html | 15 + .../-upload/reset-input.html | 15 + .../-upload/rich.html | 15 + .../-upload/set-event-listener.html | 54 ++ .../-upload/show-browse.html | 15 + .../-upload/show-cancel.html | 15 + .../-upload/show-caption.html | 15 + .../-upload/show-preview.html | 15 + .../-upload/show-remove.html | 15 + .../-upload/show-upload.html | 15 + .../-upload/unlock.html | 15 + .../-upload/upload-extra-data.html | 15 + .../-upload/upload-url.html | 16 + .../-upload/upload.html | 19 + .../-upload/validation-info.html | 16 + .../-upload/value.html | 16 + api/pl.treksoft.kvision.form.upload/index.html | 36 ++ 75 files changed, 2408 insertions(+) create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/-init-.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/after-destroy.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/after-insert.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/allowed-file-extensions.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/allowed-file-types.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/blur.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/browse-on-zone-click.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/cancel.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/clear-input.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/disabled.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/drop-zone-enabled.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/explorer-theme.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/focus.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/get-sn-attrs.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/get-sn-class.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/get-value-as-string.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/index.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/lock.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/multiple.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/name.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/prefer-iconic-preview.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/render.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/required.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/reset-input.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/show-browse.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/show-cancel.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/show-caption.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/show-preview.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/show-remove.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/show-upload.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/size.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/unlock.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/upload-extra-data.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/upload-input.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/upload-url.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/upload.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/value.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/-init-.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/allowed-file-extensions.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/allowed-file-types.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/blur.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/browse-on-zone-click.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/cancel.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/clear-input.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/drop-zone-enabled.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/explorer-theme.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/flabel.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/focus.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/get-sn-class.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/get-value-as-string.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/idc.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/index.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/input.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/label.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/lock.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/multiple.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/prefer-iconic-preview.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/remove-event-listeners.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/required.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/reset-input.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/rich.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/set-event-listener.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/show-browse.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/show-cancel.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/show-caption.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/show-preview.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/show-remove.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/show-upload.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/unlock.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/upload-extra-data.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/upload-url.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/upload.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/validation-info.html create mode 100644 api/pl.treksoft.kvision.form.upload/-upload/value.html create mode 100644 api/pl.treksoft.kvision.form.upload/index.html (limited to 'api/pl.treksoft.kvision.form.upload') diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/-init-.html b/api/pl.treksoft.kvision.form.upload/-upload-input/-init-.html new file mode 100644 index 00000000..9ce79234 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/-init-.html @@ -0,0 +1,23 @@ + + + +UploadInput.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / <init>
+
+

<init>

+ +UploadInput(uploadUrl: String? = null, multiple: Boolean = false, classes: Set<String> = setOf()) +

Parameters

+

+uploadUrl - the optional URL for the upload processing action

+

+multiple - determines if multiple file upload is supported

+

+classes - a set of CSS class names

+

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/after-destroy.html b/api/pl.treksoft.kvision.form.upload/-upload-input/after-destroy.html new file mode 100644 index 00000000..0f0e6683 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/after-destroy.html @@ -0,0 +1,16 @@ + + + +UploadInput.afterDestroy - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / afterDestroy
+
+

afterDestroy

+ +protected open fun afterDestroy(): Unit +

Overrides Widget.afterDestroy

+

Method called after destroying Snabbdom vnode.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/after-insert.html b/api/pl.treksoft.kvision.form.upload/-upload-input/after-insert.html new file mode 100644 index 00000000..a1587742 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/after-insert.html @@ -0,0 +1,16 @@ + + + +UploadInput.afterInsert - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / afterInsert
+
+

afterInsert

+ +protected open fun afterInsert(node: VNode): Unit +

Overrides Widget.afterInsert

+

Method called after inserting Snabbdom vnode into the DOM.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/allowed-file-extensions.html b/api/pl.treksoft.kvision.form.upload/-upload-input/allowed-file-extensions.html new file mode 100644 index 00000000..ab3baca7 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/allowed-file-extensions.html @@ -0,0 +1,21 @@ + + + +UploadInput.allowedFileExtensions - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / allowedFileExtensions
+
+

allowedFileExtensions

+ +var allowedFileExtensions: Set<String>? +

Allowed file extensions.

+

Getter
+

Allowed file extensions.

+

+

Setter
+

Allowed file extensions.

+

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/allowed-file-types.html b/api/pl.treksoft.kvision.form.upload/-upload-input/allowed-file-types.html new file mode 100644 index 00000000..37963eec --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/allowed-file-types.html @@ -0,0 +1,21 @@ + + + +UploadInput.allowedFileTypes - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / allowedFileTypes
+
+

allowedFileTypes

+ +var allowedFileTypes: Set<String>? +

Allowed file types.

+

Getter
+

Allowed file types.

+

+

Setter
+

Allowed file types.

+

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/blur.html b/api/pl.treksoft.kvision.form.upload/-upload-input/blur.html new file mode 100644 index 00000000..1bf38673 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/blur.html @@ -0,0 +1,15 @@ + + + +UploadInput.blur - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / blur
+
+

blur

+ +open fun blur(): Unit +

Makes the input element blur.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/browse-on-zone-click.html b/api/pl.treksoft.kvision.form.upload/-upload-input/browse-on-zone-click.html new file mode 100644 index 00000000..6e60de7c --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/browse-on-zone-click.html @@ -0,0 +1,21 @@ + + + +UploadInput.browseOnZoneClick - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / browseOnZoneClick
+
+

browseOnZoneClick

+ +var browseOnZoneClick: Boolean +

Determines if the click on the preview zone opens file browse window.

+

Getter
+

Determines if the click on the preview zone opens file browse window.

+

+

Setter
+

Determines if the click on the preview zone opens file browse window.

+

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/cancel.html b/api/pl.treksoft.kvision.form.upload/-upload-input/cancel.html new file mode 100644 index 00000000..808fd4f6 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/cancel.html @@ -0,0 +1,15 @@ + + + +UploadInput.cancel - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / cancel
+
+

cancel

+ +open fun cancel(): Unit +

Cancel an ongoing ajax upload (only for ajax mode).

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/clear-input.html b/api/pl.treksoft.kvision.form.upload/-upload-input/clear-input.html new file mode 100644 index 00000000..a814b493 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/clear-input.html @@ -0,0 +1,15 @@ + + + +UploadInput.clearInput - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / clearInput
+
+

clearInput

+ +open fun clearInput(): Unit +

Clears the file input control (including the native input).

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

disabled

+ +open var disabled: Boolean +

Overrides FormInput.disabled

+

Determines if the field is disabled.

+

Getter
+

Determines if the field is disabled.

+

+

Setter
+

Determines if the field is disabled.

+

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/drop-zone-enabled.html b/api/pl.treksoft.kvision.form.upload/-upload-input/drop-zone-enabled.html new file mode 100644 index 00000000..b8488a76 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/drop-zone-enabled.html @@ -0,0 +1,21 @@ + + + +UploadInput.dropZoneEnabled - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / dropZoneEnabled
+
+

dropZoneEnabled

+ +var dropZoneEnabled: Boolean +

Determines if Drag&Drop zone is enabled.

+

Getter
+

Determines if Drag&Drop zone is enabled.

+

+

Setter
+

Determines if Drag&Drop zone is enabled.

+

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/explorer-theme.html b/api/pl.treksoft.kvision.form.upload/-upload-input/explorer-theme.html new file mode 100644 index 00000000..0b99c0b9 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/explorer-theme.html @@ -0,0 +1,21 @@ + + + +UploadInput.explorerTheme - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / explorerTheme
+
+

explorerTheme

+ +var explorerTheme: Boolean +

Determines if the explorer theme is used.

+

Getter
+

Determines if the explorer theme is used.

+

+

Setter
+

Determines if the explorer theme is used.

+

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/focus.html b/api/pl.treksoft.kvision.form.upload/-upload-input/focus.html new file mode 100644 index 00000000..67e0b9d1 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/focus.html @@ -0,0 +1,15 @@ + + + +UploadInput.focus - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / focus
+
+

focus

+ +open fun focus(): Unit +

Makes the input element focused.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/get-sn-attrs.html b/api/pl.treksoft.kvision.form.upload/-upload-input/get-sn-attrs.html new file mode 100644 index 00000000..022a8470 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/get-sn-attrs.html @@ -0,0 +1,18 @@ + + + +UploadInput.getSnAttrs - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / 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.upload/-upload-input/get-sn-class.html b/api/pl.treksoft.kvision.form.upload/-upload-input/get-sn-class.html new file mode 100644 index 00000000..36ee4361 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/get-sn-class.html @@ -0,0 +1,18 @@ + + + +UploadInput.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / getSnClass
+
+

getSnClass

+ +protected open fun getSnClass(): List<StringBoolPair> +

Overrides Widget.getSnClass

+

Returns list of CSS class names for current widget in the form of a List.

+

Return
+list of CSS class names

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/get-value-as-string.html b/api/pl.treksoft.kvision.form.upload/-upload-input/get-value-as-string.html new file mode 100644 index 00000000..78e56668 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/get-value-as-string.html @@ -0,0 +1,17 @@ + + + +UploadInput.getValueAsString - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / getValueAsString
+
+

getValueAsString

+ +fun getValueAsString(): String? +

Returns the value of the file input control as a String.

+

Return
+value as a String

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/index.html b/api/pl.treksoft.kvision.form.upload/-upload-input/index.html new file mode 100644 index 00000000..3090e5be --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/index.html @@ -0,0 +1,623 @@ + + + +UploadInput - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput
+
+

UploadInput

+open class UploadInput : Widget, FormInput +

The file upload component.

+

Constructors

+ + + + + + + +
+

<init>

+		 +UploadInput(uploadUrl: String? = null, multiple: Boolean = false, classes: Set<String> = setOf())
+

Properties

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

allowedFileExtensions

+		 +var allowedFileExtensions: Set<String>? +

Allowed file extensions.

+
+

allowedFileTypes

+		 +var allowedFileTypes: Set<String>? +

Allowed file types.

+
+

browseOnZoneClick

+		 +var browseOnZoneClick: Boolean +

Determines if the click on the preview zone opens file browse window.

+
+

disabled

+		 +open var disabled: Boolean +

Determines if the field is disabled.

+
+

dropZoneEnabled

+		 +var dropZoneEnabled: Boolean +

Determines if Drag&Drop zone is enabled.

+
+

explorerTheme

+		 +var explorerTheme: Boolean +

Determines if the explorer theme is used.

+
+

multiple

+		 +var multiple: Boolean +

Determines if multiple file upload is supported.

+
+

name

+		 +open var name: String? +

The name attribute of the generated HTML input element.

+
+

preferIconicPreview

+		 +var preferIconicPreview: Boolean +

Determines if the iconic preview is prefered.

+
+

required

+		 +var required: Boolean +

Determines if the input selection is required.

+
+

showBrowse

+		 +var showBrowse: Boolean +

Determines if the file browse button is shown.

+
+

showCancel

+		 +var showCancel: Boolean +

Determines if the cancel button is shown.

+
+

showCaption

+		 +var showCaption: Boolean +

Determines if the caption is shown.

+
+

showPreview

+		 +var showPreview: Boolean +

Determines if the preview is shown.

+
+

showRemove

+		 +var showRemove: Boolean +

Determines if the remove button is shown.

+
+

showUpload

+		 +var showUpload: Boolean +

Determines if the upload button is shown.

+
+

size

+		 +open var size: InputSize? +

The size of the input (currently not working)

+
+

uploadExtraData

+		 +var uploadExtraData: (String, Int) -> dynamic +

The extra data that will be passed as data to the AJAX server call via POST.

+
+

uploadUrl

+		 +var uploadUrl: String? +

The optional URL for the upload processing action. +If not set the upload button action will default to form submission.

+
+

value

+		 +var value: List<File>? +

File input value.

+
+

Inherited Properties

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

draggable

+		 +var draggable: Boolean? +

Determines if the current widget is draggable.

+
+

id

+		 +var id: String? +

An ID attribute of generated HTML element.

+
+

parent

+		 +open var parent: Container? +

Parent of the current component.

+
+

role

+		 +var role: String? +

A role attribute of generated HTML element.

+
+

title

+		 +var title: String? +

A title attribute of generated HTML element.

+
+

visible

+		 +open var visible: Boolean +

Visibility state of the current component.

+
+

Functions

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

afterDestroy

+		 +open fun afterDestroy(): Unit +

Method called after destroying Snabbdom vnode.

+
+

afterInsert

+		 +open fun afterInsert(node: VNode): Unit +

Method called after inserting Snabbdom vnode into the DOM.

+
+

blur

+		 +open fun blur(): Unit +

Makes the input element blur.

+
+

cancel

+		 +open fun cancel(): Unit +

Cancel an ongoing ajax upload (only for ajax mode).

+
+

clearInput

+		 +open fun clearInput(): Unit +

Clears the file input control (including the native input).

+
+

focus

+		 +open fun focus(): Unit +

Makes the input element focused.

+
+

getSnAttrs

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

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

+
+

getSnClass

+		 +open fun getSnClass(): List<StringBoolPair> +

Returns list of CSS class names for current widget in the form of a List.

+
+

getValueAsString

+		 +fun getValueAsString(): String? +

Returns the value of the file input control as a String.

+
+

lock

+		 +open fun lock(): Unit +

Locks the file input (disabling all buttons except a cancel button).

+
+

render

+		 +open fun render(): VNode +

Renders current component as a Snabbdom vnode.

+
+

resetInput

+		 +open fun resetInput(): Unit +

Resets the file input control.

+
+

unlock

+		 +open fun unlock(): Unit +

Unlocks the file input.

+
+

upload

+		 +open fun upload(): Unit +

Trigger ajax upload (only for ajax mode).

+
+

Inherited Functions

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

addCssClass

+		 +open fun addCssClass(css: String): Widget +

Adds given value to the set of CSS classes generated in html code of current component.

+
+

addSurroundingCssClass

+		 +open fun addSurroundingCssClass(css: String): Widget +

Adds given value to the set of CSS classes generated in html code of parent component.

+
+

afterCreate

+		 +open fun afterCreate(node: VNode): Unit +

Method called after creating Snabbdom vnode.

+
+

afterPostpatch

+		 +open fun afterPostpatch(node: VNode): Unit +

Method called after updating Snabbdom vnode.

+
+

clearDragDropData

+		 +open fun clearDragDropData(): Unit +

Clears D&D data for the current widget. It also makes it not draggable.

+
+

getElement

+		 +open fun getElement(): Node? +

Returns DOM element bound to the current component.

+
+

getElementJQuery

+		 +open fun getElementJQuery(): JQuery? +

Returns JQuery element bound to the current component.

+
+

getElementJQueryD

+		 +open fun getElementJQueryD(): dynamic +

Returns JQuery element bound to the current component as a dynamic type.

+
+

getSnHooks

+		 +open fun getSnHooks(): Hooks? +

Returns list of hooks in the form of a Snabbdom Hooks object.

+
+

getSnOn

+		 +open fun getSnOn(): On? +

Returns list of event handlers in the form of a Snabbdom On object.

+
+

hide

+		 +open fun hide(): Widget +

Makes current widget invisible.

+
+

removeCssClass

+		 +open fun removeCssClass(css: String): Widget +

Removes given value from the set of CSS classes generated in html code of current component.

+
+

removeEventListeners

+		 +open fun removeEventListeners(): Widget +

Removes all event listeners from current widget.

+
+

removeSurroundingCssClass

+		 +open fun removeSurroundingCssClass(css: String): Widget +

Removes given value from the set of CSS classes generated in html code of parent component.

+
+

render

+		 +open fun render(elementName: String): VNode
+open fun render(elementName: String, children: Array<dynamic>): VNode +

Renders current component as a Snabbdom vnode.

+
+

setContextMenu

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

Sets context menu for the current widget.

+
+

setDragDropData

+		 +open fun setDragDropData(format: String, data: String): Unit +

Sets D&D data for the current widget. It also makes it draggable.

+
+

setDropTarget

+		 +open fun setDropTarget(format: String, callback: (DragEvent) -> Unit): Unit
+open fun setDropTarget(formats: Set<String>? = null, callback: (DragEvent) -> Unit): Unit +

Sets the current widget as a D&D drop target.

+
+

setDropTargetData

+		 +open fun setDropTargetData(format: String, callback: (String?) -> Unit): Unit +

Sets the current widget as a D&D drop target with helper callback accepting String data.

+
+

setEventListener

+		 +open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget +

Sets an event listener for current widget, keeping the actual type of component.

+open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget +

Sets an event listener for current widget.

+
+

show

+		 +open fun show(): Widget +

Makes current widget visible.

+
+

toggleVisible

+		 +open fun toggleVisible(): Widget +

Toggles visibility of current widget.

+
+

Companion Object Functions

+ + + + + + + +
+

uploadInput

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

DSL builder extension function.

+
+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/lock.html b/api/pl.treksoft.kvision.form.upload/-upload-input/lock.html new file mode 100644 index 00000000..6792e820 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/lock.html @@ -0,0 +1,15 @@ + + + +UploadInput.lock - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / lock
+
+

lock

+ +open fun lock(): Unit +

Locks the file input (disabling all buttons except a cancel button).

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/multiple.html b/api/pl.treksoft.kvision.form.upload/-upload-input/multiple.html new file mode 100644 index 00000000..395dd1b9 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/multiple.html @@ -0,0 +1,21 @@ + + + +UploadInput.multiple - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / multiple
+
+

multiple

+ +var multiple: Boolean +

Determines if multiple file upload is supported.

+

Getter
+

Determines if multiple file upload is supported.

+

+

Setter
+

Determines if multiple file upload is supported.

+

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

name

+ +open var name: String? +

Overrides FormInput.name

+

The name attribute of the generated HTML input element.

+

Getter
+

The name attribute of the generated HTML input element.

+

+

Setter
+

The name attribute of the generated HTML input element.

+

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/prefer-iconic-preview.html b/api/pl.treksoft.kvision.form.upload/-upload-input/prefer-iconic-preview.html new file mode 100644 index 00000000..517a7fc2 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/prefer-iconic-preview.html @@ -0,0 +1,21 @@ + + + +UploadInput.preferIconicPreview - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / preferIconicPreview
+
+

preferIconicPreview

+ +var preferIconicPreview: Boolean +

Determines if the iconic preview is prefered.

+

Getter
+

Determines if the iconic preview is prefered.

+

+

Setter
+

Determines if the iconic preview is prefered.

+

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/render.html b/api/pl.treksoft.kvision.form.upload/-upload-input/render.html new file mode 100644 index 00000000..f02ecef7 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/render.html @@ -0,0 +1,18 @@ + + + +UploadInput.render - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / render
+
+

render

+ +protected open fun render(): VNode +

Overrides Widget.render

+

Renders current component as a Snabbdom vnode.

+

Return
+Snabbdom vnode

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/required.html b/api/pl.treksoft.kvision.form.upload/-upload-input/required.html new file mode 100644 index 00000000..b86ef734 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/required.html @@ -0,0 +1,21 @@ + + + +UploadInput.required - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / required
+
+

required

+ +var required: Boolean +

Determines if the input selection is required.

+

Getter
+

Determines if the input selection is required.

+

+

Setter
+

Determines if the input selection is required.

+

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/reset-input.html b/api/pl.treksoft.kvision.form.upload/-upload-input/reset-input.html new file mode 100644 index 00000000..404849de --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/reset-input.html @@ -0,0 +1,15 @@ + + + +UploadInput.resetInput - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / resetInput
+
+

resetInput

+ +open fun resetInput(): Unit +

Resets the file input control.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/show-browse.html b/api/pl.treksoft.kvision.form.upload/-upload-input/show-browse.html new file mode 100644 index 00000000..8deba1ce --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/show-browse.html @@ -0,0 +1,21 @@ + + + +UploadInput.showBrowse - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / showBrowse
+
+

showBrowse

+ +var showBrowse: Boolean +

Determines if the file browse button is shown.

+

Getter
+

Determines if the file browse button is shown.

+

+

Setter
+

Determines if the file browse button is shown.

+

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/show-cancel.html b/api/pl.treksoft.kvision.form.upload/-upload-input/show-cancel.html new file mode 100644 index 00000000..96f45595 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/show-cancel.html @@ -0,0 +1,21 @@ + + + +UploadInput.showCancel - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / showCancel
+
+

showCancel

+ +var showCancel: Boolean +

Determines if the cancel button is shown.

+

Getter
+

Determines if the cancel button is shown.

+

+

Setter
+

Determines if the cancel button is shown.

+

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/show-caption.html b/api/pl.treksoft.kvision.form.upload/-upload-input/show-caption.html new file mode 100644 index 00000000..90429bd5 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/show-caption.html @@ -0,0 +1,21 @@ + + + +UploadInput.showCaption - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / showCaption
+
+

showCaption

+ +var showCaption: Boolean +

Determines if the caption is shown.

+

Getter
+

Determines if the caption is shown.

+

+

Setter
+

Determines if the caption is shown.

+

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/show-preview.html b/api/pl.treksoft.kvision.form.upload/-upload-input/show-preview.html new file mode 100644 index 00000000..7025fd2c --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/show-preview.html @@ -0,0 +1,21 @@ + + + +UploadInput.showPreview - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / showPreview
+
+

showPreview

+ +var showPreview: Boolean +

Determines if the preview is shown.

+

Getter
+

Determines if the preview is shown.

+

+

Setter
+

Determines if the preview is shown.

+

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/show-remove.html b/api/pl.treksoft.kvision.form.upload/-upload-input/show-remove.html new file mode 100644 index 00000000..1847fbcb --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/show-remove.html @@ -0,0 +1,21 @@ + + + +UploadInput.showRemove - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / showRemove
+
+

showRemove

+ +var showRemove: Boolean +

Determines if the remove button is shown.

+

Getter
+

Determines if the remove button is shown.

+

+

Setter
+

Determines if the remove button is shown.

+

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/show-upload.html b/api/pl.treksoft.kvision.form.upload/-upload-input/show-upload.html new file mode 100644 index 00000000..da388c67 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/show-upload.html @@ -0,0 +1,21 @@ + + + +UploadInput.showUpload - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / showUpload
+
+

showUpload

+ +var showUpload: Boolean +

Determines if the upload button is shown.

+

Getter
+

Determines if the upload button is shown.

+

+

Setter
+

Determines if the upload button is shown.

+

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

size

+ +open var size: InputSize? +

Overrides FormInput.size

+

The size of the input (currently not working)

+

Getter
+

The size of the input (currently not working)

+

+

Setter
+

The size of the input (currently not working)

+

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/unlock.html b/api/pl.treksoft.kvision.form.upload/-upload-input/unlock.html new file mode 100644 index 00000000..511efc6c --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/unlock.html @@ -0,0 +1,15 @@ + + + +UploadInput.unlock - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / unlock
+
+

unlock

+ +open fun unlock(): Unit +

Unlocks the file input.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/upload-extra-data.html b/api/pl.treksoft.kvision.form.upload/-upload-input/upload-extra-data.html new file mode 100644 index 00000000..5b033440 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/upload-extra-data.html @@ -0,0 +1,21 @@ + + + +UploadInput.uploadExtraData - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / uploadExtraData
+
+

uploadExtraData

+ +var uploadExtraData: (String, Int) -> dynamic +

The extra data that will be passed as data to the AJAX server call via POST.

+

Getter
+

The extra data that will be passed as data to the AJAX server call via POST.

+

+

Setter
+

The extra data that will be passed as data to the AJAX server call via POST.

+

+ + 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 new file mode 100644 index 00000000..c5711044 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/upload-input.html @@ -0,0 +1,16 @@ + + + +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/upload-url.html b/api/pl.treksoft.kvision.form.upload/-upload-input/upload-url.html new file mode 100644 index 00000000..1f1ef5bb --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/upload-url.html @@ -0,0 +1,24 @@ + + + +UploadInput.uploadUrl - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / uploadUrl
+
+

uploadUrl

+ +var uploadUrl: String? +

The optional URL for the upload processing action. +If not set the upload button action will default to form submission.

+

Getter
+

The optional URL for the upload processing action. +If not set the upload button action will default to form submission.

+

+

Setter
+

The optional URL for the upload processing action. +If not set the upload button action will default to form submission.

+

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

upload

+ +open fun upload(): Unit +

Trigger ajax upload (only for ajax mode).

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/value.html b/api/pl.treksoft.kvision.form.upload/-upload-input/value.html new file mode 100644 index 00000000..a740df1a --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/value.html @@ -0,0 +1,15 @@ + + + +UploadInput.value - kvision + + + +kvision / pl.treksoft.kvision.form.upload / UploadInput / value
+
+

value

+ +var value: List<File>? +

File input value.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/-init-.html b/api/pl.treksoft.kvision.form.upload/-upload/-init-.html new file mode 100644 index 00000000..bec7108c --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/-init-.html @@ -0,0 +1,25 @@ + + + +Upload.<init> - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / <init>
+
+

<init>

+ +Upload(uploadUrl: String? = null, multiple: Boolean = false, label: String? = null, rich: Boolean = false) +

Parameters

+

+uploadUrl - the optional URL for the upload processing action

+

+multiple - determines if multiple file upload is supported

+

+label - label text bound to the input element

+

+rich - determines if label can contain HTML code

+

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/allowed-file-extensions.html b/api/pl.treksoft.kvision.form.upload/-upload/allowed-file-extensions.html new file mode 100644 index 00000000..961352ac --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/allowed-file-extensions.html @@ -0,0 +1,15 @@ + + + +Upload.allowedFileExtensions - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / allowedFileExtensions
+
+

allowedFileExtensions

+ +var allowedFileExtensions: Set<String>? +

Allowed file extensions.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/allowed-file-types.html b/api/pl.treksoft.kvision.form.upload/-upload/allowed-file-types.html new file mode 100644 index 00000000..12c4dfb1 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/allowed-file-types.html @@ -0,0 +1,15 @@ + + + +Upload.allowedFileTypes - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / allowedFileTypes
+
+

allowedFileTypes

+ +var allowedFileTypes: Set<String>? +

Allowed file types.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/blur.html b/api/pl.treksoft.kvision.form.upload/-upload/blur.html new file mode 100644 index 00000000..c7ba847d --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/blur.html @@ -0,0 +1,16 @@ + + + +Upload.blur - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / blur
+
+

blur

+ +open fun blur(): Unit +

Overrides FormControl.blur

+

Makes the input element blur.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/browse-on-zone-click.html b/api/pl.treksoft.kvision.form.upload/-upload/browse-on-zone-click.html new file mode 100644 index 00000000..1873f506 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/browse-on-zone-click.html @@ -0,0 +1,15 @@ + + + +Upload.browseOnZoneClick - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / browseOnZoneClick
+
+

browseOnZoneClick

+ +var browseOnZoneClick: Boolean +

Determines if the click on the preview zone opens file browse window.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/cancel.html b/api/pl.treksoft.kvision.form.upload/-upload/cancel.html new file mode 100644 index 00000000..a82213e1 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/cancel.html @@ -0,0 +1,15 @@ + + + +Upload.cancel - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / cancel
+
+

cancel

+ +open fun cancel(): Unit +

Cancel an ongoing ajax upload (only for ajax mode).

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/clear-input.html b/api/pl.treksoft.kvision.form.upload/-upload/clear-input.html new file mode 100644 index 00000000..4955cd4a --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/clear-input.html @@ -0,0 +1,15 @@ + + + +Upload.clearInput - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / clearInput
+
+

clearInput

+ +open fun clearInput(): Unit +

Clears the file input control (including the native input).

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/drop-zone-enabled.html b/api/pl.treksoft.kvision.form.upload/-upload/drop-zone-enabled.html new file mode 100644 index 00000000..b7cee858 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/drop-zone-enabled.html @@ -0,0 +1,15 @@ + + + +Upload.dropZoneEnabled - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / dropZoneEnabled
+
+

dropZoneEnabled

+ +var dropZoneEnabled: Boolean +

Determines if Drag&Drop zone is enabled.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/explorer-theme.html b/api/pl.treksoft.kvision.form.upload/-upload/explorer-theme.html new file mode 100644 index 00000000..8527ed91 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/explorer-theme.html @@ -0,0 +1,15 @@ + + + +Upload.explorerTheme - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / explorerTheme
+
+

explorerTheme

+ +var explorerTheme: Boolean +

Determines if the explorer theme is used.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/flabel.html b/api/pl.treksoft.kvision.form.upload/-upload/flabel.html new file mode 100644 index 00000000..fccd517f --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/flabel.html @@ -0,0 +1,16 @@ + + + +Upload.flabel - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / flabel
+
+

flabel

+ +val flabel: FieldLabel +

Overrides FormControl.flabel

+

Form field label.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/focus.html b/api/pl.treksoft.kvision.form.upload/-upload/focus.html new file mode 100644 index 00000000..573c4456 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/focus.html @@ -0,0 +1,16 @@ + + + +Upload.focus - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / focus
+
+

focus

+ +open fun focus(): Unit +

Overrides FormControl.focus

+

Makes the input element focused.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/get-sn-class.html b/api/pl.treksoft.kvision.form.upload/-upload/get-sn-class.html new file mode 100644 index 00000000..e4baedc4 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/get-sn-class.html @@ -0,0 +1,18 @@ + + + +Upload.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / getSnClass
+
+

getSnClass

+ +protected open fun getSnClass(): List<StringBoolPair> +

Overrides Widget.getSnClass

+

Returns list of CSS class names for current widget in the form of a List.

+

Return
+list of CSS class names

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/get-value-as-string.html b/api/pl.treksoft.kvision.form.upload/-upload/get-value-as-string.html new file mode 100644 index 00000000..75533699 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/get-value-as-string.html @@ -0,0 +1,16 @@ + + + +Upload.getValueAsString - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / getValueAsString
+
+

getValueAsString

+ +open fun getValueAsString(): String? +

Overrides FilesFormControl.getValueAsString

+

Returns the value of the control as a String.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/idc.html b/api/pl.treksoft.kvision.form.upload/-upload/idc.html new file mode 100644 index 00000000..a8f3d7ed --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/idc.html @@ -0,0 +1,14 @@ + + + +Upload.idc - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / idc
+
+

idc

+ +protected val idc: String + + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/index.html b/api/pl.treksoft.kvision.form.upload/-upload/index.html new file mode 100644 index 00000000..157d652a --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/index.html @@ -0,0 +1,461 @@ + + + +Upload - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload
+
+

Upload

+open class Upload : SimplePanel, FilesFormControl +

The form field file upload component.

+

Constructors

+ + + + + + + +
+

<init>

+		 +Upload(uploadUrl: String? = null, multiple: Boolean = false, label: String? = null, rich: Boolean = false)
+

Properties

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

allowedFileExtensions

+		 +var allowedFileExtensions: Set<String>? +

Allowed file extensions.

+
+

allowedFileTypes

+		 +var allowedFileTypes: Set<String>? +

Allowed file types.

+
+

browseOnZoneClick

+		 +var browseOnZoneClick: Boolean +

Determines if the click on the preview zone opens file browse window.

+
+

dropZoneEnabled

+		 +var dropZoneEnabled: Boolean +

Determines if Drag&Drop zone is enabled.

+
+

explorerTheme

+		 +var explorerTheme: Boolean +

Determines if the explorer theme is used.

+
+

flabel

+		 +val flabel: FieldLabel +

Form field label.

+
+

idc

+		 +val idc: String
+

input

+		 +val input: UploadInput +

The actual input component.

+
+

label

+		 +var label: String? +

The label text bound to the spinner input element.

+
+

multiple

+		 +var multiple: Boolean +

Determines if multiple file upload is supported.

+
+

preferIconicPreview

+		 +var preferIconicPreview: Boolean +

Determines if the iconic preview is prefered.

+
+

required

+		 +var required: Boolean +

Determines if the input selection is required.

+
+

rich

+		 +var rich: Boolean +

Determines if label can contain HTML code.

+
+

showBrowse

+		 +var showBrowse: Boolean +

Determines if the file browse button is shown.

+
+

showCancel

+		 +var showCancel: Boolean +

Determines if the cancel button is shown.

+
+

showCaption

+		 +var showCaption: Boolean +

Determines if the caption is shown.

+
+

showPreview

+		 +var showPreview: Boolean +

Determines if the preview is shown.

+
+

showRemove

+		 +var showRemove: Boolean +

Determines if the remove button is shown.

+
+

showUpload

+		 +var showUpload: Boolean +

Determines if the upload button is shown.

+
+

uploadExtraData

+		 +var uploadExtraData: (String, Int) -> dynamic +

The extra data that will be passed as data to the AJAX server call via POST.

+
+

uploadUrl

+		 +var uploadUrl: String? +

The optional URL for the upload processing action. +If not set the upload button action will default to form submission.

+
+

validationInfo

+		 +val validationInfo: HelpBlock +

Validation info component.

+
+

value

+		 +open var value: List<File>? +

File input value.

+
+

Functions

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

blur

+		 +open fun blur(): Unit +

Makes the input element blur.

+
+

cancel

+		 +open fun cancel(): Unit +

Cancel an ongoing ajax upload (only for ajax mode).

+
+

clearInput

+		 +open fun clearInput(): Unit +

Clears the file input control (including the native input).

+
+

focus

+		 +open fun focus(): Unit +

Makes the input element focused.

+
+

getSnClass

+		 +open fun getSnClass(): List<StringBoolPair> +

Returns list of CSS class names for current widget in the form of a List.

+
+

getValueAsString

+		 +open fun getValueAsString(): String? +

Returns the value of the control as a String.

+
+

lock

+		 +open fun lock(): Unit +

Locks the file input (disabling all buttons except a cancel button).

+
+

removeEventListeners

+		 +open fun removeEventListeners(): Widget +

Removes all event listeners from current widget.

+
+

resetInput

+		 +open fun resetInput(): Unit +

Resets the file input control.

+
+

setEventListener

+		 +open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget +

Sets an event listener for current widget, keeping the actual type of component.

+open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget +

Sets an event listener for current widget.

+
+

unlock

+		 +open fun unlock(): Unit +

Unlocks the file input.

+
+

upload

+		 +open fun upload(): Unit +

Trigger ajax upload (only for ajax mode).

+
+

Inherited Functions

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

add

+		 +open fun add(child: Component): SimplePanel +

Adds given component to the current container.

+
+

addAll

+		 +open fun addAll(children: List<Component>): SimplePanel +

Adds a list of components to the current container.

+
+

addInternal

+		 +fun addInternal(child: Component): SimplePanel +

Protected and final method to add given component to the current container.

+
+

childrenVNodes

+		 +open fun childrenVNodes(): Array<VNode> +

Returns the array of the children Snabbdom vnodes.

+
+

getChildren

+		 +open fun getChildren(): List<Component> +

Returns a list of children of the current container.

+
+

getValue

+		 +open fun getValue(): List<File>? +

Returns the value of the control.

+
+

remove

+		 +open fun remove(child: Component): SimplePanel +

Removes given component from the current container.

+
+

removeAll

+		 +open fun removeAll(): SimplePanel +

Removes all children from the current container.

+
+

render

+		 +open fun render(): VNode +

Renders current component as a Snabbdom vnode.

+
+

setValue

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

Sets the value of the control.

+
+

Companion Object Functions

+ + + + + + + +
+

upload

+		 +fun Container.upload(uploadUrl: String? = null, multiple: Boolean = false, label: String? = null, rich: Boolean = false, init: Upload.() -> Unit = null): Upload +

DSL builder extension function.

+
+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/input.html b/api/pl.treksoft.kvision.form.upload/-upload/input.html new file mode 100644 index 00000000..be788045 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/input.html @@ -0,0 +1,16 @@ + + + +Upload.input - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / input
+
+

input

+ +val input: UploadInput +

Overrides FormControl.input

+

The actual input component.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/label.html b/api/pl.treksoft.kvision.form.upload/-upload/label.html new file mode 100644 index 00000000..d1851263 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/label.html @@ -0,0 +1,15 @@ + + + +Upload.label - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / label
+
+

label

+ +var label: String? +

The label text bound to the spinner input element.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/lock.html b/api/pl.treksoft.kvision.form.upload/-upload/lock.html new file mode 100644 index 00000000..33cf8bd6 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/lock.html @@ -0,0 +1,15 @@ + + + +Upload.lock - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / lock
+
+

lock

+ +open fun lock(): Unit +

Locks the file input (disabling all buttons except a cancel button).

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/multiple.html b/api/pl.treksoft.kvision.form.upload/-upload/multiple.html new file mode 100644 index 00000000..aa51660c --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/multiple.html @@ -0,0 +1,15 @@ + + + +Upload.multiple - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / multiple
+
+

multiple

+ +var multiple: Boolean +

Determines if multiple file upload is supported.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/prefer-iconic-preview.html b/api/pl.treksoft.kvision.form.upload/-upload/prefer-iconic-preview.html new file mode 100644 index 00000000..71e715bb --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/prefer-iconic-preview.html @@ -0,0 +1,15 @@ + + + +Upload.preferIconicPreview - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / preferIconicPreview
+
+

preferIconicPreview

+ +var preferIconicPreview: Boolean +

Determines if the iconic preview is prefered.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/remove-event-listeners.html b/api/pl.treksoft.kvision.form.upload/-upload/remove-event-listeners.html new file mode 100644 index 00000000..804b2aa2 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/remove-event-listeners.html @@ -0,0 +1,18 @@ + + + +Upload.removeEventListeners - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / removeEventListeners
+
+

removeEventListeners

+ +open fun removeEventListeners(): Widget +

Overrides Widget.removeEventListeners

+

Removes all event listeners from current widget.

+

Return
+current widget

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/required.html b/api/pl.treksoft.kvision.form.upload/-upload/required.html new file mode 100644 index 00000000..8f1ac1eb --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/required.html @@ -0,0 +1,15 @@ + + + +Upload.required - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / required
+
+

required

+ +var required: Boolean +

Determines if the input selection is required.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/reset-input.html b/api/pl.treksoft.kvision.form.upload/-upload/reset-input.html new file mode 100644 index 00000000..00f1e2f8 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/reset-input.html @@ -0,0 +1,15 @@ + + + +Upload.resetInput - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / resetInput
+
+

resetInput

+ +open fun resetInput(): Unit +

Resets the file input control.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/rich.html b/api/pl.treksoft.kvision.form.upload/-upload/rich.html new file mode 100644 index 00000000..1ae8819e --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/rich.html @@ -0,0 +1,15 @@ + + + +Upload.rich - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / rich
+
+

rich

+ +var rich: Boolean +

Determines if label can contain HTML code.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/set-event-listener.html b/api/pl.treksoft.kvision.form.upload/-upload/set-event-listener.html new file mode 100644 index 00000000..1e133847 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/set-event-listener.html @@ -0,0 +1,54 @@ + + + +Upload.setEventListener - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / setEventListener
+
+

setEventListener

+ +open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget +

Overrides Widget.setEventListener

+

Sets an event listener for current widget, keeping the actual type of component.

+

Parameters

+

+T - widget type

+

+block - event handler

+

Return
+

current widget

+ + +

Example:

+ + +
    button.setEventListener<Button> {
+        dblclick = {
+            Alert.show("Button double clicked!")
+            // self is of type Button here
+        }
+    }

+ +open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget +

Overrides Widget.setEventListener

+

Sets an event listener for current widget.

+

Parameters

+

+block - event handler

+

Return
+

current widget

+ + +

Example:

+ + +
    button.setEventListener {
+        dblclick = {
+            Alert.show("Button double clicked!")
+            // self is of type Widget here
+        }
+    }

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/show-browse.html b/api/pl.treksoft.kvision.form.upload/-upload/show-browse.html new file mode 100644 index 00000000..356f8cc3 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/show-browse.html @@ -0,0 +1,15 @@ + + + +Upload.showBrowse - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / showBrowse
+
+

showBrowse

+ +var showBrowse: Boolean +

Determines if the file browse button is shown.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/show-cancel.html b/api/pl.treksoft.kvision.form.upload/-upload/show-cancel.html new file mode 100644 index 00000000..6784c5e2 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/show-cancel.html @@ -0,0 +1,15 @@ + + + +Upload.showCancel - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / showCancel
+
+

showCancel

+ +var showCancel: Boolean +

Determines if the cancel button is shown.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/show-caption.html b/api/pl.treksoft.kvision.form.upload/-upload/show-caption.html new file mode 100644 index 00000000..6a61f972 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/show-caption.html @@ -0,0 +1,15 @@ + + + +Upload.showCaption - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / showCaption
+
+

showCaption

+ +var showCaption: Boolean +

Determines if the caption is shown.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/show-preview.html b/api/pl.treksoft.kvision.form.upload/-upload/show-preview.html new file mode 100644 index 00000000..04327037 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/show-preview.html @@ -0,0 +1,15 @@ + + + +Upload.showPreview - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / showPreview
+
+

showPreview

+ +var showPreview: Boolean +

Determines if the preview is shown.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/show-remove.html b/api/pl.treksoft.kvision.form.upload/-upload/show-remove.html new file mode 100644 index 00000000..75d29416 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/show-remove.html @@ -0,0 +1,15 @@ + + + +Upload.showRemove - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / showRemove
+
+

showRemove

+ +var showRemove: Boolean +

Determines if the remove button is shown.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/show-upload.html b/api/pl.treksoft.kvision.form.upload/-upload/show-upload.html new file mode 100644 index 00000000..34898831 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/show-upload.html @@ -0,0 +1,15 @@ + + + +Upload.showUpload - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / showUpload
+
+

showUpload

+ +var showUpload: Boolean +

Determines if the upload button is shown.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/unlock.html b/api/pl.treksoft.kvision.form.upload/-upload/unlock.html new file mode 100644 index 00000000..9054c6fe --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/unlock.html @@ -0,0 +1,15 @@ + + + +Upload.unlock - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / unlock
+
+

unlock

+ +open fun unlock(): Unit +

Unlocks the file input.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/upload-extra-data.html b/api/pl.treksoft.kvision.form.upload/-upload/upload-extra-data.html new file mode 100644 index 00000000..2f161eb2 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/upload-extra-data.html @@ -0,0 +1,15 @@ + + + +Upload.uploadExtraData - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / uploadExtraData
+
+

uploadExtraData

+ +var uploadExtraData: (String, Int) -> dynamic +

The extra data that will be passed as data to the AJAX server call via POST.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/upload-url.html b/api/pl.treksoft.kvision.form.upload/-upload/upload-url.html new file mode 100644 index 00000000..4dc61eb3 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/upload-url.html @@ -0,0 +1,16 @@ + + + +Upload.uploadUrl - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / uploadUrl
+
+

uploadUrl

+ +var uploadUrl: String? +

The optional URL for the upload processing action. +If not set the upload button action will default to form submission.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/upload.html b/api/pl.treksoft.kvision.form.upload/-upload/upload.html new file mode 100644 index 00000000..b81d1c6c --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/upload.html @@ -0,0 +1,19 @@ + + + +Upload.upload - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / upload
+
+

upload

+ +open fun upload(): Unit +

Trigger ajax upload (only for ajax mode).

+ +fun Container.upload(uploadUrl: String? = null, multiple: Boolean = false, label: String? = null, rich: Boolean = false, init: Upload.() -> Unit = null): Upload +

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/validation-info.html b/api/pl.treksoft.kvision.form.upload/-upload/validation-info.html new file mode 100644 index 00000000..c66192ee --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/validation-info.html @@ -0,0 +1,16 @@ + + + +Upload.validationInfo - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / validationInfo
+
+

validationInfo

+ +val validationInfo: HelpBlock +

Overrides FormControl.validationInfo

+

Validation info component.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/-upload/value.html b/api/pl.treksoft.kvision.form.upload/-upload/value.html new file mode 100644 index 00000000..30d1105f --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/-upload/value.html @@ -0,0 +1,16 @@ + + + +Upload.value - kvision + + + +kvision / pl.treksoft.kvision.form.upload / Upload / value
+
+

value

+ +open var value: List<File>? +

Overrides FilesFormControl.value

+

File input value.

+ + diff --git a/api/pl.treksoft.kvision.form.upload/index.html b/api/pl.treksoft.kvision.form.upload/index.html new file mode 100644 index 00000000..bb4120a9 --- /dev/null +++ b/api/pl.treksoft.kvision.form.upload/index.html @@ -0,0 +1,36 @@ + + + +pl.treksoft.kvision.form.upload - kvision + + + +kvision / pl.treksoft.kvision.form.upload
+
+

Package pl.treksoft.kvision.form.upload

+

Full-featured file upload component with drag & drop, preview and AJAX upload mode.

+

Types

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

Upload

+		 +open class Upload : SimplePanel, FilesFormControl +

The form field file upload component.

+
+

UploadInput

+		 +open class UploadInput : Widget, FormInput +

The file upload component.

+
+ + -- cgit