From eb930482e9972a21d39f2aea8b813acf58ff5b64 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 22 Oct 2018 00:01:39 +0200 Subject: API documentation for KVision 0.0.19 --- api/pl.treksoft.kvision.html/-image/-init-.html | 29 ++ api/pl.treksoft.kvision.html/-image/alt.html | 21 + api/pl.treksoft.kvision.html/-image/centered.html | 21 + .../-image/get-sn-attrs.html | 18 + .../-image/get-sn-class.html | 18 + api/pl.treksoft.kvision.html/-image/image.html | 16 + api/pl.treksoft.kvision.html/-image/index.html | 441 +++++++++++++++++++++ api/pl.treksoft.kvision.html/-image/render.html | 18 + .../-image/responsive.html | 21 + api/pl.treksoft.kvision.html/-image/shape.html | 21 + api/pl.treksoft.kvision.html/-image/src.html | 21 + 11 files changed, 645 insertions(+) create mode 100644 api/pl.treksoft.kvision.html/-image/-init-.html create mode 100644 api/pl.treksoft.kvision.html/-image/alt.html create mode 100644 api/pl.treksoft.kvision.html/-image/centered.html create mode 100644 api/pl.treksoft.kvision.html/-image/get-sn-attrs.html create mode 100644 api/pl.treksoft.kvision.html/-image/get-sn-class.html create mode 100644 api/pl.treksoft.kvision.html/-image/image.html create mode 100644 api/pl.treksoft.kvision.html/-image/index.html create mode 100644 api/pl.treksoft.kvision.html/-image/render.html create mode 100644 api/pl.treksoft.kvision.html/-image/responsive.html create mode 100644 api/pl.treksoft.kvision.html/-image/shape.html create mode 100644 api/pl.treksoft.kvision.html/-image/src.html (limited to 'api/pl.treksoft.kvision.html/-image') diff --git a/api/pl.treksoft.kvision.html/-image/-init-.html b/api/pl.treksoft.kvision.html/-image/-init-.html new file mode 100644 index 00000000..b0677b33 --- /dev/null +++ b/api/pl.treksoft.kvision.html/-image/-init-.html @@ -0,0 +1,29 @@ + + + +Image.<init> - kvision + + + +kvision / pl.treksoft.kvision.html / Image / <init>
+
+

<init>

+ +

Image(src: ResString, alt: String? = null, responsive: Boolean = false, shape: ImageShape? = null, centered: Boolean = false, classes: Set<String> = setOf())

Parameters

+src - image URL

+alt - alternative text

+responsive - determines if the image is rendered as responsive

+shape - image shape

+centered - determines if the image is rendered centered

+classes - a set of CSS class names

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.html/-image/alt.html b/api/pl.treksoft.kvision.html/-image/alt.html new file mode 100644 index 00000000..3714f0e8 --- /dev/null +++ b/api/pl.treksoft.kvision.html/-image/alt.html @@ -0,0 +1,21 @@ + + + +Image.alt - kvision + + + +kvision / pl.treksoft.kvision.html / Image / alt
+
+

alt

+ +var alt: String? +

The alternative text of the image.

Getter
+

The alternative text of the image.

Setter
+

The alternative text of the image.

+ + diff --git a/api/pl.treksoft.kvision.html/-image/centered.html b/api/pl.treksoft.kvision.html/-image/centered.html new file mode 100644 index 00000000..1c0a1eeb --- /dev/null +++ b/api/pl.treksoft.kvision.html/-image/centered.html @@ -0,0 +1,21 @@ + + + +Image.centered - kvision + + + +kvision / pl.treksoft.kvision.html / Image / centered
+
+

centered

+ +var centered: Boolean +

Determines if the image is rendered as centered.

Getter
+

Determines if the image is rendered as centered.

Setter
+

Determines if the image is rendered as centered.

+ + diff --git a/api/pl.treksoft.kvision.html/-image/get-sn-attrs.html b/api/pl.treksoft.kvision.html/-image/get-sn-attrs.html new file mode 100644 index 00000000..7867afee --- /dev/null +++ b/api/pl.treksoft.kvision.html/-image/get-sn-attrs.html @@ -0,0 +1,18 @@ + + + +Image.getSnAttrs - kvision + + + +kvision / pl.treksoft.kvision.html / Image / getSnAttrs
+
+

getSnAttrs

+ +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/-image/get-sn-class.html b/api/pl.treksoft.kvision.html/-image/get-sn-class.html new file mode 100644 index 00000000..862a60e6 --- /dev/null +++ b/api/pl.treksoft.kvision.html/-image/get-sn-class.html @@ -0,0 +1,18 @@ + + + +Image.getSnClass - kvision + + + +kvision / pl.treksoft.kvision.html / Image / getSnClass
+
+

getSnClass

+ +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/-image/image.html b/api/pl.treksoft.kvision.html/-image/image.html new file mode 100644 index 00000000..036314a9 --- /dev/null +++ b/api/pl.treksoft.kvision.html/-image/image.html @@ -0,0 +1,16 @@ + + + +Image.image - kvision + + + +kvision / pl.treksoft.kvision.html / Image / image
+
+

image

+ +

fun Container.image(src: ResString, alt: String? = null, responsive: Boolean = false, shape: ImageShape? = null, centered: Boolean = false, classes: Set<String> = setOf(), init: Image.() -> Unit = null): Image

DSL builder extension function.

It takes the same parameters as the constructor of the built component.

+ + diff --git a/api/pl.treksoft.kvision.html/-image/index.html b/api/pl.treksoft.kvision.html/-image/index.html new file mode 100644 index 00000000..ba1ee2ac --- /dev/null +++ b/api/pl.treksoft.kvision.html/-image/index.html @@ -0,0 +1,441 @@ + + + +Image - kvision + + + +kvision / pl.treksoft.kvision.html / Image
+
+

Image

+open class Image : Widget +

Image component.

Constructors

+ + + + + + + +

<init>

Image(src: ResString, alt: String? = null, responsive: Boolean = false, shape: ImageShape? = null, centered: Boolean = false, classes: Set<String> = setOf())

Properties

+ + + + + + + + + + + + + + + + + + + + + + + +

+ alt +	+`var alt: String?` + The alternative text of the image. +
+ centered +	+`var centered: Boolean` + Determines if the image is rendered as centered. +
+ responsive +	+`var responsive: Boolean` + Determines if the image is rendered as responsive. +
+ shape +	+`var shape: ImageShape?` + The shape of the image. +
+ src +	+`var src: ResString` + URL of the image. +

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

+ + + + + + + +

image

fun Container.image(src: ResString, alt: String? = null, responsive: Boolean = false, shape: ImageShape? = null, centered: Boolean = false, classes: Set<String> = setOf(), init: Image.() -> Unit = null): Image

DSL builder extension function.

+ + diff --git a/api/pl.treksoft.kvision.html/-image/render.html b/api/pl.treksoft.kvision.html/-image/render.html new file mode 100644 index 00000000..70b1bb90 --- /dev/null +++ b/api/pl.treksoft.kvision.html/-image/render.html @@ -0,0 +1,18 @@ + + + +Image.render - kvision + + + +kvision / pl.treksoft.kvision.html / Image / render
+
+

render

+ +protected open fun render(): VNode +

Overrides Widget.render

Renders current component as a Snabbdom vnode.

Return
+Snabbdom vnode

+ + diff --git a/api/pl.treksoft.kvision.html/-image/responsive.html b/api/pl.treksoft.kvision.html/-image/responsive.html new file mode 100644 index 00000000..20d3b977 --- /dev/null +++ b/api/pl.treksoft.kvision.html/-image/responsive.html @@ -0,0 +1,21 @@ + + + +Image.responsive - kvision + + + +kvision / pl.treksoft.kvision.html / Image / responsive
+
+

responsive

+ +var responsive: Boolean +

Determines if the image is rendered as responsive.

Getter
+

Determines if the image is rendered as responsive.

Setter
+

Determines if the image is rendered as responsive.

+ + diff --git a/api/pl.treksoft.kvision.html/-image/shape.html b/api/pl.treksoft.kvision.html/-image/shape.html new file mode 100644 index 00000000..2c23cb61 --- /dev/null +++ b/api/pl.treksoft.kvision.html/-image/shape.html @@ -0,0 +1,21 @@ + + + +Image.shape - kvision + + + +kvision / pl.treksoft.kvision.html / Image / shape
+
+

shape

+ +var shape: ImageShape? +

The shape of the image.

Getter
+

The shape of the image.

Setter
+

The shape of the image.

+ + diff --git a/api/pl.treksoft.kvision.html/-image/src.html b/api/pl.treksoft.kvision.html/-image/src.html new file mode 100644 index 00000000..c78b41b6 --- /dev/null +++ b/api/pl.treksoft.kvision.html/-image/src.html @@ -0,0 +1,21 @@ + + + +Image.src - kvision + + + +kvision / pl.treksoft.kvision.html / Image / src
+
+

src

+ +var src: ResString +

URL of the image.

Getter
+

URL of the image.

Setter
+

URL of the image.

+ + -- cgit