From 7c2850063697f94a0d8b8d8f8588136dd4b3d05e Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 21 Oct 2018 23:59:34 +0200 Subject: API documentation for KVision 0.0.19 --- .../-upload-input/index.html | 677 --------------------- 1 file changed, 677 deletions(-) delete mode 100644 api/pl.treksoft.kvision.form.upload/-upload-input/index.html (limited to 'api/pl.treksoft.kvision.form.upload/-upload-input/index.html') diff --git a/api/pl.treksoft.kvision.form.upload/-upload-input/index.html b/api/pl.treksoft.kvision.form.upload/-upload-input/index.html deleted file mode 100644 index 8d0d91c4..00000000 --- a/api/pl.treksoft.kvision.form.upload/-upload-input/index.html +++ /dev/null @@ -1,677 +0,0 @@ - - - -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<KFile>?` - File input value. -

Inherited Properties

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- 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. -
- role -	-`var role: String?` - A role attribute of generated HTML element. -
- surroundingSpan -	-`var surroundingSpan: Boolean`
- 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. -
- getNativeFile -	-`fun getNativeFile(kFile: KFile): File?` - Returns the native JavaScript File object. -
- 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. -
- dispatchEvent -	-`open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?`
- 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. -
- translate -	-`fun translate(text: String?): String?`

Companion Object Functions

- - - - - - - - - - - -

- getContent -	-`suspend fun <K : Any> Form<K>.getContent(key: KProperty1<K, List<KFile>?>, kFile: KFile): KFile` -`suspend fun <K : Any> FormPanel<K>.getContent(key: KProperty1<K, List<KFile>?>, kFile: KFile): KFile` - Returns file with the content read. -
- uploadInput -	-`fun Container.uploadInput(uploadUrl: String? = null, multiple: Boolean = false, classes: Set<String> = setOf(), init: UploadInput.() -> Unit = null): UploadInput` - DSL builder extension function. -

- - -- cgit