open class UploadInput : Widget, FormInput
The file upload component.
UploadInput(uploadUrl: String? = null, multiple: Boolean = false, classes: Set<String> = setOf()) |
var allowedFileExtensions: Set<String>?
Allowed file extensions. |
|
var allowedFileTypes: Set<String>?
Allowed file types. |
|
var browseOnZoneClick: Boolean
Determines if the click on the preview zone opens file browse window. |
|
open var disabled: Boolean
Determines if the field is disabled. |
|
var dropZoneEnabled: Boolean
Determines if Drag&Drop zone is enabled. |
|
var explorerTheme: Boolean
Determines if the explorer theme is used. |
|
var multiple: Boolean
Determines if multiple file upload is supported. |
|
open var name: String?
The name attribute of the generated HTML input element. |
|
var preferIconicPreview: Boolean
Determines if the iconic preview is prefered. |
|
var required: Boolean
Determines if the input selection is required. |
|
var showBrowse: Boolean
Determines if the file browse button is shown. |
|
var showCancel: Boolean
Determines if the cancel button is shown. |
|
var showCaption: Boolean
Determines if the caption is shown. |
|
var showPreview: Boolean
Determines if the preview is shown. |
|
var showRemove: Boolean
Determines if the remove button is shown. |
|
var showUpload: Boolean
Determines if the upload button is shown. |
|
open var size: InputSize?
The size of the input (currently not working) |
|
var uploadExtraData: ((String, Int) -> dynamic)?
The extra data that will be passed as data to the AJAX server call via POST. |
|
var uploadUrl: String?
The optional URL for the upload processing action. If not set the upload button action will default to form submission. |
|
var value: List<KFile>?
File input value. |
var draggable: Boolean?
Determines if the current widget is draggable. |
|
var eventTarget: Widget? |
|
var id: String?
An ID attribute of generated HTML element. |
|
var lastLanguage: String? |
|
open var parent: Container?
Parent of the current component. |
|
var popoverOptions: PopoverOptions? |
|
var role: String?
A role attribute of generated HTML element. |
|
var surroundingSpan: Boolean |
|
var title: String?
A title attribute of generated HTML element. |
|
var tooltipOptions: TooltipOptions? |
|
open var visible: Boolean
Visibility state of the current component. |
|
var vnode: VNode? |
open fun afterDestroy(): Unit
Method called after destroying Snabbdom vnode. |
|
open fun afterInsert(node: VNode): Unit
Method called after inserting Snabbdom vnode into the DOM. |
|
open fun blur(): Unit
Makes the input element blur. |
|
open fun cancel(): Unit
Cancel an ongoing ajax upload (only for ajax mode). |
|
open fun clearInput(): Unit
Clears the file input control (including the native input). |
|
open fun focus(): Unit
Makes the input element focused. |
|
fun getNativeFile(kFile: KFile): File?
Returns the native JavaScript File object. |
|
open fun getSnAttrs(): List<StringPair>
Returns list of element attributes in the form of a List. |
|
open fun getSnClass(): List<StringBoolPair>
Returns list of CSS class names for current widget in the form of a List. |
|
fun getValueAsString(): String?
Returns the value of the file input control as a String. |
|
open fun lock(): Unit
Locks the file input (disabling all buttons except a cancel button). |
|
open fun render(): VNode
Renders current component as a Snabbdom vnode. |
|
open fun resetInput(): Unit
Resets the file input control. |
|
open fun unlock(): Unit
Unlocks the file input. |
|
open fun upload(): Unit
Trigger ajax upload (only for ajax mode). |
open fun addCssClass(css: String): Widget
Adds given value to the set of CSS classes generated in html code of current component. open fun addCssClass(css: Style): Widget
Adds given style object to the set of CSS classes generated in html code of current component. |
|
open fun addSurroundingCssClass(css: String): Widget
Adds given value to the set of CSS classes generated in html code of parent component. open fun addSurroundingCssClass(css: Style): Widget
Adds given style object to the set of CSS classes generated in html code of parent component. |
|
open fun afterCreate(node: VNode): Unit
Method called after creating Snabbdom vnode. |
|
open fun clearDragDropData(): Unit
Clears D&D data for the current widget. It also makes it not draggable. |
|
open fun disablePopover(): Widget
Disables popover for the current widget. |
|
open fun disableTooltip(): Widget
Disables tooltip for the current widget. |
|
open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean? |
|
open fun enablePopover(options: PopoverOptions = PopoverOptions()): Widget
Enables popover for the current widget. |
|
open fun enableTooltip(options: TooltipOptions = TooltipOptions()): Widget
Enables tooltip for the current widget. |
|
open fun getAttribute(name: String): String?
Returns the value of an additional attribute. |
|
open fun getElement(): Node?
Returns DOM element bound to the current component. |
|
open fun getElementJQuery(): JQuery?
Returns JQuery element bound to the current component. |
|
open fun getElementJQueryD(): dynamic
Returns JQuery element bound to the current component as a dynamic type. |
|
open fun getSnHooks(): Hooks?
Returns list of hooks in the form of a Snabbdom Hooks object. |
|
open fun getSnOn(): On?
Returns list of event handlers in the form of a Snabbdom On object. |
|
open fun hide(): Widget
Makes current widget invisible. |
|
open fun hidePopover(): Widget
Hides popover for the current widget. |
|
open fun hideTooltip(): Widget
Hides tooltip for the current widget. |
|
fun <T> refreshOnUpdate(refreshFunction: (T) -> Unit = { this.refresh() }): Widget.RefreshDelegateProvider<T> fun <T> refreshOnUpdate(initialValue: T, refreshFunction: (T) -> Unit = { this.refresh() }): Widget.RefreshDelegateProvider<T> |
|
open fun removeAttribute(name: String): Widget
Removes the value of additional attribute. |
|
open fun removeCssClass(css: String): Widget
Removes given value from the set of CSS classes generated in html code of current component. open fun removeCssClass(css: Style): Widget
Removes given style object from the set of CSS classes generated in html code of current component. |
|
open fun removeEventListeners(): Widget
Removes all event listeners from current widget. |
|
open fun removeSurroundingCssClass(css: String): Widget
Removes given value from the set of CSS classes generated in html code of parent component. open fun removeSurroundingCssClass(css: Style): Widget
Removes given style object from the set of CSS classes generated in html code of parent component. |
|
open fun render(elementName: String): VNode open fun render(elementName: String, children: Array<dynamic>): VNode
Renders current component as a Snabbdom vnode. |
|
open fun setAttribute(name: String, value: String): Widget
Sets the value of additional attribute. |
|
open fun setContextMenu(contextMenu: ContextMenu): Widget
Sets context menu for the current widget. |
|
open fun setDragDropData(format: String, data: String): Unit
Sets D&D data for the current widget. It also makes it draggable. |
|
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. |
|
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. |
|
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. |
|
open fun show(): Widget
Makes current widget visible. |
|
open fun showPopover(): Widget
Shows popover for the current widget. |
|
open fun showTooltip(): Widget
Shows tooltip for the current widget. |
|
fun <T> singleRender(block: () -> T): T |
|
open fun toggleVisible(): Widget
Toggles visibility of current widget. |
|
fun translate(text: String?): String? |
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. |
|
fun Container.uploadInput(uploadUrl: String? = null, multiple: Boolean = false, classes: Set<String> = setOf(), init: (UploadInput.() -> Unit)? = null): UploadInput
DSL builder extension function. |
fun <T> Any?.createInstance(vararg args: dynamic): T
Helper function for creating JavaScript objects from dynamic constructors. |