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 --- api/pl.treksoft.kvision.html/-button/-init-.html | 2 +- api/pl.treksoft.kvision.html/-button/block.html | 2 +- api/pl.treksoft.kvision.html/-button/blur.html | 2 +- api/pl.treksoft.kvision.html/-button/disabled.html | 2 +- api/pl.treksoft.kvision.html/-button/focus.html | 2 +- .../-button/get-sn-attrs.html | 3 +- .../-button/get-sn-class.html | 3 +- api/pl.treksoft.kvision.html/-button/icon.html | 2 +- api/pl.treksoft.kvision.html/-button/image.html | 2 +- api/pl.treksoft.kvision.html/-button/index.html | 659 +++------------------ api/pl.treksoft.kvision.html/-button/on-click.html | 2 +- api/pl.treksoft.kvision.html/-button/render.html | 3 +- api/pl.treksoft.kvision.html/-button/size.html | 2 +- api/pl.treksoft.kvision.html/-button/style.html | 2 +- api/pl.treksoft.kvision.html/-button/text.html | 2 +- api/pl.treksoft.kvision.html/-button/type.html | 2 +- 16 files changed, 104 insertions(+), 588 deletions(-) (limited to 'api/pl.treksoft.kvision.html/-button') diff --git a/api/pl.treksoft.kvision.html/-button/-init-.html b/api/pl.treksoft.kvision.html/-button/-init-.html index 75f56b28..2ccbb29a 100644 --- a/api/pl.treksoft.kvision.html/-button/-init-.html +++ b/api/pl.treksoft.kvision.html/-button/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.html / Button / <init>

<init>

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

Parameters

diff --git a/api/pl.treksoft.kvision.html/-button/block.html b/api/pl.treksoft.kvision.html/-button/block.html index dab9f6c3..3747f338 100644 --- a/api/pl.treksoft.kvision.html/-button/block.html +++ b/api/pl.treksoft.kvision.html/-button/block.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.html / Button / block

block

- +(js) var block: Boolean

Determines if the button takes all the space horizontally.

Getter
diff --git a/api/pl.treksoft.kvision.html/-button/blur.html b/api/pl.treksoft.kvision.html/-button/blur.html index 95055a18..1b313260 100644 --- a/api/pl.treksoft.kvision.html/-button/blur.html +++ b/api/pl.treksoft.kvision.html/-button/blur.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.html / Button / blur

blur

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

Makes the button blur.

diff --git a/api/pl.treksoft.kvision.html/-button/disabled.html b/api/pl.treksoft.kvision.html/-button/disabled.html index 6f924849..e934595f 100644 --- a/api/pl.treksoft.kvision.html/-button/disabled.html +++ b/api/pl.treksoft.kvision.html/-button/disabled.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.html / Button / disabled

disabled

- +(js) var disabled: Boolean

Determines if button is disabled.

Getter
diff --git a/api/pl.treksoft.kvision.html/-button/focus.html b/api/pl.treksoft.kvision.html/-button/focus.html index 80ae465d..cd9621bc 100644 --- a/api/pl.treksoft.kvision.html/-button/focus.html +++ b/api/pl.treksoft.kvision.html/-button/focus.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.html / Button / focus

focus

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

Makes the button focused.

diff --git a/api/pl.treksoft.kvision.html/-button/get-sn-attrs.html b/api/pl.treksoft.kvision.html/-button/get-sn-attrs.html index 0c2ad719..c462bae4 100644 --- a/api/pl.treksoft.kvision.html/-button/get-sn-attrs.html +++ b/api/pl.treksoft.kvision.html/-button/get-sn-attrs.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.html / Button / getSnAttrs

getSnAttrs

- +(js) 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.html/-button/get-sn-class.html b/api/pl.treksoft.kvision.html/-button/get-sn-class.html index b5d8f779..c9d7e47b 100644 --- a/api/pl.treksoft.kvision.html/-button/get-sn-class.html +++ b/api/pl.treksoft.kvision.html/-button/get-sn-class.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.html / Button / 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.html/-button/icon.html b/api/pl.treksoft.kvision.html/-button/icon.html index 12fe9900..39296351 100644 --- a/api/pl.treksoft.kvision.html/-button/icon.html +++ b/api/pl.treksoft.kvision.html/-button/icon.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.html / Button / icon

icon

- +(js) var icon: String?

Button icon.

Getter
diff --git a/api/pl.treksoft.kvision.html/-button/image.html b/api/pl.treksoft.kvision.html/-button/image.html index cdd1a4f2..d090ac3b 100644 --- a/api/pl.treksoft.kvision.html/-button/image.html +++ b/api/pl.treksoft.kvision.html/-button/image.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.html / Button / image

image

- +(js) var image: ResString?

Button image.

Getter
diff --git a/api/pl.treksoft.kvision.html/-button/index.html b/api/pl.treksoft.kvision.html/-button/index.html index a8f5f87a..6c8e491f 100644 --- a/api/pl.treksoft.kvision.html/-button/index.html +++ b/api/pl.treksoft.kvision.html/-button/index.html @@ -8,14 +8,15 @@ kvision / pl.treksoft.kvision.html / Button

Button

-open class Button : Widget +(js) open class Button : Widget

Button component.

Constructors

@@ -27,185 +28,75 @@ +var block: Boolean +var disabled: Boolean +var icon: String? +var image: ResString? +var size: ButtonSize? +var style: ButtonStyle +var text: String - - -
-

<init>

+(js) +

<init>

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

block

+(js) +

block

 -var block: Boolean

Determines if the button takes all the space horizontally.

-
-

disabled

+(js) +

disabled

 -var disabled: Boolean

Determines if button is disabled.

-
-

icon

+(js) +

icon

 -var icon: String?

Button icon.

-
-

image

+(js) +

image

 -var image: ResString?

Button image.

-
-

size

+(js) +

size

 -var size: ButtonSize?

Button size.

-
-

style

+(js) +

style

 -var style: ButtonStyle

Button style.

-
-

text

+(js) +

text

 -var text: String

Button label.

-
-

type

+(js) +

type

 -var type: ButtonType

Button types.

-
-

Inherited Properties

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +var type: ButtonType
-

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.

-
-

popoverOptions

-		 -var popoverOptions: PopoverOptions?
-

role

-		 -var role: String? -

A role attribute of generated HTML element.

-
-

surroundingSpan

-		 -var surroundingSpan: Boolean
-

tabindex

-		 -var tabindex: Int? -

A tabindex attribute of generated HTML element.

-
-

title

-		 -var title: String? -

A title attribute of generated HTML element.

-
-

tooltipOptions

-		 -var tooltipOptions: TooltipOptions?
-

visible

-		 -open var visible: Boolean -

Visibility state of the current component.

-
-

vnode

-		 -var vnode: VNode?
@@ -214,435 +105,57 @@ -

blur

+(js) +

blur

-open fun blur(): Unit

Makes the button blur.

- +open fun blur(): Unit -

focus

+(js) +

focus

-open fun focus(): Unit

Makes the button focused.

- +open fun focus(): Unit -

getSnAttrs

+(js) +

getSnAttrs

-open fun getSnAttrs(): List<StringPair>

Returns list of element attributes in the form of a List.

- +open fun getSnAttrs(): List<StringPair> -

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

onClick

+(js) +

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

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +open fun onClick(handler: Button.(MouseEvent) -> Unit): Button - - - - - - - - - - - -
-

addCssClass

-		 -open fun addCssClass(css: String): Widget -

Adds given value to the set of CSS classes generated in html code of current component.

-
-

addCssStyle

-		 -open fun addCssStyle(css: Style): Widget -

Adds given style object 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.

-
-

addSurroundingCssStyle

-		 -open fun addSurroundingCssStyle(css: Style): Widget -

Adds given style object 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.

-
-

clearDragDropData

-		 -open fun clearDragDropData(): Unit -

Clears D&D data for the current widget. It also makes it not draggable.

-
-

disablePopover

-		 -open fun disablePopover(): Widget -

Disables popover for the current widget.

-
-

disableTooltip

-		 -open fun disableTooltip(): Widget -

Disables tooltip for the current widget.

-
-

dispatchEvent

-		 -open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?
-

enablePopover

-		 -open fun enablePopover(options: PopoverOptions = PopoverOptions()): Widget -

Enables popover for the current widget.

-
-

enableTooltip

-		 -open fun enableTooltip(options: TooltipOptions = TooltipOptions()): Widget -

Enables tooltip for the current widget.

-
-

getAttribute

-		 -open fun getAttribute(name: String): String? -

Returns the value of an additional attribute.

-
-

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.

-
-

hidePopover

-		 -open fun hidePopover(): Widget -

Hides popover for the current widget.

-
-

hideTooltip

-		 -open fun hideTooltip(): Widget -

Hides tooltip for the current widget.

-
-

refreshOnUpdate

-		 -fun <T> refreshOnUpdate(refreshFunction: (T) -> Unit = { this.refresh() }): Widget.RefreshDelegateProvider<T>
-fun <T> refreshOnUpdate(initialValue: T, refreshFunction: (T) -> Unit = { this.refresh() }): Widget.RefreshDelegateProvider<T>
-

removeAttribute

-		 -open fun removeAttribute(name: String): Widget -

Removes the value of additional attribute.

-
-

removeCssClass

-		 -open fun removeCssClass(css: String): Widget -

Removes given value from the set of CSS classes generated in html code of current component.

-
-

removeCssStyle

-		 -open fun removeCssStyle(css: Style): Widget -

Removes given style object from the set of CSS classes generated in html code of current component.

-
-

removeEventListener

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

Removes event listener from current widget.

-
-

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.

-
-

removeSurroundingCssStyle

-		 -open fun removeSurroundingCssStyle(css: Style): Widget -

Removes given style object from the set of CSS classes generated in html code of parent component.

-
-

render

+(js) +

render

 -open fun render(elementName: String): VNode
-open fun render(elementName: String, children: Array<dynamic>): VNode

Renders current component as a Snabbdom vnode.

-
-

setAttribute

-		 -open fun setAttribute(name: String, value: String): Widget -

Sets the value of additional attribute.

-
-

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) -> U