From 806edfceeefe7fda47924f97237974e99fe28a02 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 2 Apr 2018 01:35:47 +0200 Subject: API documentantion update --- api/pl.treksoft.kvision.html/-tag/-init-.html | 10 ++-- api/pl.treksoft.kvision.html/-tag/content.html | 22 ++++++++ api/pl.treksoft.kvision.html/-tag/index.html | 73 ++++++++++++++++++++++--- api/pl.treksoft.kvision.html/-tag/rich.html | 9 +-- api/pl.treksoft.kvision.html/-tag/tag.html | 2 +- api/pl.treksoft.kvision.html/-tag/template.html | 22 ++++++++ api/pl.treksoft.kvision.html/-tag/text.html | 21 ------- 7 files changed, 120 insertions(+), 39 deletions(-) create mode 100644 api/pl.treksoft.kvision.html/-tag/content.html create mode 100644 api/pl.treksoft.kvision.html/-tag/template.html delete mode 100644 api/pl.treksoft.kvision.html/-tag/text.html (limited to 'api/pl.treksoft.kvision.html/-tag') diff --git a/api/pl.treksoft.kvision.html/-tag/-init-.html b/api/pl.treksoft.kvision.html/-tag/-init-.html index ca274196..a856589d 100644 --- a/api/pl.treksoft.kvision.html/-tag/-init-.html +++ b/api/pl.treksoft.kvision.html/-tag/-init-.html @@ -9,16 +9,16 @@

<init>

Tag(type: TAG, text: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: Tag.() -> Unit = null)

Tag(type: TAG, content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: Tag.() -> Unit = null)

Parameters

type - tag type

-text - text content of the tag

+content - content text of the tag

-rich - determines if text can contain HTML code

+rich - determines if content can contain HTML code

-align - text align

+align - content align

classes - a set of CSS class names

diff --git a/api/pl.treksoft.kvision.html/-tag/content.html b/api/pl.treksoft.kvision.html/-tag/content.html new file mode 100644 index 00000000..42016db7 --- /dev/null +++ b/api/pl.treksoft.kvision.html/-tag/content.html @@ -0,0 +1,22 @@ + + + +Tag.content - kvision + + + +kvision / pl.treksoft.kvision.html / Tag / content
+
+

content

+ +open var content: String? +

Overrides Template.content

Text content of the tag.

Getter
+

Text content of the tag.

Setter
+

Text content of the tag.

+ + diff --git a/api/pl.treksoft.kvision.html/-tag/index.html b/api/pl.treksoft.kvision.html/-tag/index.html index 035e7552..7667eeac 100644 --- a/api/pl.treksoft.kvision.html/-tag/index.html +++ b/api/pl.treksoft.kvision.html/-tag/index.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.html / Tag

Tag

-open class Tag : SimplePanel +open class Tag : SimplePanel, Template

HTML tag component.

Constructors

@@ -18,7 +18,7 @@

<init>

Tag(type: TAG, content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: Tag.() -> Unit = null)

Tag(type: TAG, text: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: Tag.() -> Unit = null)

@@ -36,20 +36,29 @@ +

content

+ + +open var content: String? +

Text content of the tag.

+ + + +

rich

-var rich: Boolean -

Determines if text can contain HTML code.

+open var rich: Boolean +

Determines if content can contain HTML code.

text

template

-var text: String? -

Text content of the tag.

+open var template: (Any?) -> String +

Handlebars template.

@@ -63,6 +72,18 @@ +

Inherited Properties

+ + + + + + + +

templateData

+open var templateData: Any?

Functions

@@ -162,7 +183,7 @@

tag

@@ -200,6 +221,15 @@ + + + + + + + + + + + + + + + +

-`fun Container.tag(type: TAG, text: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: Tag.() -> Unit = null): Tag` +`fun Container.tag(type: TAG, content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: Tag.() -> Unit = null): Tag` DSL builder extension function.
+ Header +	+`open class Header : Tag` + Menu header component. +
HeaderCell	@@ -236,6 +266,24 @@
+ Nav +	+`open class Nav : Tag` + The Bootstrap Nav container. +
+ NavForm +	+`open class NavForm : Tag` + The Bootstrap Nav form container. +
Row	@@ -243,6 +291,15 @@ HTML table row component.
+ Separator +	+`open class Separator : Tag` + Menu separator component. +

diff --git a/api/pl.treksoft.kvision.html/-tag/rich.html b/api/pl.treksoft.kvision.html/-tag/rich.html index c8976ade..b2e2d550 100644 --- a/api/pl.treksoft.kvision.html/-tag/rich.html +++ b/api/pl.treksoft.kvision.html/-tag/rich.html @@ -9,13 +9,14 @@

rich

-var rich: Boolean -

Determines if text can contain HTML code.

+open var rich: Boolean +

Overrides Template.rich

Determines if content can contain HTML code.

Getter
-

Determines if text can contain HTML code.

Determines if content can contain HTML code.

Setter
-

Determines if text can contain HTML code.

Determines if content can contain HTML code.

diff --git a/api/pl.treksoft.kvision.html/-tag/tag.html b/api/pl.treksoft.kvision.html/-tag/tag.html index 62f92230..9a3bcfc1 100644 --- a/api/pl.treksoft.kvision.html/-tag/tag.html +++ b/api/pl.treksoft.kvision.html/-tag/tag.html @@ -9,7 +9,7 @@

tag

fun Container.tag(type: TAG, text: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: Tag.() -> Unit = null): Tag

fun Container.tag(type: TAG, content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: Tag.() -> Unit = null): Tag

DSL builder extension function.

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

diff --git a/api/pl.treksoft.kvision.html/-tag/template.html b/api/pl.treksoft.kvision.html/-tag/template.html new file mode 100644 index 00000000..2e6e5dbd --- /dev/null +++ b/api/pl.treksoft.kvision.html/-tag/template.html @@ -0,0 +1,22 @@ + + + +Tag.template - kvision + + + +kvision / pl.treksoft.kvision.html / Tag / template
+
+

template

+ +open var template: (Any?) -> String +

Overrides Template.template

Handlebars template.

Getter
+

Handlebars template.

Setter
+

Handlebars template.

+ + diff --git a/api/pl.treksoft.kvision.html/-tag/text.html b/api/pl.treksoft.kvision.html/-tag/text.html deleted file mode 100644 index aca1a8d2..00000000 --- a/api/pl.treksoft.kvision.html/-tag/text.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -Tag.text - kvision - - - -kvision / pl.treksoft.kvision.html / Tag / text
-
-

text

- -var text: String? -

Text content of the tag.

Getter
-

Text content of the tag.

Setter
-

Text content of the tag.

- - -- cgit