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 + 37 files changed, 1305 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 (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 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>?