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 --- api/pl.treksoft.kvision.html/-button/index.html | 477 ------------------------ 1 file changed, 477 deletions(-) delete mode 100644 api/pl.treksoft.kvision.html/-button/index.html (limited to 'api/pl.treksoft.kvision.html/-button/index.html') diff --git a/api/pl.treksoft.kvision.html/-button/index.html b/api/pl.treksoft.kvision.html/-button/index.html deleted file mode 100644 index 38df4887..00000000 --- a/api/pl.treksoft.kvision.html/-button/index.html +++ /dev/null @@ -1,477 +0,0 @@ - - - -Button - kvision - - - -kvision / pl.treksoft.kvision.html / Button
-
-

Button

-open class Button : Widget -

Button component.

Constructors

- - - - - - - -

<init>

Button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, classes: Set<String> = setOf())

Properties

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

- block -	-`var block: Boolean` - Determines if the button takes all the space horizontally. -
- disabled -	-`var disabled: Boolean` - Determines if button is disabled. -
- icon -	-`var icon: String?` - Button icon. -
- image -	-`var image: ResString?` - Button image. -
- size -	-`var size: ButtonSize?` - Button size. -
- style -	-`var style: ButtonStyle` - Button style. -
- text -	-`var text: String` - Button label. -
- type -	-`var type: ButtonType` - Button types. -

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

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

- 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. -
- onClick -	-`open fun onClick(handler: Button.(MouseEvent) -> Unit): Button` - A convenient helper for easy setting onClick event handler. -
- render -	-`open fun render(): VNode` - Renders current component as a Snabbdom vnode. -

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. -
- 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. -
- 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

- - - - - - - -

button

fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, classes: Set<String> = setOf(), init: Button.() -> Unit = null): Button

DSL builder extension function.

- - -- cgit