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/-init-.html | 2 +- .../-upload/allowed-file-extensions.html | 2 +- .../-upload/allowed-file-types.html | 2 +- .../-upload/blur.html | 3 +- .../-upload/browse-on-zone-click.html | 2 +- .../-upload/cancel.html | 2 +- .../-upload/clear-input.html | 2 +- .../-upload/drop-zone-enabled.html | 2 +- .../-upload/explorer-theme.html | 2 +- .../-upload/flabel.html | 3 +- .../-upload/focus.html | 3 +- .../-upload/get-native-file.html | 3 +- .../-upload/get-sn-class.html | 3 +- .../-upload/get-value-as-string.html | 3 +- .../-upload/idc.html | 2 +- .../-upload/index.html | 911 +++++++++------------ .../-upload/input.html | 3 +- .../-upload/invalid-feedback.html | 3 +- .../-upload/label.html | 2 +- .../-upload/lock.html | 2 +- .../-upload/multiple.html | 2 +- .../-upload/prefer-iconic-preview.html | 2 +- .../-upload/remove-event-listener.html | 3 +- .../-upload/remove-event-listeners.html | 3 +- .../-upload/required.html | 2 +- .../-upload/reset-input.html | 2 +- .../-upload/rich.html | 2 +- .../-upload/set-event-listener.html | 5 +- .../-upload/show-browse.html | 2 +- .../-upload/show-cancel.html | 2 +- .../-upload/show-caption.html | 2 +- .../-upload/show-preview.html | 2 +- .../-upload/show-remove.html | 2 +- .../-upload/show-upload.html | 2 +- .../-upload/unlock.html | 2 +- .../-upload/upload-extra-data.html | 2 +- .../-upload/upload-url.html | 2 +- .../-upload/upload.html | 2 +- .../-upload/value.html | 3 +- 39 files changed, 445 insertions(+), 556 deletions(-) (limited to 'api/pl.treksoft.kvision.form.upload/-upload') diff --git a/api/pl.treksoft.kvision.form.upload/-upload/-init-.html b/api/pl.treksoft.kvision.form.upload/-upload/-init-.html index 0978761d..47cbcb3a 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload/-init-.html +++ b/api/pl.treksoft.kvision.form.upload/-upload/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.upload / Upload / <init>

<init>

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

Parameters

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 index 961352ac..0e7fb6d4 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload/allowed-file-extensions.html +++ b/api/pl.treksoft.kvision.form.upload/-upload/allowed-file-extensions.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.upload / Upload / allowedFileExtensions

allowedFileExtensions

- +(js) 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 index 12c4dfb1..f0976a6b 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload/allowed-file-types.html +++ b/api/pl.treksoft.kvision.form.upload/-upload/allowed-file-types.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.upload / Upload / allowedFileTypes

allowedFileTypes

- +(js) 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 index c7ba847d..2be62595 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload/blur.html +++ b/api/pl.treksoft.kvision.form.upload/-upload/blur.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.upload / Upload / blur

blur

- +(js) 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 index 1873f506..9d2b7fcb 100644 --- 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 @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.upload / Upload / browseOnZoneClick

browseOnZoneClick

- +(js) 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 index a82213e1..21e22066 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload/cancel.html +++ b/api/pl.treksoft.kvision.form.upload/-upload/cancel.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.upload / Upload / 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/clear-input.html b/api/pl.treksoft.kvision.form.upload/-upload/clear-input.html index 4955cd4a..55e9bfa1 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload/clear-input.html +++ b/api/pl.treksoft.kvision.form.upload/-upload/clear-input.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.upload / Upload / 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/drop-zone-enabled.html b/api/pl.treksoft.kvision.form.upload/-upload/drop-zone-enabled.html index b7cee858..34771b21 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload/drop-zone-enabled.html +++ b/api/pl.treksoft.kvision.form.upload/-upload/drop-zone-enabled.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.upload / Upload / dropZoneEnabled

dropZoneEnabled

- +(js) 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 index 8527ed91..159210a6 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload/explorer-theme.html +++ b/api/pl.treksoft.kvision.form.upload/-upload/explorer-theme.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.upload / Upload / explorerTheme

explorerTheme

- +(js) 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 index fccd517f..4fd4b5f9 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload/flabel.html +++ b/api/pl.treksoft.kvision.form.upload/-upload/flabel.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.upload / Upload / flabel

flabel

- +(js) 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 index 573c4456..7d0f6980 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload/focus.html +++ b/api/pl.treksoft.kvision.form.upload/-upload/focus.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.upload / Upload / focus

focus

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

Overrides FormControl.focus

Makes the input element focused.

diff --git a/api/pl.treksoft.kvision.form.upload/-upload/get-native-file.html b/api/pl.treksoft.kvision.form.upload/-upload/get-native-file.html index b5331ca8..4c0d2abb 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload/get-native-file.html +++ b/api/pl.treksoft.kvision.form.upload/-upload/get-native-file.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.upload / Upload / getNativeFile

getNativeFile

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

Overrides KFilesFormControl.getNativeFile

Returns the native JavaScript File object.

Parameters

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 index e4baedc4..4a165a5a 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload/get-sn-class.html +++ b/api/pl.treksoft.kvision.form.upload/-upload/get-sn-class.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.upload / Upload / 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/get-value-as-string.html b/api/pl.treksoft.kvision.form.upload/-upload/get-value-as-string.html index 815a7838..3ff9a060 100644 --- 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 @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.form.upload / Upload / getValueAsString

getValueAsString

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

Overrides KFilesFormControl.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 index a8f3d7ed..7b7742c4 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload/idc.html +++ b/api/pl.treksoft.kvision.form.upload/-upload/idc.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.form.upload / Upload / idc

idc

- +(js) 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 index e4b844ca..f8698c5a 100644 --- a/api/pl.treksoft.kvision.form.upload/-upload/index.html +++ b/api/pl.treksoft.kvision.form.upload/-upload/index.html @@ -8,14 +8,15 @@ kvision / pl.treksoft.kvision.form.upload / Upload

Upload

-open class Upload : SimplePanel, KFilesFormControl +(js) open class Upload : SimplePanel, KFilesFormControl

The form field file upload component.

Constructors

@@ -27,221 +28,210 @@ +var allowedFileExtensions: Set<String>? +var allowedFileTypes: Set<String>? +var browseOnZoneClick: Boolean +var dropZoneEnabled: Boolean +var explorerTheme: Boolean +val flabel: FieldLabel +val input: UploadInput +val invalidFeedback: InvalidFeedback +var label: String? +var multiple: Boolean +var preferIconicPreview: Boolean +var required: Boolean +var rich: Boolean +var showBrowse: Boolean +var showCancel: Boolean +var showCaption: Boolean +var showPreview: Boolean +var showRemove: Boolean +var showUpload: Boolean +var uploadExtraData: ((String, Int) -> dynamic)? +var uploadUrl: String? - - -
-

<init>

+(js) +

<init>

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

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.

-
-

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.

-
-

flabel

+(js) +

flabel

 -val flabel: FieldLabel

Form field label.

-
-

idc

+(js) +

idc

 val idc: String
-

input

+(js) +

input

 -val input: UploadInput

The actual input component.

-
-

invalidFeedback

+(js) +

invalidFeedback

 -val invalidFeedback: InvalidFeedback

Invalid feedback component.

-
-

label

+(js) +

label

 -var label: String?

The label text bound to the spinner input element.

-
-

multiple

+(js) +

multiple

 -var multiple: Boolean

Determines if multiple file upload is supported.

-
-

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.

-
-

rich

+(js) +

rich

 -var rich: Boolean

Determines if label can contain HTML code.

-
-

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.

-
-

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.

-
-

value

+(js) +

value

 -open var value: List<KFile>?

File input value.

-
-

Inherited Properties

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

children

-		 -val children: MutableList<Component>
@@ -250,224 +240,129 @@ If not set the upload button action will default to form submission.

-

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

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

Returns the native JavaScript File object.

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

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

-open fun getValueAsString(): String?

Returns the value of the control as a String.

- +open 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 -

removeEventListener

+(js) +

removeEventListener

-open fun removeEventListener(id: Int): Widget

Removes event listener from current widget.

- +open fun removeEventListener(id: Int): Widget -

removeEventListeners

+(js) +

removeEventListeners

-open fun removeEventListeners(): Widget

Removes all event listeners from current widget.

- +open fun removeEventListeners(): Widget -

resetInput

+(js) +

resetInput

-open fun resetInput(): Unit

Resets the file input control.

- +open fun resetInput(): Unit -

setEventListener

+(js) +

setEventListener

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

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

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

unlock

+(js) +

unlock

-open fun unlock(): Unit

Unlocks the file input.

- +open fun unlock(): Unit -

upload

+(js) +

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<KFile>? -

Returns the value of the control.

-
-

remove

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

Removes given component from the current container.

-
-

removeAll

-		 -open fun removeAll(): SimplePane