From fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 26 Oct 2019 00:17:24 +0200 Subject: API documentation for KVision 2.0.0 --- api/alltypes/index.html | 358 +++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 290 insertions(+), 68 deletions(-) (limited to 'api/alltypes') diff --git a/api/alltypes/index.html b/api/alltypes/index.html index e175017a..929c6577 100644 --- a/api/alltypes/index.html +++ b/api/alltypes/index.html @@ -115,9 +115,9 @@ -pl.treksoft.kvision.hmr.ApplicationBase +pl.treksoft.kvision.Application -

Base interface for applications.

+

Base class for KVision applications.

@@ -222,6 +222,13 @@ +pl.treksoft.kvision.html.Bold + +

Simple component rendered as b.

+ + + + pl.treksoft.kvision.form.BoolFormControl

Base interface of a form control with a boolean value.

@@ -280,6 +287,30 @@ +pl.treksoft.kvision.core.BsBgColor + + + + + +pl.treksoft.kvision.core.BsBorder + + + + + +pl.treksoft.kvision.core.BsColor + + + + + +pl.treksoft.kvision.core.BsRounded + + + + + pl.treksoft.kvision.html.Button

Button component.

@@ -301,13 +332,6 @@ -pl.treksoft.kvision.toolbar.ButtonGroupStyle - -

Button group styles.

- - - - pl.treksoft.kvision.html.ButtonSize

Button sizes.

@@ -899,6 +923,13 @@ performance is O(1) and for cache eviction, it is O(1).

+pl.treksoft.kvision.dropdown.Direction + +

Dropdown directions.

+ + + + pl.treksoft.kvision.panel.Direction

Split panel direction.

@@ -942,15 +973,15 @@ performance is O(1) and for cache eviction, it is O(1).

-pl.treksoft.kvision.electron.Display +pl.treksoft.kvision.core.Display +

Definitions of CSS display options.

-pl.treksoft.kvision.core.Display +pl.treksoft.kvision.electron.Display -

Definitions of CSS display options.

@@ -1001,12 +1032,6 @@ performance is O(1) and for cache eviction, it is O(1).

-pl.treksoft.kvision.remote.DummyWebSocketSession - - - - - pl.treksoft.kvision.electron.EditFlags @@ -1113,15 +1138,15 @@ performance is O(1) and for cache eviction, it is O(1).

-pl.treksoft.kvision.cordova.File +org.w3c.files.File (extensions in package pl.treksoft.kvision.utils) -

Main object for Cordova file.

-org.w3c.files.File (extensions in package pl.treksoft.kvision.utils) +pl.treksoft.kvision.cordova.File +

Main object for Cordova file.

@@ -1529,15 +1554,15 @@ performance is O(1) and for cache eviction, it is O(1).

-pl.treksoft.kvision.electron.Header +pl.treksoft.kvision.dropdown.Header +

Menu header component.

-pl.treksoft.kvision.dropdown.Header +pl.treksoft.kvision.electron.Header -

Menu header component.

@@ -1562,14 +1587,14 @@ performance is O(1) and for cache eviction, it is O(1).

-pl.treksoft.kvision.form.HelpBlock +pl.treksoft.kvision.form.HelpText -

Helper class for Bootstrap help block element.

+

Helper class for Bootstrap help text element.

-pl.treksoft.kvision.hmr.Hot +pl.treksoft.kvision.Hot

Helper interface for Hot Module Replacement (HMR).

@@ -1623,6 +1648,12 @@ performance is O(1) and for cache eviction, it is O(1).

+pl.treksoft.kvision.remote.Id + + + + + pl.treksoft.kvision.html.Iframe

Iframe component.

@@ -1745,6 +1776,13 @@ performance is O(1) and for cache eviction, it is O(1).

+pl.treksoft.kvision.form.InvalidFeedback + +

Helper class for Bootstrap invalid feedback element.

+ + + + pl.treksoft.kvision.electron.IOCounters @@ -1781,14 +1819,14 @@ performance is O(1) and for cache eviction, it is O(1).

-pl.treksoft.kvision.remote.JSON +pl.treksoft.kvision.utils.JSON

JSON utility functions

-pl.treksoft.kvision.utils.JSON +pl.treksoft.kvision.remote.JSON

JSON utility functions

@@ -1801,13 +1839,6 @@ performance is O(1) and for cache eviction, it is O(1).

-pl.treksoft.kvision.types.JsonDateSerializer - -

JSON date serializer.

- - - - pl.treksoft.kvision.electron.JumpListCategory @@ -1840,16 +1871,22 @@ performance is O(1) and for cache eviction, it is O(1).

-pl.treksoft.kvision.remote.KVController +pl.treksoft.kvision.utils.KvEvent -

Controller for handling automatic routes.

+

Helper class for defining custom events.

-pl.treksoft.kvision.utils.KvEvent +pl.treksoft.kvision.remote.KVHandler -

Helper class for defining custom events.

+ + + + +pl.treksoft.kvision.KVManager + +

Internal singleton object which initializes and configures KVision framework.

@@ -1861,6 +1898,18 @@ performance is O(1) and for cache eviction, it is O(1).

+pl.treksoft.kvision.remote.KVRouterConfiguration + + + + + +pl.treksoft.kvision.annotations.KVService + + + + + pl.treksoft.kvision.remote.KVServiceManager

Multiplatform service manager.

@@ -1870,14 +1919,12 @@ performance is O(1) and for cache eviction, it is O(1).

pl.treksoft.kvision.remote.KVWebSocketConfig -

Automatic websockets configuration.

-pl.treksoft.kvision.html.Label +pl.treksoft.kvision.remote.KVWebSocketHandler -

Simple label component rendered as span.

@@ -1984,6 +2031,42 @@ performance is O(1) and for cache eviction, it is O(1).

+java.time.LocalDate (extensions in package pl.treksoft.kvision.types) + + + + + +pl.treksoft.kvision.types.LocalDateDeserializer + + + + + +pl.treksoft.kvision.types.LocalDateSerializer + + + + + +java.time.LocalDateTime (extensions in package pl.treksoft.kvision.types) + + + + + +pl.treksoft.kvision.types.LocalDateTimeDeserializer + + + + + +pl.treksoft.kvision.types.LocalDateTimeSerializer + + + + + pl.treksoft.kvision.cordova.LocalFileSystem @@ -1996,6 +2079,24 @@ performance is O(1) and for cache eviction, it is O(1).

+java.time.LocalTime (extensions in package pl.treksoft.kvision.types) + + + + + +pl.treksoft.kvision.types.LocalTimeDeserializer + + + + + +pl.treksoft.kvision.types.LocalTimeSerializer + + + + + pl.treksoft.kvision.cordova.Locationservices

Main geolocation object based on Google location services api.

@@ -2175,7 +2276,7 @@ performance is O(1) and for cache eviction, it is O(1).

-pl.treksoft.kvision.hmr.Module +pl.treksoft.kvision.Module

Helper interface for Hot Module Replacement (HMR).

@@ -2214,6 +2315,20 @@ performance is O(1) and for cache eviction, it is O(1).

+pl.treksoft.kvision.navbar.NavbarColor + +

Navbar colors.

+ + + + +pl.treksoft.kvision.navbar.NavbarExpand + +

Navbar responsive behavior.

+ + + + pl.treksoft.kvision.navbar.NavbarType

Navbar types.

@@ -2292,34 +2407,77 @@ performance is O(1) and for cache eviction, it is O(1).

-pl.treksoft.kvision.remote.Object +pl.treksoft.kvision.utils.Object

JavaScript Object type

-pl.treksoft.kvision.utils.Object +pl.treksoft.kvision.remote.Object

JavaScript Object type

-pl.treksoft.kvision.utils.ObservableList +pl.treksoft.kvision.state.ObservableList

Observable list interface.

-pl.treksoft.kvision.utils.ObservableListWrapper +pl.treksoft.kvision.state.ObservableListWrapper

Simple observable list implementation.

+pl.treksoft.kvision.state.ObservableState + +

An interface of observable state.

+ + + + +java.time.OffsetDateTime (extensions in package pl.treksoft.kvision.types) + + + + + +pl.treksoft.kvision.types.OffsetDateTimeDeserializer + + + + + +pl.treksoft.kvision.types.OffsetDateTimeSerializer + + + + + +java.time.OffsetTime (extensions in package pl.treksoft.kvision.types) + + + + + +pl.treksoft.kvision.types.OffsetTimeDeserializer + + + + + +pl.treksoft.kvision.types.OffsetTimeSerializer + + + + + pl.treksoft.kvision.electron.OnBeforeRedirectDetails @@ -2607,23 +2765,23 @@ performance is O(1) and for cache eviction, it is O(1).

-pl.treksoft.kvision.chart.Position +pl.treksoft.kvision.core.Position -

Chart objects positions.

+

Definitions of CSS position options.

-pl.treksoft.kvision.cordova.Position +pl.treksoft.kvision.chart.Position -

Geolocation position value.

+

Chart objects positions.

-pl.treksoft.kvision.core.Position +pl.treksoft.kvision.cordova.Position -

Definitions of CSS position options.

+

Geolocation position value.

@@ -2957,6 +3115,13 @@ performance is O(1) and for cache eviction, it is O(1).

+pl.treksoft.kvision.table.ResponsiveType + +

HTML table responsive types.

+ + + + pl.treksoft.kvision.core.ResString

This type is used for accessing resources with CommonJS require function.

@@ -3066,6 +3231,12 @@ performance is O(1) and for cache eviction, it is O(1).

+pl.treksoft.kvision.table.Scope + + + + + pl.treksoft.kvision.cordova.Screen

Main object for Cordova screen.

@@ -3119,6 +3290,13 @@ performance is O(1) and for cache eviction, it is O(1).

+pl.treksoft.kvision.form.select.SelectDropdownAlign + +

Select dropdown align. See Bootstrap Select width.

+ + + + pl.treksoft.kvision.form.select.SelectInput

The basic component for Select control.

@@ -3346,9 +3524,9 @@ performance is O(1) and for cache eviction, it is O(1).

-pl.treksoft.kvision.redux.StateBinding +pl.treksoft.kvision.state.StateBinding -

A class which binds the redux store with the given container.

+

A class which binds the given container to the observable state.

@@ -3598,6 +3776,13 @@ performance is O(1) and for cache eviction, it is O(1).

+pl.treksoft.kvision.table.TheadType + +

HTML table header types.

+ + + + pl.treksoft.kvision.electron.ThumbarButton @@ -3651,16 +3836,16 @@ performance is O(1) and for cache eviction, it is O(1).

-pl.treksoft.kvision.chart.TooltipOptions +pl.treksoft.kvision.core.TooltipOptions -

Chart tooltip options.

+

Tooltip options.

-pl.treksoft.kvision.core.TooltipOptions +pl.treksoft.kvision.chart.TooltipOptions -

Tooltip options.

+

Chart tooltip options.

@@ -3804,6 +3989,12 @@ performance is O(1) and for cache eviction, it is O(1).

+pl.treksoft.kvision.remote.Transient + + + + + pl.treksoft.kvision.electron.Tray @@ -3831,9 +4022,9 @@ performance is O(1) and for cache eviction, it is O(1).

-pl.treksoft.kvision.redux.Updateable +pl.treksoft.kvision.state.Updateable -

A helper class for updateable redux content.

+

A helper class for updateable content.

@@ -3888,6 +4079,13 @@ performance is O(1) and for cache eviction, it is O(1).

+pl.treksoft.kvision.form.ValidationStatus + +

Input controls validation status.

+ + + + pl.treksoft.kvision.tabulator.Validator

Built-in validators.

@@ -3952,12 +4150,6 @@ performance is O(1) and for cache eviction, it is O(1).

-pl.treksoft.kvision.remote.WebSocketSessionHolder - - - - - pl.treksoft.kvision.electron.WebSource @@ -4004,6 +4196,36 @@ performance is O(1) and for cache eviction, it is O(1).

+pl.treksoft.kvision.remote.WithPrincipal + + + + + +pl.treksoft.kvision.remote.WithProfile + + + + + +pl.treksoft.kvision.remote.WithRequest + + + + + +pl.treksoft.kvision.remote.WithWebSession + + + + + +pl.treksoft.kvision.remote.WithWebSocketSession + + + + + pl.treksoft.kvision.core.WordBreak

Definitions of CSS word-break options.

-- cgit