From 8883419bfcec00947863741d48dbd89cc877615a Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Thu, 4 Apr 2019 13:10:28 +0200 Subject: API documentation for KVision 0.0.32 --- api/pl.treksoft.kvision.core/-style/-init-.html | 23 + .../-style/add-css-class.html | 30 + .../-style/add-surrounding-css-class.html | 30 + .../-style/class-name.html | 21 + .../-style/get-element-j-query-d.html | 18 + .../-style/get-element-j-query.html | 18 + .../-style/get-element.html | 18 + api/pl.treksoft.kvision.core/-style/index.html | 713 +++++++++++++++++++++ api/pl.treksoft.kvision.core/-style/parent.html | 16 + .../-style/remove-css-class.html | 30 + .../-style/remove-surrounding-css-class.html | 30 + api/pl.treksoft.kvision.core/-style/style.html | 20 + api/pl.treksoft.kvision.core/-style/visible.html | 16 + 13 files changed, 983 insertions(+) create mode 100644 api/pl.treksoft.kvision.core/-style/-init-.html create mode 100644 api/pl.treksoft.kvision.core/-style/add-css-class.html create mode 100644 api/pl.treksoft.kvision.core/-style/add-surrounding-css-class.html create mode 100644 api/pl.treksoft.kvision.core/-style/class-name.html create mode 100644 api/pl.treksoft.kvision.core/-style/get-element-j-query-d.html create mode 100644 api/pl.treksoft.kvision.core/-style/get-element-j-query.html create mode 100644 api/pl.treksoft.kvision.core/-style/get-element.html create mode 100644 api/pl.treksoft.kvision.core/-style/index.html create mode 100644 api/pl.treksoft.kvision.core/-style/parent.html create mode 100644 api/pl.treksoft.kvision.core/-style/remove-css-class.html create mode 100644 api/pl.treksoft.kvision.core/-style/remove-surrounding-css-class.html create mode 100644 api/pl.treksoft.kvision.core/-style/style.html create mode 100644 api/pl.treksoft.kvision.core/-style/visible.html (limited to 'api/pl.treksoft.kvision.core/-style') diff --git a/api/pl.treksoft.kvision.core/-style/-init-.html b/api/pl.treksoft.kvision.core/-style/-init-.html new file mode 100644 index 00000000..83b236d6 --- /dev/null +++ b/api/pl.treksoft.kvision.core/-style/-init-.html @@ -0,0 +1,23 @@ + + + +Style.<init> - kvision + + + +kvision / pl.treksoft.kvision.core / Style / <init>
+
+

<init>

+ +Style(className: String? = null, parentStyle: Style? = null, init: Style.() -> Unit = null) +

Parameters

+className - optional name of the CSS class, it will be generated if not specified

+parentStyle - parent CSS style object

+init - an initializer extension function

Constructor
+

+ + diff --git a/api/pl.treksoft.kvision.core/-style/add-css-class.html b/api/pl.treksoft.kvision.core/-style/add-css-class.html new file mode 100644 index 00000000..e38db41e --- /dev/null +++ b/api/pl.treksoft.kvision.core/-style/add-css-class.html @@ -0,0 +1,30 @@ + + + +Style.addCssClass - kvision + + + +kvision / pl.treksoft.kvision.core / Style / addCssClass
+
+

addCssClass

+ +open fun addCssClass(css: String): Component +

Overrides Component.addCssClass

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

Parameters

+css - CSS class name

Return
+current component

+ +open fun addCssClass(css: Style): Component +

Overrides Component.addCssClass

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

Parameters

+css - CSS style object

Return
+current component

+ + diff --git a/api/pl.treksoft.kvision.core/-style/add-surrounding-css-class.html b/api/pl.treksoft.kvision.core/-style/add-surrounding-css-class.html new file mode 100644 index 00000000..0b827c33 --- /dev/null +++ b/api/pl.treksoft.kvision.core/-style/add-surrounding-css-class.html @@ -0,0 +1,30 @@ + + + +Style.addSurroundingCssClass - kvision + + + +kvision / pl.treksoft.kvision.core / Style / addSurroundingCssClass
+
+

addSurroundingCssClass

+ +open fun addSurroundingCssClass(css: String): Component +

Overrides Component.addSurroundingCssClass

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

Parameters

+css - CSS class name

Return
+current component

+ +open fun addSurroundingCssClass(css: Style): Component +

Overrides Component.addSurroundingCssClass

Adds given style object to the set of CSS classes generated in html code of parent component.

Parameters

+css - CSS style object

Return
+current component

+ + diff --git a/api/pl.treksoft.kvision.core/-style/class-name.html b/api/pl.treksoft.kvision.core/-style/class-name.html new file mode 100644 index 00000000..b2bf419b --- /dev/null +++ b/api/pl.treksoft.kvision.core/-style/class-name.html @@ -0,0 +1,21 @@ + + + +Style.className - kvision + + + +kvision / pl.treksoft.kvision.core / Style / className
+
+

className

+ +var className: String +

The name of the CSS class.

Getter
+

The name of the CSS class.

Setter
+

The name of the CSS class.

+ + diff --git a/api/pl.treksoft.kvision.core/-style/get-element-j-query-d.html b/api/pl.treksoft.kvision.core/-style/get-element-j-query-d.html new file mode 100644 index 00000000..90aa259f --- /dev/null +++ b/api/pl.treksoft.kvision.core/-style/get-element-j-query-d.html @@ -0,0 +1,18 @@ + + + +Style.getElementJQueryD - kvision + + + +kvision / pl.treksoft.kvision.core / Style / getElementJQueryD
+
+

getElementJQueryD

+ +open fun getElementJQueryD(): dynamic +

Overrides Component.getElementJQueryD

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

Return
+JQuery element as a dynamic type

+ + diff --git a/api/pl.treksoft.kvision.core/-style/get-element-j-query.html b/api/pl.treksoft.kvision.core/-style/get-element-j-query.html new file mode 100644 index 00000000..cafeeba8 --- /dev/null +++ b/api/pl.treksoft.kvision.core/-style/get-element-j-query.html @@ -0,0 +1,18 @@ + + + +Style.getElementJQuery - kvision + + + +kvision / pl.treksoft.kvision.core / Style / getElementJQuery
+
+

getElementJQuery

+ +open fun getElementJQuery(): JQuery? +

Overrides Component.getElementJQuery

Returns JQuery element bound to the current component.

Return
+JQuery element

+ + diff --git a/api/pl.treksoft.kvision.core/-style/get-element.html b/api/pl.treksoft.kvision.core/-style/get-element.html new file mode 100644 index 00000000..8ceca345 --- /dev/null +++ b/api/pl.treksoft.kvision.core/-style/get-element.html @@ -0,0 +1,18 @@ + + + +Style.getElement - kvision + + + +kvision / pl.treksoft.kvision.core / Style / getElement
+
+

getElement

+ +open fun getElement(): Node? +

Overrides Component.getElement

Returns DOM element bound to the current component.

Return
+DOM element

+ + diff --git a/api/pl.treksoft.kvision.core/-style/index.html b/api/pl.treksoft.kvision.core/-style/index.html new file mode 100644 index 00000000..c1cd38fe --- /dev/null +++ b/api/pl.treksoft.kvision.core/-style/index.html @@ -0,0 +1,713 @@ + + + +Style - kvision + + + +kvision / pl.treksoft.kvision.core / Style
+
+

Style

+open class Style : StyledComponent +

CSS style object.

Constructors

+ + + + + + + +

<init>

+Style(className: String? = null, parentStyle: Style? = null, init: Style.() -> Unit = null)

Properties

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

+ className +	+`var className: String` + The name of the CSS class. +
+ parent +	+`open var parent: Container?` + Parent of the current component. +
+ visible +	+`open var visible: Boolean` + Visibility state of the current component. +

Inherited Properties

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

+ background +	+`open var background: Background?` + Background of the current component. +
+ border +	+`open var border: Border?` + Border of the current component. +
+ borderBottom +	+`open var borderBottom: Border?` + Bottom border of the current component. +
+ borderLeft +	+`open var borderLeft: Border?` + Left border of the current component. +
+ borderRight +	+`open var borderRight: Border?` + Right border of the current component. +
+ borderTop +	+`open var borderTop: Border?` + Top border of the current component. +
+ bottom +	+`open var bottom: CssSize?` + Bottom edge of the current component. +
+ clear +	+`open var clear: Clear?` + CSS clear float of the current component. +
+ color +	+`open var color: Color?` + Text color for the current component. +
+ colorHex +	+`open var colorHex: Int?` + Text color for the current component given in hex format (write only). +
+ colorName +	+`open var colorName: Col?` + Text color for the current component given with named constant (write only). +
+ display +	+`open var display: Display?` + CSS display of the current component. +
+ float +	+`open var float: PosFloat?` + CSS position float of the current component. +
+ fontFamily +	+`open var fontFamily: String?` + CSS font family of the current component. +
+ fontSize +	+`open var fontSize: CssSize?` + CSS font size of the current component. +
+ fontStyle +	+`open var fontStyle: FontStyle?` + CSS font style of the current component. +
+ fontVariant +	+`open var fontVariant: FontVariant?` + CSS font variant of the current component. +
+ fontWeight +	+`open var fontWeight: FontWeight?` + CSS font weight of the current component. +
+ height +	+`open var height: CssSize?` + Height of the current component. +
+ left +	+`open var left: CssSize?` + Left edge of the current component. +
+ letterSpacing +	+`open var letterSpacing: CssSize?` + CSS Text letter spacing of the current component. +
+ lineBreak +	+`open var lineBreak: LineBreak?` + CSS line break of the current component. +
+ lineHeight +	+`open var lineHeight: CssSize?` + CSS Text line height of the current component. +
+ margin +	+`open var margin: CssSize?` + Margin of the current component. +
+ marginBottom +	+`open var marginBottom: CssSize?` + Bottom margin of the current component. +
+ marginLeft +	+`open var marginLeft: CssSize?` + Left margin of the current component. +
+ marginRight +	+`open var marginRight: CssSize?` + Right margin of the current component. +
+ marginTop +	+`open var marginTop: CssSize?` + Top margin of the current component. +
+ maxHeight +	+`open var maxHeight: CssSize?` + Maximal height of the current component. +
+ maxWidth +	+`open var maxWidth: CssSize?` + Maximal width of the current component. +
+ minHeight +	+`open var minHeight: CssSize?` + Minimal height of the current component. +
+ minWidth +	+`open var minWidth: CssSize?` + Minimal width of the current component. +
+ opacity +	+`open var opacity: Double?` + Opacity of the current component. +
+ overflow +	+`open var overflow: Overflow?` + CSS overflow of the current component. +
+ overflowWrap +	+`open var overflowWrap: OverflowWrap?` + CSS overflow-wrap of the current component. +
+ padding +	+`open var padding: CssSize?` + Padding of the current component. +
+ paddingBottom +	+`open var paddingBottom: CssSize?` + Bottom padding of the current component. +
+ paddingLeft +	+`open var paddingLeft: CssSize?` + Left padding of the current component. +
+ paddingRight +	+`open var paddingRight: CssSize?` + Right padding of the current component. +
+ paddingTop +	+`open var paddingTop: CssSize?` + Top padding of the current component. +
+ position +	+`open var position: Position?` + CSS position of the current component. +
+ resize +	+`open var resize: Resize?` + CSS resize of the current component. +
+ right +	+`open var right: CssSize?` + Right edge of the current component. +
+ textAlign +	+`open var textAlign: TextAlign?` + CSS Text align of the current component. +
+ textDecoration +	+`open var textDecoration: TextDecoration?` + CSS Text decoration of the current component. +
+ textDirection +	+`open var textDirection: Direction?` + CSS Text direction of the current component. +
+ textIndent +	+`open var textIndent: CssSize?` + CSS Text indent of the current component. +
+ textOverflow +	+`open var textOverflow: TextOverflow?` + CSS Text overflow of the current component. +
+ textShadow +	+`open var textShadow: TextShadow?` + CSS Text shadow of the current component. +
+ textTransform +	+`open var textTransform: TextTransform?` + CSS Text transform of the current component. +
+ top +	+`open var top: CssSize?` + Top edge of the current component. +
+ unicodeBidi +	+`open var unicodeBidi: UnicodeBidi?` + CSS Text unicode-bidi of the current component. +
+ verticalAlign +	+`open var verticalAlign: VerticalAlign?` + CSS Text vertical align of the current component. +
+ whiteSpace +	+`open var whiteSpace: WhiteSpace?` + CSS Text white space of the current component. +
+ width +	+`open var width: CssSize?` + Width of the current component. +
+ wordBreak +	+`open var wordBreak: WordBreak?` + CSS word break of the current component. +
+ wordSpacing +	+`open var wordSpacing: CssSize?` + CSS Text word spacing of the current component. +
+ zIndex +	+`open var zIndex: Int?` + Z-index of the current component. +

Functions

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

+ addCssClass +	+`open fun addCssClass(css: String): Component` + Adds given value to the set of CSS classes generated in html code of current component. +`open fun addCssClass(css: Style): Component` + Adds given style object to the set of CSS classes generated in html code of current component. +
+ addSurroundingCssClass +	+`open fun addSurroundingCssClass(css: String): Component` + Adds given value to the set of CSS classes generated in html code of parent component. +`open fun addSurroundingCssClass(css: Style): Component` + Adds given style object to the set of CSS classes generated in html code of parent component. +
+ 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. +
+ removeCssClass +	+`open fun removeCssClass(css: String): Component` + Removes given value from the set of CSS classes generated in html code of current component. +`open fun removeCssClass(css: Style): Component` + Removes given style object from the set of CSS classes generated in html code of current component. +
+ removeSurroundingCssClass +	+`open fun removeSurroundingCssClass(css: String): Component` + Removes given value from the set of CSS classes generated in html code of parent component. +`open fun removeSurroundingCssClass(css: Style): Component` + Removes given style object from the set of CSS classes generated in html code of parent component. +

Inherited Functions

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

+ getSnStyle +	+`open fun getSnStyle(): List<StringPair>` + Returns the list of String pairs defining CSS style attributes and their values. +
+ refreshOnUpdate +	+`fun <T> refreshOnUpdate(refreshFunction: (T) -> Unit = { this.refresh() }): RefreshDelegateProvider<T>` +`fun <T> refreshOnUpdate(initialValue: T, refreshFunction: (T) -> Unit = { this.refresh() }): RefreshDelegateProvider<T>`

Companion Object Functions

+ + + + + + + +

style

+fun Widget.style(className: String? = null, init: Style.() -> Unit = null): Style +

DSL builder extension function.

+fun Style.style(className: String? = null, init: Style.() -> Unit = null): Style +

DSL builder extension function for cascading styles.

Extension Functions

+ + + + + + + +

createInstance

+fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

+ + diff --git a/api/pl.treksoft.kvision.core/-style/parent.html b/api/pl.treksoft.kvision.core/-style/parent.html new file mode 100644 index 00000000..1751ea05 --- /dev/null +++ b/api/pl.treksoft.kvision.core/-style/parent.html @@ -0,0 +1,16 @@ + + + +Style.parent - kvision + + + +kvision / pl.treksoft.kvision.core / Style / parent
+
+

parent

+ +open var parent: Container? +

Overrides Component.parent

Parent of the current component.

+ + diff --git a/api/pl.treksoft.kvision.core/-style/remove-css-class.html b/api/pl.treksoft.kvision.core/-style/remove-css-class.html new file mode 100644 index 00000000..a0b1b166 --- /dev/null +++ b/api/pl.treksoft.kvision.core/-style/remove-css-class.html @@ -0,0 +1,30 @@ + + + +Style.removeCssClass - kvision + + + +kvision / pl.treksoft.kvision.core / Style / removeCssClass
+
+

removeCssClass

+ +open fun removeCssClass(css: String): Component +

Overrides Component.removeCssClass

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

Parameters

+css - CSS class name

Return
+current component

+ +open fun removeCssClass(css: Style): Component +

Overrides Component.removeCssClass

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

Parameters

+css - CSS style object

Return
+current component

+ + diff --git a/api/pl.treksoft.kvision.core/-style/remove-surrounding-css-class.html b/api/pl.treksoft.kvision.core/-style/remove-surrounding-css-class.html new file mode 100644 index 00000000..ce0ff0a8 --- /dev/null +++ b/api/pl.treksoft.kvision.core/-style/remove-surrounding-css-class.html @@ -0,0 +1,30 @@ + + + +Style.removeSurroundingCssClass - kvision + + + +kvision / pl.treksoft.kvision.core / Style / removeSurroundingCssClass
+
+

removeSurroundingCssClass

+ +open fun removeSurroundingCssClass(css: String): Component +

Overrides Component.removeSurroundingCssClass

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

Parameters

+css - CSS class name

Return
+current component

+ +open fun removeSurroundingCssClass(css: Style): Component +

Overrides Component.removeSurroundingCssClass

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

Parameters

+css - CSS style object

Return
+current component

+ + diff --git a/api/pl.treksoft.kvision.core/-style/style.html b/api/pl.treksoft.kvision.core/-style/style.html new file mode 100644 index 00000000..cbc9b123 --- /dev/null +++ b/api/pl.treksoft.kvision.core/-style/style.html @@ -0,0 +1,20 @@ + + + +Style.style - kvision + + + +kvision / pl.treksoft.kvision.core / Style / style
+
+

style

+ +fun Widget.style(className: String? = null, init: Style.() -> Unit = null): Style +

DSL builder extension function.

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

+ +fun Style.style(className: String? = null, init: Style.() -> Unit = null): Style +

DSL builder extension function for cascading styles.

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

+ + diff --git a/api/pl.treksoft.kvision.core/-style/visible.html b/api/pl.treksoft.kvision.core/-style/visible.html new file mode 100644 index 00000000..cd16d42d --- /dev/null +++ b/api/pl.treksoft.kvision.core/-style/visible.html @@ -0,0 +1,16 @@ + + + +Style.visible - kvision + + + +kvision / pl.treksoft.kvision.core / Style / visible
+
+

visible

+ +open var visible: Boolean +

Overrides Component.visible

Visibility state of the current component.

+ + -- cgit