From 0365722f8549ee93918be99da1b9f901cf0b2c8d Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Fri, 13 Mar 2020 01:05:20 +0100 Subject: API documentation for KVision 3.5.2 --- .../-upload-input/-init-.html | 2 +- .../-upload-input/after-destroy.html | 3 +- .../-upload-input/after-insert.html | 3 +- .../-upload-input/allowed-file-extensions.html | 2 +- .../-upload-input/allowed-file-types.html | 2 +- .../-upload-input/blur.html | 3 +- .../-upload-input/browse-on-zone-click.html | 2 +- .../-upload-input/cancel.html | 2 +- .../-upload-input/clear-input.html | 2 +- .../-upload-input/disabled.html | 3 +- .../-upload-input/drop-zone-enabled.html | 2 +- .../-upload-input/explorer-theme.html | 2 +- .../-upload-input/focus.html | 3 +- .../-upload-input/get-native-file.html | 2 +- .../-upload-input/get-sn-attrs.html | 3 +- .../-upload-input/get-sn-class.html | 3 +- .../-upload-input/get-value-as-string.html | 2 +- .../-upload-input/index.html | 773 +++++---------------- .../-upload-input/lock.html | 2 +- .../-upload-input/multiple.html | 2 +- .../-upload-input/name.html | 3 +- .../-upload-input/prefer-iconic-preview.html | 2 +- .../-upload-input/render.html | 3 +- .../-upload-input/required.html | 2 +- .../-upload-input/reset-input.html | 2 +- .../-upload-input/show-browse.html | 2 +- .../-upload-input/show-cancel.html | 2 +- .../-upload-input/show-caption.html | 2 +- .../-upload-input/show-preview.html | 2 +- .../-upload-input/show-remove.html | 2 +- .../-upload-input/show-upload.html | 2 +- .../-upload-input/size.html | 3 +- .../-upload-input/unlock.html | 2 +- .../-upload-input/upload-extra-data.html | 2 +- .../-upload-input/upload-url.html | 2 +- .../-upload-input/upload.html | 2 +- .../-upload-input/validation-status.html | 3 +- .../-upload-input/value.html | 2 +- 38 files changed, 192 insertions(+), 666 deletions(-) (limited to 'api/pl.treksoft.kvision.form.upload/-upload-input') diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/-init-.html b/api/pl.treksoft.kvision.form.upload/-upload-input/-init-.html index 9ce79234..6a9cae93 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload-input/-init-.html +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.upload / UploadInput / <init>

<init>

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

Parameters

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 index 0f0e6683..ccbaf5e8 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload-input/after-destroy.html +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/after-destroy.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.upload / UploadInput / afterDestroy

afterDestroy

- +(js) 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 index a1587742..9cbe576b 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload-input/after-insert.html +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/after-insert.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.upload / UploadInput / afterInsert

afterInsert

- +(js) 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 index ab3baca7..eabce90d 100644 --- 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 @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.upload / UploadInput / allowedFileExtensions

allowedFileExtensions

- +(js) var allowedFileExtensions: Set<String>?

Allowed file extensions.

Getter
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 index 37963eec..a0ec7b47 100644 --- 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 @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.upload / UploadInput / allowedFileTypes

allowedFileTypes

- +(js) var allowedFileTypes: Set<String>?

Allowed file types.

Getter
diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/blur.html b/api/pl.treksoft.kvision.form.upload/-upload-input/blur.html index 3ae46f6e..e2e44ac3 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload-input/blur.html +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/blur.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.upload / UploadInput / blur

blur

- +(js) open fun blur(): Unit -

Overrides FormInput.blur

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 index 6e60de7c..77cfa99a 100644 --- 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 @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.upload / UploadInput / browseOnZoneClick

browseOnZoneClick

- +(js) var browseOnZoneClick: Boolean

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

Getter
diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/cancel.html b/api/pl.treksoft.kvision.form.upload/-upload-input/cancel.html index 808fd4f6..9e3e8435 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload-input/cancel.html +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/cancel.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.upload / UploadInput / cancel

cancel

- +(js) 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 index a814b493..547ca2f3 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload-input/clear-input.html +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/clear-input.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.upload / UploadInput / clearInput

clearInput

- +(js) 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 index 17d36121..477a4142 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload-input/disabled.html +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/disabled.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.upload / UploadInput / disabled

disabled

- +(js) open var disabled: Boolean -

Overrides FormInput.disabled

Determines if the field is disabled.

Getter

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 index b8488a76..91b89b33 100644 --- 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 @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.upload / UploadInput / dropZoneEnabled

dropZoneEnabled

- +(js) var dropZoneEnabled: Boolean

Determines if Drag&Drop zone is enabled.

Getter
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 index 0b99c0b9..b6d0f4b0 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload-input/explorer-theme.html +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/explorer-theme.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.upload / UploadInput / explorerTheme

explorerTheme

- +(js) var explorerTheme: Boolean

Determines if the explorer theme is used.

Getter
diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/focus.html b/api/pl.treksoft.kvision.form.upload/-upload-input/focus.html index 83144276..0407a1c3 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload-input/focus.html +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/focus.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.upload / UploadInput / focus

focus

- +(js) open fun focus(): Unit -

Overrides FormInput.focus

Makes the input element focused.

diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/get-native-file.html b/api/pl.treksoft.kvision.form.upload/-upload-input/get-native-file.html index 2061d320..30d9f101 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload-input/get-native-file.html +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/get-native-file.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.upload / UploadInput / getNativeFile

getNativeFile

- +(js) fun getNativeFile(kFile: KFile): File?

Returns the native JavaScript File object.

Parameters

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 index 022a8470..9336bcbd 100644 --- 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 @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.upload / UploadInput / getSnAttrs

getSnAttrs

- +(js) 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 index 36ee4361..820c26d7 100644 --- 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 @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.upload / UploadInput / getSnClass

getSnClass

- +(js) 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 index 78e56668..d8fe4943 100644 --- 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 @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.upload / UploadInput / getValueAsString

getValueAsString

- +(js) fun getValueAsString(): String?

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

Return
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 53010c07..88d46a15 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload-input/index.html +++ b/api/pl.treksoft.kvision.form.upload/-upload-input/index.html @@ -8,14 +8,15 @@ kvision / pl.treksoft.kvision.form.upload / UploadInput

UploadInput

-open class UploadInput : Widget, FormInput +(js) open class UploadInput : Widget, FormInput

The file upload component.

Constructors

@@ -27,303 +28,193 @@ +var allowedFileExtensions: Set<String>? +var allowedFileTypes: Set<String>? +var browseOnZoneClick: Boolean +open var disabled: Boolean +var dropZoneEnabled: Boolean +var explorerTheme: Boolean +var multiple: Boolean +open var name: String? +var preferIconicPreview: Boolean +var required: Boolean +var showBrowse: Boolean +var showCancel: Boolean +var showCaption: Boolean +var showPreview: Boolean +var showRemove: Boolean +var showUpload: Boolean +open var size: InputSize? +var uploadExtraData: ((String, Int) -> dynamic)? +var uploadUrl: String? +open var validationStatus: ValidationStatus? - - -
-

<init>

+(js) +

<init>

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

allowedFileExtensions

+(js) +

allowedFileExtensions

 -var allowedFileExtensions: Set<String>?

Allowed file extensions.

-
-

allowedFileTypes

+(js) +

allowedFileTypes

 -var allowedFileTypes: Set<String>?

Allowed file types.

-
-

browseOnZoneClick

+(js) +

browseOnZoneClick

 -var browseOnZoneClick: Boolean

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

-
-

disabled

+(js) +

disabled

 -open var disabled: Boolean

Determines if the field is disabled.

-
-

dropZoneEnabled

+(js) +

dropZoneEnabled

 -var dropZoneEnabled: Boolean

Determines if Drag&Drop zone is enabled.

-
-

explorerTheme

+(js) +

explorerTheme

 -var explorerTheme: Boolean

Determines if the explorer theme is used.

-
-

multiple

+(js) +

multiple

 -var multiple: Boolean

Determines if multiple file upload is supported.

-
-

name

+(js) +

name

 -open var name: String?

The name attribute of the generated HTML input element.

-
-

preferIconicPreview

+(js) +

preferIconicPreview

 -var preferIconicPreview: Boolean

Determines if the iconic preview is prefered.

-
-

required

+(js) +

required

 -var required: Boolean

Determines if the input selection is required.

-
-

showBrowse

+(js) +

showBrowse

 -var showBrowse: Boolean

Determines if the file browse button is shown.

-
-

showCancel

+(js) +

showCancel

 -var showCancel: Boolean

Determines if the cancel button is shown.

-
-

showCaption

+(js) +

showCaption

 -var showCaption: Boolean

Determines if the caption is shown.

-
-

showPreview

+(js) +

showPreview

 -var showPreview: Boolean

Determines if the preview is shown.

-
-

showRemove

+(js) +

showRemove

 -var showRemove: Boolean

Determines if the remove button is shown.

-
-

showUpload

+(js) +

showUpload

 -var showUpload: Boolean

Determines if the upload button is shown.

-
-

size

+(js) +

size

 -open var size: InputSize?

The size of the input (currently not working)

-
-

uploadExtraData

+(js) +

uploadExtraData

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

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

-
-

uploadUrl

+(js) +

uploadUrl

 -var uploadUrl: String?

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

-
-

validationStatus

+(js) +

validationStatus

 -open var validationStatus: ValidationStatus?

The validation status of the input.

-
-

value

+(js) +

value

 -var value: List<KFile>?

File input value.

-
-

Inherited Properties

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +var value: List<KFile>?
-

draggable

-		 -var draggable: Boolean? -

Determines if the current widget is draggable.

-
-

eventTarget

-		 -var eventTarget: Widget?
-

id

-		 -var id: String? -

An ID attribute of generated HTML element.

-
-

lastLanguage

-		 -var lastLanguage: String?
-

parent

-		 -open var parent: Container? -

Parent of the current component.

-
-

popoverOptions

-		 -var popoverOptions: PopoverOptions?
-

role

-		 -var role: String? -

A role attribute of generated HTML element.

-
-

surroundingSpan

-		 -var surroundingSpan: Boolean
-

tabindex

-		 -var tabindex: Int? -

A tabindex attribute of generated HTML element.

-
-

title

-		 -var title: String? -

A title attribute of generated HTML element.

-
-

tooltipOptions

-		 -var tooltipOptions: TooltipOptions?
-

visible

-		 -open var visible: Boolean -

Visibility state of the current component.

-
-

vnode

-		 -var vnode: VNode?
@@ -332,498 +223,138 @@ If not set the upload button action will default to form submission.

-

afterDestroy

+(js) +

afterDestroy

-open fun afterDestroy(): Unit

Method called after destroying Snabbdom vnode.

- +open fun afterDestroy(): Unit -

afterInsert

+(js) +

afterInsert

-open fun afterInsert(node: VNode): Unit

Method called after inserting Snabbdom vnode into the DOM.

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

blur

+(js) +

blur

-open fun blur(): Unit

Makes the input element blur.

- +open fun blur(): Unit -

cancel

+(js) +

cancel

-open fun cancel(): Unit

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

- +open fun cancel(): Unit -

clearInput

+(js) +

clearInput

-open fun clearInput(): Unit

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

- +open fun clearInput(): Unit -

focus

+(js) +

focus

-open fun focus(): Unit

Makes the input element focused.

- +open fun focus(): Unit -

getNativeFile

+(js) +

getNativeFile

-fun getNativeFile(kFile: KFile): File?

Returns the native JavaScript File object.

- +fun getNativeFile(kFile: KFile): File? -

getSnAttrs

+(js) +

getSnAttrs

-open fun getSnAttrs(): List<StringPair>

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

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

getSnClass

+(js) +

getSnClass

-open fun getSnClass(): List<StringBoolPair>

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

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

getValueAsString

+(js) +

getValueAsString

-fun getValueAsString(): String?

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

- +fun getValueAsString(): String? -

lock

+(js) +

lock

-open fun lock(): Unit

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

- +open fun lock(): Unit -

render

+(js) +

render

-open fun render(): VNode

Renders current component as a Snabbdom vnode.

- +open fun render(): VNode -

resetInput

+(js) +

resetInput

-open fun resetInput(): Unit

Resets the file input control.

- +open fun resetInput(): Unit -

unlock

+(js) +

unlock

-open fun unlock(): Unit

Unlocks the file input.

- +open