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/-iframe/-init-.html | 2 +- .../-iframe/get-iframe-window.html | 2 +- .../-iframe/get-sn-attrs.html | 3 +- .../-iframe/iframe-height.html | 2 +- .../-iframe/iframe-width.html | 2 +- api/pl.treksoft.kvision.html/-iframe/index.html | 644 +++------------------ api/pl.treksoft.kvision.html/-iframe/location.html | 2 +- api/pl.treksoft.kvision.html/-iframe/name.html | 2 +- api/pl.treksoft.kvision.html/-iframe/render.html | 3 +- api/pl.treksoft.kvision.html/-iframe/sandbox.html | 2 +- api/pl.treksoft.kvision.html/-iframe/src.html | 2 +- api/pl.treksoft.kvision.html/-iframe/srcdoc.html | 2 +- 12 files changed, 88 insertions(+), 580 deletions(-) (limited to 'api/pl.treksoft.kvision.html/-iframe') diff --git a/api/pl.treksoft.kvision.html/-iframe/-init-.html b/api/pl.treksoft.kvision.html/-iframe/-init-.html index 3823d817..32794289 100644 --- a/api/pl.treksoft.kvision.html/-iframe/-init-.html +++ b/api/pl.treksoft.kvision.html/-iframe/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.html / Iframe / <init>

<init>

- +(js) Iframe(src: String? = null, srcdoc: String? = null, name: String? = null, iframeWidth: Int? = null, iframeHeight: Int? = null, sandbox: Set<Sandbox>? = null, classes: Set<String> = setOf())

Parameters

diff --git a/api/pl.treksoft.kvision.html/-iframe/get-iframe-window.html b/api/pl.treksoft.kvision.html/-iframe/get-iframe-window.html index 41620da2..e0cdbb63 100644 --- a/api/pl.treksoft.kvision.html/-iframe/get-iframe-window.html +++ b/api/pl.treksoft.kvision.html/-iframe/get-iframe-window.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.html / Iframe / getIframeWindow

getIframeWindow

- +(js) open fun getIframeWindow(): Window

Returns content window object of the iframe.

Return
diff --git a/api/pl.treksoft.kvision.html/-iframe/get-sn-attrs.html b/api/pl.treksoft.kvision.html/-iframe/get-sn-attrs.html index 069b02a2..1849fea3 100644 --- a/api/pl.treksoft.kvision.html/-iframe/get-sn-attrs.html +++ b/api/pl.treksoft.kvision.html/-iframe/get-sn-attrs.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.html / Iframe / 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/-iframe/iframe-height.html b/api/pl.treksoft.kvision.html/-iframe/iframe-height.html index a3f72945..f3beb685 100644 --- a/api/pl.treksoft.kvision.html/-iframe/iframe-height.html +++ b/api/pl.treksoft.kvision.html/-iframe/iframe-height.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.html / Iframe / iframeHeight

iframeHeight

- +(js) var iframeHeight: Int?

The height of the iframe.

Getter
diff --git a/api/pl.treksoft.kvision.html/-iframe/iframe-width.html b/api/pl.treksoft.kvision.html/-iframe/iframe-width.html index 046d9634..a20555fa 100644 --- a/api/pl.treksoft.kvision.html/-iframe/iframe-width.html +++ b/api/pl.treksoft.kvision.html/-iframe/iframe-width.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.html / Iframe / iframeWidth

iframeWidth

- +(js) var iframeWidth: Int?

The width of the iframe.

Getter
diff --git a/api/pl.treksoft.kvision.html/-iframe/index.html b/api/pl.treksoft.kvision.html/-iframe/index.html index 77434d18..85badc94 100644 --- a/api/pl.treksoft.kvision.html/-iframe/index.html +++ b/api/pl.treksoft.kvision.html/-iframe/index.html @@ -8,14 +8,15 @@ kvision / pl.treksoft.kvision.html / Iframe

Iframe

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

Iframe component.

Constructors

@@ -27,176 +28,66 @@ +var iframeHeight: Int? +var iframeWidth: Int? +var location: String? +var name: String? +var sandbox: Set<Sandbox>? +var src: String? - - -
-

<init>

+(js) +

<init>

 Iframe(src: String? = null, srcdoc: String? = null, name: String? = null, iframeWidth: Int? = null, iframeHeight: Int? = null, sandbox: Set<Sandbox>? = null, classes: Set<String> = setOf())
-

iframeHeight

+(js) +

iframeHeight

 -var iframeHeight: Int?

The height of the iframe.

-
-

iframeWidth

+(js) +

iframeWidth

 -var iframeWidth: Int?

The width of the iframe.

-
-

location

+(js) +

location

 -var location: String?

A current location URL of the iframe.

-
-

name

+(js) +

name

 -var name: String?

The name of the iframe.

-
-

sandbox

+(js) +

sandbox

 -var sandbox: Set<Sandbox>?

A set of Sandbox options.

-
-

src

+(js) +

src

 -var src: String?

The iframe document address.

-
-

srcdoc

+(js) +

srcdoc

 -var srcdoc: String?

The HTML content of the iframe.

-
-

Inherited Properties

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +var srcdoc: String?
-

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?
@@ -205,417 +96,30 @@ -

getIframeWindow

+(js) +

getIframeWindow

-open fun getIframeWindow(): Window

Returns content window object of the iframe.

- +open fun getIframeWindow(): Window -

getSnAttrs

+(js) +

getSnAttrs

-open fun getSnAttrs(): List<StringPair>

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

- - - - -

render

- - -open fun render(): VNode -

Renders current component as a Snabbdom vnode.

- - - - -

Inherited Functions

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

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.

+(js) +

render

-

getElementJQueryD

-		 -open fun getElementJQueryD(): dynamic -

Returns JQuery element bound to the current component as a dynamic type.

-
-

getSnClass

-		 -open fun getSnClass(): List<StringBoolPair> -

Returns list of CSS class names for current widget in the form of a List.

-
-

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

-		 -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) -> 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): Int -

Sets an event listener for current widget, keeping the actual type of component.

-
-

show

-		 -open fun show(): Widget -

Makes current widget visible.

-
-

showPopover

-		 -open fun showPopover(): Widget -

Shows popover for the current widget.

-
-

showTooltip

-		 -open fun showTooltip(): Widget -

Shows tooltip for the current widget.

-
-

singleRender

-		 -fun <T> singleRender(block: () ->