LSPS documentation logo
LSPS Documentation
Data Types

Charts

PolarChart extends Chart

Polar chart.

series : { : List<DataSeries>}

A set of data series displayed by polar chart. It is recalculated on each refresh.

xAxes : List<ChartAxis>

A list of x axes determining angles of data points.

yAxes : List<ChartAxis>

A list of y axes determining the distance of data points from the chart center.

CartesianChart extends Chart

Cartesian chart.

series : { : List<DataSeries>}

A set of data series displayed by cartesian chart. It is recalculated on each refresh.

xAxes : List<ChartAxis>

A list of x axes.

yAxes : List<ChartAxis>

A list of y axes.

rotateAxes : Boolean

If true, the x axes are displayed vertically and y axes are displayed horizontally. If false or unspecified, the x axes are displayed horizontally and y axes are displayed vertically.

PieChart extends Chart

Pie chart.

slices : { : List<PieSlice>}

A set of slices displayed by pie chart. It is recalculated on each refresh.

GaugeChart extends Chart

Gauge chart.

value : { : Decimal}

A value to be displayed by gauge needle. It is recalculated on each refresh.

valueName : String

A value to be displayed as a tooltip when the mouse hovers over the gauge needle.

axis : GaugeAxis

Gauge axis. If not specified, the gauge displays default axis.

PlotOptionsABSTRACT

Options used to determine how the data are displayed in chart.

color : String

Main color of the series (hex format, e.g. "#ff0000"). The default value is pulled from the VaadinTheme colors.

showLabels : Boolean

Controls visibility of labels.

ChartABSTRACT extends ui::UIComponent

An abstract UI component representing any type of chart.

title : { : String}

The chart's main title. It is recalculated on each refresh.

subtitle : { : String}

The chart's subtitle. It is recalculated on each refresh.

showLegend : Boolean

If true or unspecified, the chart legend is displayed. If false the chart legend is hidden. The chart legend is a box containing a symbol and name for each data series.

ListDataSeries extends DataSeries

A series consisting of a list of numerical values. Numerical values (DataPoint.value) will be interpreted as Y values, and X values will be automatically calculated

values : List<DataPoint>

The list of values.

DataSeriesABSTRACT

Abstract type for all specific data series types. Data series defines a set of data points that are displayed as values in the chart.

label : String

Label of the data serie.

options : PlotOptions

PlotOptions specifies how the data serie will be drawn (color, legend, linestyle, etc.).

xAxisIndex : Decimal

0-based index of X axis to use for plotting (CartesianChart.xAxes[?]).

yAxisIndex : Decimal

0-based index of Y axis to use for plotting (CartesianChart.yAxes[?]).

CategoryDataSeries extends DataSeries

Values are defined as a map of Strings and DataPoints: the String is used as the value on the x axis and the data point defines the values on the y axis.

values : Map<String, DataPoint>

The map of values.

TimedDataSeries extends DataSeries

Values are defined as a map of Dates and DataPoints: the date is used as the value on the x axis and the data point defines the values on the y axis.

values : Map<Date, DataPoint>

The map of values.

DecimalDataSeries extends DataSeries

Values are defined as a map of Decimals and DataPoints: the decimal is used as the value on the x axis and the data point defines the values on the y axis.

values : Map<Decimal, DataPoint>

The map of values.

DataPoint

Data point for chart.

value : Decimal

Usually x coordinate of data point.

value2 : Decimal

Value2 is used, e.g., if PlotOptionsBubble is used to determine diameter of bubble.

payload : Object

Business object which is sent in ChartClickEvent when user clicks bar\pie representing this DataPoint.

PieSlice

Specification of the appearance of a pie chart slice.

label : String

Label of the slice.

value : Decimal

Determines portion of the slice.

color : String

Color of the slice. If null, the default color is used.

payload : Object

Business object which is sent in ChartClickEvent when user clicks pie representing this PieSlice.

GaugeAxis extends ChartAxis

Record used to specifyan axis for gauge chart.

startAngle : Decimal

Start angle of the polar X-axis or gauge axis, given in degrees where 0 is north. Defaults to 0.

endAngle : Decimal

End angle of the polar X-axis or gauge value axis, given in degrees where 0 is north. Defaults to startAngle + 360.

centerY : Decimal

Center of a polar chart or angular gauge. Positions is given as percentages of the plot area size. Defaults to ['50', '50'].

ChartAxis

Record used to specify chart axes.

min : Object

The minimum value of the axis.

max : Object

The maximum value of the axis.

label : String

Label of the axis.

opposite : Boolean

Whether the axis is shown on the opposite side of the normal.

bands : List<PlotBand>

Bands of the axis. A plot band is a colored band stretching across the plot area marking an interval on the axis.

PlotBand

Record used to specify a band. A plot band is a colored band stretching across the plot area marking an interval on the axis.

from : Decimal

Start of the band.

to : Decimal

End of the band.

color : String

Color of the band.

PlotOptionsBubble extends PlotOptions

Data series will be displayed as bubbles.

PlotOptionsArea extends PlotOptionsLine

The data series will be displayed as area. Used data points should specify also value2.

range : Boolean

Render only difference between DataPoint.value and DataPoint.value2.

opacity : Decimal

Fill opacity for the area. Defaults to .75.

PlotOptionsBar extends PlotOptions

The data series will be displayed as bars.

range : Boolean

Render only difference between DataPoint.value and DataPoint.value2.

stacked : Boolean

Controls whether to stack the values of each series on top of each other.

PlotOptionsLine extends PlotOptionsScatter

The data series will be displayed as line.

lineStyle : LineStyle

The line style (LineStyle.solid, LineStyle.dot, ...).

lineWidth : Decimal

With of the line in pixels. Defaults to 2.

spline : Boolean

Controls whether to render as spline.

PlotOptionsScatter extends PlotOptions

The data series will be displayed as a scatter chart - a series of unconnected data points.

stacked : Boolean

Controls whether to stack the values of each series on top of each other.

marker : Marker

The tipe of the marker (Marker.circle, Marker.square, ...).

Marker

Marker shape used for data points

circle
square
diamond
triangle
triangle-down
LineStyle

Line style used for drawing line-based charts

solid
dot
dash
dashDot
dashDotDot

Components

UIComponentABSTRACT extends human::UIDefinition

Base type for UI components.

listeners : Set<Listener>

Set of listeners registered on this component which listens for events emitted be this component.

hints : { : Map<String, Object>}

Hints to be applied to this component. Recomputed on each refresh. Predefined hints are available in ui/ui.hint.

modelingId : String

Unique identifier of the modeling element. Used in various log statements. It is possible to search by modeling id. To enable modelingId in generated html pages, use -Dcom.whitestein.lsps.vaadin.ui.debug=true jvm property.

excludeValidationError : {ValidationError : Boolean}

Allows to declaratively specify, which validation errors cannot be shown on this component.

includeValidationError : {ValidationError : Boolean}

Allows to declaratively specify, which validation errors must be shown on this component.

contextMenuStatic : List<MenuItem>

Lists menu items which should be displayed as a context menu when the component is mouse-right-clicked. May be null.

contextMenuDynamic : { : List<MenuItem>}

Lists menu items which should be displayed as a context menu when the component is mouse-right-clicked. May be null. Re-computed on each right-click.

visible : { : Boolean}

Controls the visibility of the component. The component is visible unless this closure is not null and returns false.

Container extends UIComponent

Record type which is used to "wrap" reusable component and define its interface.

registrationPoints : Map<String, Set<Reference<Set<Listener>>>>

Map, through which listener from "outside" can be registered on component within this reusable component.

publishedListeners : Map<String, Set<Listener>>

Map holding listeners, which are defined withing this reusable component and can be registered on "outside" components.

child : UIComponent

Child component, i.e. the reusable component itself.

methods : Map<String, {List<Object> : Object}>

Map of "methods" which can be dynamically invoked via ui::invoke(...) method. Key of the maps is the name of the method.

OutputText extends UIComponent
content : { : Object}

The object, to be displayed as a text. See description of format property for more details. It is recalculated on each refresh.

If the closure is null, the value is calculated from the binding property.

format : String

Base on return type of content closure, format value should be:

Date: pattern that conforms with java.text.SimpleDateFormat

Decimal: pattern that conforms with java.text.DecimalFormat

Integer: pattern that conforms with java.text.DecimalFormat

String: {html, plaintext, preformatted}

for all other types {Boolean, Record, List, Set, Map, Reference, Closure, TypeNull, Object} format is ignored and core::toString() is used to transform object to text

SECURITY NOTE: be caucious about xhtml format!

html format supports:

<b> Bold

<i> Italic

<u> Underlined

<br/> Linebreak

<ul><li>item 1</li><li>item 2</li></ul> List of items

plaintext shrinks spaces, etc; preformatted keeps formating.

binding : Reference<Object>

If used, the table will pick this field and allow automatic sorting and filtering. The referenced value is also displayed unless the content closure is specified (the content closure has higher display priority).

label : { : String}

Label is the visible name of the component. Recalculated on each refresh.

ActionLink extends UIComponent
disabled : { : Boolean}

If true, the button is disabled, i.e. it is not possible to click it. It is recalculated on each refresh.

text : { : String}

A text to be displayed as a link. It is recalculated with each refresh.

helpText : { : String}

Text shown in the tooltip. Returned string might contain some tags, for details see com.vaadin.ui.AbstractComponent.getDescription(). It is recalculated on each refresh.

Button extends UIComponent
disabled : { : Boolean}

If true, the button is disabled, i.e. it is not possible to click it. It is recalculated on each refresh.

text : { : String}

A text to be displayed within the button. It is recalculated with each refresh.

helpText : { : String}

Text shown in the tooltip. Returned string might contain some tags, for details see com.vaadin.ui.AbstractComponent.getDescription(). It is recalculated on each refresh.

Message extends UIComponent

Shows the error messages of all failed validators.

Conditional extends UIComponent
showDEPRECATED : { : Boolean}

Determines, whether the child (content) is shown or not. It is mandatory. It is recalculated on each refresh.

child : UIComponent

The child of the Conditional.

TableColumn extends UIComponent
header : { : String}

The columns header. It is recalculated on each refresh.

content : UIComponent

The content of the TableColumn.

shownDEPRECATED : { : Boolean}

Whether the column is shown or not. It is recalculated on each refresh. If the column is not shown, it cannot be made visible through GUI selector.

Optional. If not specified, table column is shown. Deprecated.

ordering : Object

The object which specifies by what to order. E.g., property Book.title.

inferOrderingDisabled : Boolean

Controls, whether ordering inferring is disabled for this column.

filter : Filter

Definition of the filter for this column.

inferFilteringDisabled : Boolean

Controls, whether filter inferring is disabled for this column.

groupValue : {Collection<Null> : Object}

This closure is used to populate corresponding column of the "aggregated" row (a.k.a. reduction function). Usual toString is applied on the return value of the closure. If groupValue closure is null, then the column is just not populated with any data. Note that it is not possible to "model" cells content for aggregated rows, the cell content is always a label with value of groupValue.

Table extends UIComponent
data : Object

Datasource of the table. Datasource can be specified by: Type<Record>, {:Collection<Object>} or {Integer,Integer:Collection<Object>}. Recalculated on each refresh.

dataCount : { : Integer}

Total count of all entries. Mandatory when table is paged and datasource provided as {Integer,Integer:Collection<Object>}. Recalculated on each refresh.

iterator : Reference<Object>

Reference, to which object for "current" row is written, when the row is being calculated\refreshed.

idx : Reference<Integer>

Reference, to which index of "current" row is written, when the row is being calculated\refreshed. Optional.

showIdx : { : Integer}

Optional. Ignored when table type is 'simple'.

If provided, table shows page with the entry with the given index.

type : TableType

TableType.simple - no paging

TableType.lazy - paging with scrollbar (no explicit pages)

TableType.paged - paging with explicit pages

This property is optional. If not provided, default TableType.simple is used.

columns : List<TableColumn>

Specification of columns of the table.

ordering : Reference<Map<Object, OrderDirection>>

Reference to which a "new" Table ordering is written when changed. Can be also used to programatically change the ordering from the model or set initial ordering of the Table. Example: assume Column1 is ordered by property 'Book.Title'. If user clicks this column, new Map will be written to ordering reference. The first map entry of that map will be ['Book.Title' -> OrderDirection, ...].

inferOrderingDisabled : Boolean

Controls, whether ordering is automatically inferred. Optional. If true, sorting is automatically inferred.

orderingDisabled : Boolean

Allows to completly disable ordering in the table "in one place". Optional. If true, table does not support ordering.

filtering : Reference<Collection<Filter>>

Reference, to which is written "new" filtering, when user selects some filter in the table. It can be used to programatically control the table filtering from the model as well as define initial table filtering. Optional.

inferFilteringDisabled : Boolean

Controls, whether filtering is automatically inferred. Optional. If false, filtering is automatically inferred.

filteringDisabled : Boolean

Allows to completly disable filtering in the table "in one place". Optional. If true, table does not support filtering.

groupSpec : Collection<GroupSpec>

Definition of "groupping options" by which it is possible to group data in table.

grouping : Reference<Collection<GroupSpec>>

Reference, to which is written "new" Table grouping, when it is changed. Can be also used to programatically change the grouping from the model or set initial grouping of the Table.

inferGroupingDisabled : Boolean

Controls, whether grouping is automatically inferred. Optional. If true, grouiping is automatically inferred.

groupingDisabled : Boolean

Allows to completly disable grouping in the table "in one place". Optional. If true, table does not support grouping.

Panel extends UIComponent

Panel

child : UIComponent

Child component of the Panel.

title : { : String}

The title of the panel. It is recalculated on each refresh. If left empty, no title is shown in the panel.

collapsed : Reference<Boolean>

Specifies, whether the pannel is collapsed. If the panel is collapsed, only the panel title is shown. If user un/collapses the panel, the renderer writes current collapse state into this reference and it is possible to change the collapse state from the model. It is recalculated on each refresh.

TabbedLayout extends UIComponent
tabs : List<Tab>

Tabs of the Tab component.

GridLayout extends UIComponent
cells : Set<GridItem>

Individual cells of the Grid.

ViewModel extends UIComponent
child : UIComponent

The child component.

mergeType : { : MergeType}

If the closure returns a non-null value and the ViewModel is merged (by some listener), the merge is performed. See MergeType for more details.

TextArea extends InputComponent
binding : Reference<String>

Reference to a slot containng the value.

placeholder : { : String}

A text shown in the component if the binding is null. It is recalculated on each refresh.

isRichText : Boolean

If true, component allows 'rich' formatting of the input.

CheckBox extends InputComponent
binding : Reference<Boolean>

Reference to a slot containng the value.

SingleSelectList extends InputComponent
binding : Reference<Object>

Reference to a slot containng the selected value.

options : { : List<Option>}

List of value options.

CheckBoxList extends InputComponent
binding : Reference<Set<Object>>

Reference to a slot containing a list of selected values.

options : { : List<Option>}

List of value options.

FileUpload extends InputComponent
binding : Reference<Set<File>>

Reference to a slot containng a set of uploaded files. It is not mandatory (newly uploaded data are received in event).

multiple : { : Boolean}

If true, it is possible to upload mutiple files, otherwise, only one file can be uploaded.

uploadToMemory : Boolean

If true, upload is done to memory, otherwise, upload is done to lsps binary data.

buttonText : { : String}

Text displayed in the upload button. It is recalculated on each refresh.

deleteTempData : Boolean

If FileUpload.uploadToMemory = false, then data are temporarily stored in LSPS_BINARY_DATA table. FileUpload.deleteTempData is used to control whether the temporary data are automatically deleted from LSPS_BINARY_DATA by LSPS.

The deletion is done when associated http session is invalidated.

MultiSelectList extends InputComponent
binding : Reference<Set<Object>>

Reference to a slot containng a list of selected values.

options : { : List<Option>}

List of value options.

TextBox extends InputComponent
binding : Reference<Object>

Reference to a slot containng the value.

format : String

Base on binding type, format value should be:

Date: pattern that conforms with java.text.SimpleDateFormat

Decimal: pattern that conforms with java.text.DecimalFormat

Integer: pattern that conforms with java.text.DecimalFormat

String: format is ignored. However, it can contain pattern that conform with java.util.Pattern for client side validation

binding cannot reference any other type {Boolean, Record, List, Set, Map, Reference, Closure, TypeNull, Object}

This component supports client-side validation; i.e. if format is not null, JS on client will allow only to enter valid values according to format.

placeholder : { : String}

A text shown in the component if the binding is null. It is recalculated on each refresh.

ComboBox extends InputComponent
binding : Reference<Object>

Reference to a slot containng the value.

options : { : List<Option>}

List of value options.

createNewOption : {String : Object}

If user enters new option into the combo, this closure is invoked with user entered input and the result is written to the binding.

placeholder : { : String}

A text shown in the component if the binding is null. It is recalculated on each refresh.

RadioButtonList extends InputComponent
binding : Reference<Object>

Reference to a slot containng the selected value.

options : { : List<Option>}

List of value options.

InputComponentABSTRACT extends UIComponent
readOnly : { : Boolean}

If true, the component is read only. Otherwise (false or unspecified), the component is read write. Recalculated on each refresh.

triggerProcessingOnChange : Boolean

If true, each change of the component causes processing (data are sent to the server and response is displayed to the user). If false or unspecified, the changed data are sent to the server within the next post.

label : { : String}

Label is the visible name of the component. Recalculated on each refresh.

required : { : Boolean}

If true, visual notation is shown in the UI to indicate, that this component is mandatory. Note that the actual check for the provided value must be done within the listener. This is only a VISUAL INDICATOR. Recalculated on each refresh.

helpText : { : String}

Text shown as tooltip. Recalculated on each refresh. If unspecified, no tooltip is displayed.

Repeater extends UIComponent
data : { : Collection<Object>}

Data through which repeater iterates. It is recalculated on each refresh.

iterator : Reference<Object>

Reference, to which object for "current" iteration is written.

idx : Reference<Integer>

Reference, to which index of "current" iteration is written. Optional.

content : UIComponent

Component which defines how the entry will be rendered.

layout : RepeaterLayout

The layout to use when laying out children. null defaults to "wrap". Not dynamically recomputed on refresh.

Tab
text : { : String}

The title of the tab. It is recalculated on each refresh.

content : UIComponent

Content of the Tab.

shownDEPRECATED : { : Boolean}

Controls the visibility of the Tab. Deprecated. Use visible property instead.

visible : { : Boolean}

Controls the visibility of the component. The component is visible unless this closure is not null and returns false.

GridItem
content : UIComponent

The content of the GridItem.

row : Integer

0-based. Position of the GridItem within the GridLayout.

column : Integer

0-based. Position of the GridItem within the GridLayout.

spanRows : Integer

How many rows should it span.

spanColumns : Integer

How many columns should it span.

FileDownload extends UIComponent

Refresh is caused if the file is downloaded and there is registered listener which can handle FileDownloadEvent.

content : { : File}

A file to be downloaded. It is recalculated on each refresh.

text : { : String}

A text of the download link. It is recalculated on each refresh.

helpText : { : String}

Tooltip of the download link. It is recalculated on each refresh.

style : FileDownloadStyle

Specifies whether the file download component is shown as a hyperlink (default), or as a button.

Image extends UIComponent
content : { : File}

A file to be displayed. All usuall image formats are supported (jpeg, png, gif, ...). It is recalculated on each refresh.

text : { : String}

The caption of the component (usually a text displayed above the image). It is recalculated on each refresh. Can be unspecified.

helpText : { : String}

A tooltip of the image and altText. It is recalculated on each refresh. Can be unspecified.

NavigationLink extends UIComponent
disabled : { : Boolean}

If true, the button is disabled, i.e. it is not possible to click it. It is recalculated on each refresh.

content : { : Navigation}

Returns subclass of Navigation type, which specifies, where to navigate when this link is clicked. If is recalculated on each refresh.

text : { : String}

A text to be displayed as a link. It is recalculated with each refresh.

helpText : { : String}

Text shown in the tooltip. Returned string might contain some tags, for details see com.vaadin.ui.AbstractComponent.getDescription(). It is recalculated on each refresh.

HorizontalLayout extends UIComponent
children : List<UIComponent>

Content of the Hirozontal Layout.

label : { : String}

Label is the visible name of the component. Recalculated on each refresh.

VerticalLayout extends UIComponent
children : List<UIComponent>

Content of the Vertical Layout.

label : { : String}

Label is the visible name of the component. Recalculated on each refresh.

Option

A single option of a *List UI components.

value : Object

Value itself.

label : String

Label for the value.

Popup extends UIComponent
showDEPRECATED : { : Boolean}

Drives the popup visibility. Recalculated on each refresh. If null or false, popup is not shown. Deprecated. User visible property instead.

child : UIComponent

The content of the Popup.

title : { : String}

The title of the popup window. If unspecified, the title is left empty. It is recalculated on each refresh.

isModal : { : Boolean}

If true, the popup is modal. Recalculated on each refresh.

LazyComboBox extends InputComponent
binding : Reference<Object>

Reference to a slot containng the value.

options : {String, Integer, Integer : List<Object>}

Options for the given input by the user (first parameter). Second parameter of the closure is the start index and third parameter is the count of the options to be returned.

optionsCount : {String : Integer}

Total count of all options for the given String (entered by user into the combo box).

formatter : {Null : String}

Closure which returns label for the given object.

createNewOption : {String : Object}

If user enters new option into the combo, this closure is invoked with user entered input and the result is written to the binding.

placeholder : { : String}

A text shown in the component if the binding is null. It is recalculated on each refresh.

BrowserFrame extends UIComponent
url : { : String}

The URL to display withing the IFrame. Recalculated on each refresh.

Dashboard extends UIComponent
toolbar : UIComponent

Component which defines 'toolbar' of the Dashboard.

widgets : List<DashboardWidget>

Invidivual widgets of the Dashboard.

DashboardWidget extends UIComponent
title : { : String}

The title of the widget. It is a mandatory property and is recalculated on each refresh.

content : ui::UIComponent

Content of the Widget.

widgetId : String

Unique identifier of the widget. It is used to to identify a changed widget in the WidgetChangeEvent.

required : Boolean

If true, the widget is always visible in dashboard.

configuration : { : WidgetConfiguration}

Configuration of widget specifying its visibility, size and position. If unspecified, the default values are used. It is recalculated on each refresh.

WidgetConfiguration
visible : Boolean

If true, Widget is visible.

width : Integer

The width of Widget in px.

height : Integer

The height of Widget in px.

top : Integer

Top position of the widget in px (0,0 -> upper, left).

left : Integer

Left position of the widget in px (0,0 -> upper, left).

zIndex : Integer

Widget with higher zIndex is always in front of widget with lower zIndex.

maximized : Boolean

If true, widget is maginized.

minimized : Boolean

If false, widget is nimimized in the tray.

Dimension
width : Integer

Width in pixels.

height : Integer

Height in pixels.

TreeItem

TreeItem is essentially a holder of various properties which constitues one item (entry) of the Tree.

data : Object

The business data reference. Must not be null.

label : String

The label of the item, will be displayed in the tree.

expanded : Boolean

If true, the item is initially expanded and shows its children. Defaults to false.

parent : TreeItem

Parent TreeItem.

children : Collection<TreeItem>

Children of this TreeItem. If null, children will be lazyly fetched when user expands 'this' TreeItem (i.e. Tree2.children closure will be invoked with 'this' TreeItem as parameter). Empty set or list means that 'this' TreeItem is leaf.

TreeDEPRECATED extends InputComponent
children : {Null, Integer : List<TreeItem>}

Returns children of given parent node. Accepts two parameters: first one is the parent data Object reference. Resulting list of items will be nested in this parent. May be null - in this case the root items are returned. Second parameter is the depth of the parent Object in the tree. If parent is null, depth is 0 and all its children will have depth of 1, etc.

binding : Reference<Object>

Reference to a slot containing the value.

TreeTableDEPRECATED extends UIComponent
children : {Null, Integer : List<TreeTableItem>}

Returns children of given parent node. Accepts two parameters: first one is the parent data Object reference. Resulting list of items will be nested in this parent. May be null - in this case the root items are returned. Second parameter is the depth of the parent Object in the tree. If parent is null, depth is 0 and all its children will have depth of 1, etc.

iterator : Reference<Object>
columns : List<TableColumn>

The table columns definition.

TreeTableItemDEPRECATED
data : Object

The business data reference. May be null.

expanded : Boolean

If true, the item is initially expanded and shows its children. Defaults to false.

FormLayout extends UIComponent
children : List<UIComponent>

Content of the Form Layout.

GeographicCoordinate

The geographic coordinate reference system used by the attributes is the World Geodetic System (2d) aka WGS84 aka EPSG:4326. The location on the globe is provided as a pair of two coordinates, latitude and longitude.

latitude : Decimal

The latitude of the position, not null.

longitude : Decimal

The longitude of the position, not null.

Geoposition

Contains details received from browsers HTML5 geolocation request. Note that on some devices selected fields may be null.

The geographic coordinate reference system used by the attributes is the World Geodetic System (2d) aka WGS84 aka EPSG:4326.

coordinate : GeographicCoordinate

The geographic position, not null.

accuracy : Decimal

The accuracy of the position information in meters. Not null.

altitude : Decimal

The height of the position, specified in meters above the ellipsoid or null if device cannot provide the information.

altitudeAccuracy : Decimal

The accuracy of the altitude informations in meters or null.

heading : Decimal

Denotes the direction of travel of the hosting device and is specified in degrees, where 0° <= heading < 360°, counting clockwise relative to the true north. Null if device don't support it or it is not moving.

speed : Decimal

The magnitude of the horizontal component of the hosting device's current velocity and is specified in meters per second. If the implementation cannot provide speed information, the value of this attribute must be null. Otherwise, the value of the speed attribute must be a non-negative real number.

PositionOptions

A configuration for the device providing the location information.

enableHighAccuracy : Boolean

The enableHighAccuracy attribute provides a hint that the application would like to receive the best possible results.

This may result in slower response times or increased power consumption. The user might also deny this capability,

or the device might not be able to provide more accurate results than if the flag wasn't specified.

The intended purpose of this attribute is to allow applications to inform the implementation that they

do not require high accuracy geolocation fixes and, therefore, the implementation can avoid using geolocation

providers that consume a significant amount of power (e.g. GPS). This is especially useful for applications running

on battery-powered devices, such as mobile phones.

If the PositionOptions parameter to getCurrentPosition or watchPosition is omitted, the default value used for the enableHighAccuracy attribute is false.

The same default value is used in ECMAScript when the enableHighAccuracy property is omitted.

timeout : Decimal

The timeout attribute denotes the maximum length of time (expressed in milliseconds) that is allowed to pass from the call

to getCurrentPosition() or watchPosition() until the corresponding successCallback is invoked. If the implementation is unable to

successfully acquire a new Position before the given timeout elapses, and no other errors have occurred in this interval,

then the corresponding errorCallback must be invoked with a PositionError object whose code attribute is set to TIMEOUT.

Note that the time that is spent obtaining the user permission is not included in the period covered by the timeout attribute.

The timeout attribute only applies to the location acquisition operation.

If the PositionOptions parameter to getCurrentPosition or watchPosition is omitted,

the default value used for the timeout attribute is Infinity. If a negative value is supplied, the timeout value is considered to be 0.

The same default value is used in ECMAScript when the timeout property is omitted.

maximumAge : Decimal

The maximumAge attribute indicates that the application is willing to accept a cached position whose age is no greater than the specified time in milliseconds.

If maximumAge is set to 0, the implementation must immediately attempt to acquire a new position object. Setting the maximumAge to Infinity must determine

the implementation to return a cached position regardless of its age. If an implementation does not have a cached

position available whose age is no greater than the specified maximumAge, then it must acquire a new position object.

In case of a watchPosition(), the maximumAge refers to the first position object returned by the implementation.

If the PositionOptions parameter to getCurrentPosition or watchPosition is omitted, the default value used for

the maximumAge attribute is 0. If a negative value is supplied, the maximumAge value is considered to be 0.

The same default value is used in ECMAScript when the maximumAge property is omitted.

Geolocator extends UIComponent

The Geolocator extension can be used to detect the client's geographical location, direction, altitude, etc.

detect : { : Boolean}

Detects the current geographic location of the client. Set to true and refresh this component to perform the detection. The detection happens asynchronously and the position is reported to GeolocationListener as a GeolocationEvent. Note that this only checks the position once, you need to call this method multiple times if you want to update the location as the client moves. User may reject the position detection, in which case the event is fired, with GeolocationEvent.failure set to GeolocationError.PermissionDenied.

positionOptions : { : PositionOptions}

A closure which retrieves position gathering options. The closure may return null.

MapMarker
title : String

The marker title.

location : GeographicCoordinate

The marker location.

popup : String

If not null, this HTML code is displayed when the marker is clicked.

draggable : Boolean

If true, this marker can be dragged to a different location. When dragged, the MarkerDraggedEvent event is fired.

MapDisplay extends UIComponent

Displays an OpenStreetMap map.

center : { : GeographicCoordinate}

Upon refreshing, asks for the new coordinates to center on. If null is received, no centering is performed.

zoom : { : Integer}

Upon refreshing, asks for the zoom. If null is received, no zoom change is performed.

markers : { : Set<Object>}

Upon refreshing, asks for a list of markers to show. Old markers are removed from the map. If null is received, no markers are shown.

toMarker : {Null : MapMarker}

Converts business data to marker.

Calendar extends UIComponent
data : {Date, Date : Set<Object>}

A closure which returns the data displayed in calendar. The result depends on start and end dates of the displayed period, both specified as closure parameters.

toItem : {Null : CalendarItem}

A closure that transforms an underlying business object to a calendar item.

initialDate : Date

A date on which the calendar is initially opened. If not specified, the calendar is opened at the current date.

readOnly : { : Boolean}

If true, Calendar is read only. Otherwise (false or unspecified), Calendar is read write. Recalculated on each refresh.

mode : { : CalendarMode}

Calculated on refresh. If the closure is null or if it returns a non-null value, the calendar component is switched to given mode.

CalendarItem
caption : String

Caption of the calendar item.

description : String

Description of the calendar item.

from : Date

Start date of the calendar item.

to : Date

Finish date of the calendar item.

allDay : Boolean

If true, the calendar item represents the all day event, ie., time of the from and to fields is ignored. If false, the calendar item takes into account also the time of the from and to fields.

style : String

The style name of event. In the HTML-based client, the style name will be set as the event's element class name and can be styled by CSS. For example, setting this value to "color1" will attach "v-calendar-event-color1" CSS class name to the HTML element and can be further styled using CSS.

MenuItem
caption : String

The caption of the menu item.

id : Object

This value will be present in MenuEvent when the menu item is clicked.

submenu : List<MenuItem>

May optionally contain child menu items. MenuEvent is fired for "leaf" menu items only - it is not fired for menu items which contains submenu items.

htmlClass : String

String which will be used as html class in generated html.

Tree2 extends InputComponent
root : { : Collection<TreeItem>}

Root elements of the Tree (yes, tree can have multiple root elements).

children : {TreeItem : Collection<TreeItem>}

Closure, which returns for given TreeItem its children. If the given TreeItem has no children (i.e. it is a leaf), the closure should return empty set or list.

binding : Reference<Object>

Reference to which the data object of TreeItem is written when it is selected.

TreeTable2 extends UIComponent
root : { : Collection<TreeItem>}

Root elements of the TreeTable.

children : {TreeItem : Collection<TreeItem>}

Closure, which returns for given TreeItem its children. If the given TreeItem has no children (i.e. it is a leaf), the closure should return empty set or list.

iterator : Reference<Object>

Reference, to which object for "current" row is written.

treeItemIterator : Reference<TreeItem>

Reference, to which TreeItem for "current" row is written.

columns : List<TableColumn>

Definition of columns of the TreeTable.

ordering : Reference<Map<Object, OrderDirection>>

Reference to which a "new" TreeTable ordering is written when it is changed. Can be also used to programatically change the ordering from the model or set initial ordering. Example: assume Column1 is ordered by property 'Book.Title'. If user clicks this column, new Map will be written to ordering reference. The first map entry of that map will be ['Book.Title' -> OrderDirection, ...].

inferFilteringDisabled : Boolean

Controls, whether filtering is automatically inferred. Optional. If false, filtering is automatically inferred.

filteringDisabled : Boolean

Allows to completly disable filtering in the tree table "in one place". Optional. If true, tree table does not support filtering.

CustomFilter extends Filter

Used when one wants to use his own FilterUI specified through CustomFilter.ui. The CustomFilter.filterText is displayed in the table header when the filter is active.

ui : UIComponent

UI component used to display the custom filter.

filterText : { : String}

Displayed text of the filter.

popup : Boolean

Whether to display CustomFilter.ui in the popup.

SubstringFilterUI extends FilterUI

Used to filter String. The usual string% filtering.

substring : String

The substring to filter by.

FilterABSTRACT

An abstract type used to define filter of table column.

FilterUIABSTRACT

Abstract supertype for all concrete definitions of the filter UI.

PropertyFilter extends Filter

Allows to define filter by property. Only meaningful Property can be entered (i.e. property of simple comparable type). Filtering form will be automatically inferred from the type of the property (if it is not explicitly specified via PropertyFilter.ui). E.g. if getPropertyType(propertyFilter.p) == Integer then NumericFilterUI is used.

p : Property

The property to filter by.

OptionsFilterUI extends FilterUI

A simple combobox which allows to filter by predefined set of options.

options : List<Option>

Options to allow to filter by.

selected : List<Option>

Allows to set the pre-selected options to filter by when filter is set from model.

multiselect : Boolean

Whether to allow to filter by multiple selected options.

ClosureFilter extends Filter

Allows to filter by return value of the closure. Input parameter is a "business object", return value is value to filter upon (some simple comparable type).

c : {Null : Object}

The closure which computes value to filter upon.

NumericFilterUI extends FilterUI

Used to filter Integers, Decimals. Allows to filter by >, <, ==.

lessThan : Decimal

Less than value.

equal : Decimal

Equal value.

moreThan : Decimal

More than value.

DateFilterUI extends FilterUI

Used to filter dates.

lessThan : Date

Less than date.

moreThan : Date

More than date.

resolution : Resolution
RegExpFilterUI extends FilterUI

Used to filter string values by regexp.

regexp : String

The regexp (java.util.regex.Pattern).

ClosureGroupSpec extends GroupSpec

This record type allows to define group by "computed" value.

groupBy : {Null : Object}

The closure which defines the grouping. Return value should be only of comparable types, i.e. Boolean, Date, Decimal, Integer, Enum, String.

GroupSpecABSTRACT

An abstract type used to define grouping of table data.

label : String

Label of the group user will see in UI.

PropertyGroupSpec extends GroupSpec

This record type is used to define group by property.

groupBy : Property

The property which defines the grouping. e.g. Book.Title.

OptClosureGroupSpec extends GroupSpec

This is the same as ClosureGroupSpec but allows for "better performance".

groupBy : {Collection<Null> : Map<Object, Collection<Object>>}

The input is set of objects to be grouped in one pass.

TableColumnState

This record holds column state. It can be used to store or restore the table column's state.

columnId : Object

The identifier of the table column.

collapsed : Boolean
width : Integer
GeolocatorError

Enumerates all possible causes of a geolocation retrieval failure.

UnknownError

An unknown error occurred.

PermissionDenied

The user declined access to their position.

PositionUnavailable

The browser was unable to locate the user.

Timeout

The browser was unable to locate the user in the time specified in the PositionOptions.timeout

UnsupportedInBrowser

The browser does not support geolocation retrieval.

MergeType

Specifies the merge algorithm used by a particular ViewModel when a ViewModel merge is requested in a Listener.

oneLevel

Merges one level down towards the screen context (corresponds to the deprecated setting mergeToTopLevel = false)

screenLevel

Evaluation context and any lower execution contexts are merged to the screen context.

TableType

Defines the table type and the way the table accesses the data.

simple

A simple table, which reads all data rows from the underlying data source and holds them in-memory. By default the table wraps and shows all rows. When the height is set to fill-parent, the table is able to scroll its contents.

lazy

A lazy table with a scrollbar

Upon scrolling, the table polls the data source for data. The data is internally retrieved in pages or batches of 30 rows. You can use the initial-page-size hint to modify the batch size. As a rule of thumb, the page size should be twice as big as the number of rows shown in the table.

paged

A paged table with no scrollbar

The page shows 20 items at most by default; this can be changed by the initial-page-size hint value. Paging controls are displayed below the table, which allows the user to move to the next/last/previous/first page.

OrderDirection

The ordering direction of the Table Column; similar to SQL ORDER BY.

Ascending

The data is sorted in ascending order.

Descending

The data is sorted in descending order.

RepeaterLayout

Defines the layout of child UI components in the repeater.

wrap

The default layout behavior

Children are positioned horizontally until there is no more space - in such a case a next row is started. To activate this mode, you need to set the child's width to wrap-content; If the child has the width of fill_parent, the children are laid out vertically.

horizontal

Lays out children horizontally. Equal to HorizontalLayout.

vertical

Lays out children vertically. Equal to VerticalLayout.

FileDownloadStyle

The FileDownload component style

Link

The FileDownload component is rendered as a hyperlink (default).

Button

The FileDownload component is rendered as a button.

CalendarMode

The display mode of the Calendar component

Daily

The calendar shows a single day, in a single column, with hours displayed as rows.

Weekly

The calendar shows seven days in seven columns, with hours displayed as rows.

Monthly

The calendar shows all days of a particular month, as a grid of tiles.

NotificationType

Predefined notification types

Each notification type has its distinctive UI look, default screen position and behavior (for example, an Info notification fades away automatically while an Error notification is displayed until the user clicks the notification).

Info

Information notification. See https://vaadin.com/blog/-/blogs/user-notifications-with-vaadin for examples.

By default, notification with this type disappears immediately (that is, it slowly fades in and immediately, with no delay, starts fading out) . The nofication is shown in the middle center part of the screen by default.

Warning

Warning notification. See https://vaadin.com/blog/-/blogs/user-notifications-with-vaadin for examples.

By default, notification with this type disappears after 1,5 second and is shown in the middle center part of the screen.

Error

Error notification. See https://vaadin.com/blog/-/blogs/user-notifications-with-vaadin for examples.

By default, notification with this type requires user click to disappear and is shown in the middle center part of the screen.

Tray

Bottom-right small notification. See https://vaadin.com/blog/-/blogs/user-notifications-with-vaadin for examples.

By default, this notification disappears after 3 seconds and is shown in the bottom-right corner.

Position

The notification position in the browser tab

TopLeft
TopCenter
TopRight
MiddleLeft
MiddleCenter
MiddleRight
BottomLeft
BottomCenter
BottomRight
Resolution
Second
Minute
Hour
Day
Month
Year

Events

ValueChangeEventSYSTEM extends Event

Event fired by input components when their value is changed.

source : UIComponent

Component that produced the event.

oldValue : Object

Value before it was changed.

newValue : Object

Value after it was changed.

ActionEventSYSTEM extends Event

Event fired by e.g. button, link when it is clicked.

source : UIComponent

Component that produced the event.

FileDownloadEventSYSTEM extends Event

Event fired when file is downloaded through FileDownload component.

source : UIComponent

Component that produced the event.

InitEventSYSTEM extends Event

Event fired by "all" components when they change their visibility.

source : UIComponent

Component that produced the event.

isFirstLoad : Boolean

True for a component displayed for the first time (the property is true also when a hidden component is displayed for the first time).

isFirstLoadAfterSave : Boolean

True for a component displayed for the first time or for the first time after save

FileUploadEventSYSTEM extends Event

Event fired from FileUpload component when file is uploaded.

source : UIComponent

Component that produced the event.

uploadedFiles : Set<File>

Set of uploaded files.

errorMessage : String

Error message returned if the upload fails.

ApplicationEvent extends Event

ApplicationEvent.

eventName : String

Custom name of the ApplicationEvent.

payload : Object

Custom event data.

EventABSTRACTSYSTEM

Abstract supertype of all Events.

ChartClickEventSYSTEM extends ui::Event

Event fired when bar\pie\... is clicked in chart.

source : UIComponent

Component that produced the event.

series : String

Label of data series that was clicked.

key : Object

Key value for the data point.

value : Decimal

First value defining the data point.

value2 : Decimal

Second value defining the data point.

payload : Object

Payload of the data point.

WidgetChangeEventSYSTEM extends Event

Event fired when widget of dashboard is moved, resized, etc.

source : UIComponent

Component that produced the event.

widgetId : String

ID of the widget that produced the event set in the Widget ID parameter.

configuration : WidgetConfiguration

Widget configuration with details about the widget position and size.

CalendarCreateEventSYSTEM extends CalendarItemEvent

The CalendarCreateEvent is fired by a calendar component when the user clicks and drags over a period in a calendar. The event holds the selection data as its payload and the data can be used to create a new calendar entry.

from : Date

Start date of the selected period.

to : Date

End date of the selected period.

allDay : Boolean

If the entry is a whole-day event (if selected across days, the entry is an allDay entry; if the selected area is across hours, the allDay property is false and the exact hours are included).

CalendarEditEventSYSTEM extends CalendarItemEvent

The CalendarEditEvent is fired by a calendar component when a calendar entry is clicked. Note that the event has as its payload the business object of the calendar entry that was clicked.

data : Object

Business object of the calendar entry that was clicked.

CalendarItemEventABSTRACTSYSTEM extends Event
source : Calendar
CalendarRescheduleEventSYSTEM extends CalendarItemEvent

The CalendarRescheduleEvent is fired by the calendar component when a calendar entry is dragged-and-dropped to a different date. Note that the event has as its payload the business object of the rescheduled calendar entry.

from : Date

Start date of the new period.

to : Date

End date of the new period.

data : Object

Business object of the calendar entry that was rescheduled.

MapClickedEventSYSTEM extends ui::Event

The MapClickedEvent is fired by the Map Display component when the user clicks into the map.

source : MapDisplay

Component that produced the event.

point : GeographicCoordinate

Point that was clicked.

MarkerClickedEventSYSTEM extends ui::Event

The MarkerClickedEvent is fired by the Map Display component when the user clicks a marker.

source : MapDisplay

Component that produced the event.

markerData : Object

Underlying marker business object (the respective object of the set defined in the Markers property of the Map Display component).

MarkerDraggedEventSYSTEM extends ui::Event

The MarkerDraggedEvent is fired by the Map Display component when the user drag-and-drops a marker.

source : MapDisplay

Component that produced the event.

markerData : Object

Underlying marker business object (the respective object of the set defined in the Markers property of the Map Display component).

newLocation : GeographicCoordinate

New marker position after dropped.

GeolocationEventSYSTEM extends ui::Event

The GeolocationEvent is fired by the Geolocator component after the component has acquired the geographical position of the user or when the request for location times out.

source : Geolocator

Component that produced the event.

position : Geoposition

When a geolocation request succeeds, this value will contain a non-null position.

failure : GeolocatorError

When a geolocation request fails, this field will contain the error cause.

MenuEventSYSTEM extends Event

Fired by menu item when it is clicked.

source : UIComponent

The component which has the menu attached.

id : Object

The value of MenuItem.id.

ItemExpandedEventSYSTEMDEPRECATED extends Event

DEPRECATED.

source : UIComponent

The component which has the menu attached

data : Object

The value of MenuItem.id

ItemCollapsedEventSYSTEMDEPRECATED extends Event

DEPRECATED.

source : UIComponent

The component which has the menu attached

data : Object

The value of MenuItem.id

TreeEventSYSTEM extends Event

Fired by Tree component when some TreeItem is selected.

source : UIComponent

Component that produced the event.

treeItem : TreeItem

Event-related TreeItem.

PopupCloseRequestEvent extends ui::Event

This event is only fired when the user clicks the X (close) popup button. It is not fired when the popup is closed because its visiblity has been set to false.

source : Popup

Component that produced the event.

TablePageSizeChangeEvent extends Event
source : Table

The component which has the menu attached.

pageSize : Integer

The value of MenuItem.id.

AsynchronousTextChangeEventSYSTEM extends Event

Event fired by input text components when the text inside them is changed. The event is fired asynchronously, a new one can be fired even if the old one is still being processed.

source : UIComponent

Component that produced the event.

text : String

Current content of the text field.

Listeners

ListenerABSTRACT

Abstract supertype of all listeners.

refresh : {Event : Set<UIComponent>}

Set of components to refresh.

process : Set<UIComponent>

Set of components to process in request-responce lifecycle. Events from other components will be ignored.

validate : {Event : Set<ValidationError>}

Closure, which returns validation errors.

executeOnlyIfVisible : Set<UIComponent>

Listener will not execute if specified components are not visible.

executeEvenIfFailedValidations : Boolean

If true, listener is executed even in the case some validations failed in 'Validate II' phase (however, all validations on this listener must pass). Otherwise (null, false), should the listener be executed in 'Handle ActionEvents' phase, it is only executed if all validations from all listeners passed in the 'Validate II' phase (i.e. outcome of 'Validation II' phase is success). Default is null/false.

executionContext : UIComponent

Execution context of the listener. If not specified, listener is executed in the context of component on which it is registered.

modelingId : String

Modeling id which is used in exceptions, etc. to identify the listener.

actions : {Event : List<Action>}

Set of actions to be executed.

eventFilter : {Event : Boolean}

Listener gets executed only if event passes eventFilter (if specified).

executeEvenIfInvalidComponents : Boolean

If true, listener is executed even in the case some components are invalid (has unparsable values, such as 'a' for integer/date field). Default is null/false.

ValueChangeListener extends Listener

Listener which listens for ValueChangeEvents.

handle : {ValueChangeEvent : Object}

Closure that is executed when listener is fired.

InitListener extends Listener

Listener which listens for InitEvent.

handle : {InitEvent : Object}

Closure that is executed when listener is fired.

GenericListener extends Listener

Listener which listens for any type of Event.

handle : {Event : Object}

Closure that is executed when listener is fired.

ActionListener extends Listener

Listener which listens for ActionEvents.

handle : {ActionEvent : Object}

Closure that is executed when listener is fired.

FileDownloadListener extends Listener

Listener which listens for FileDownloadEvent.

handle : {FileDownloadEvent : Object}

Closure that is executed when listener is fired.

FileUploadListener extends Listener

Listener which listens for FileUploadEvents.

handle : {FileUploadEvent : Object}

Closure that is executed when listener is fired.

ApplicationEventListener extends Listener

Listener which listens for ApplicationEvents.

handle : {ApplicationEvent : Object}

Closure that is executed when listener is fired.

eventName : Collection<String>

Name of the ApplicationEvent for which this listener listens.

ChartClickListener extends Listener

Listener which listens for ChartClickEvents.

handle : {ChartClickEvent : Object}

Closure that is executed when listener is fired.

WidgetChangeListener extends Listener

Listener which listens for WidgetChangeEvents.

handle : {WidgetChangeEvent : Object}

Closure that is executed when listener is fired.

CalendarRescheduleListener extends Listener

Listener which listens for CalendarRescheduleEvents.

handle : {CalendarRescheduleEvent : Object}

Closure that is executed when listener is fired.

CalendarCreateListener extends Listener

Listener which listens for CalendarCreateEvents.

handle : {CalendarCreateEvent : Object}

Closure that is executed when listener is fired.

CalendarEditListener extends Listener

Listener which listens for CalendarEditEvents.

handle : {CalendarEditEvent : Object}

Closure that is executed when listener is fired.

MapClickedListener extends Listener

Listener which listens for MapClickedEvents.

handle : {MapClickedEvent : Object}

Closure that is executed when listener is fired.

MarkerClickedListener extends Listener

Listener which listens for MarkerClickedEvents.

handle : {MarkerClickedEvent : Object}

Closure that is executed when listener is fired.

MarkerDraggedListener extends Listener

Listener which listens for MarkerDraggedEvents.

handle : {MarkerDraggedEvent : Object}

Closure that is executed when listener is fired.

GeolocationListener extends Listener

Listener which listens for GeolocationEvents.

handle : {GeolocationEvent : Object}

Closure that is executed when listener is fired.

FireApplicationEventAction extends Action
event : { : ApplicationEvent}
NavigationAction extends Action

Action which allows to navigate to other target (e.g. todo, document, ...).

navigation : { : Navigation}

Closure which returns navigation target.

ActionABSTRACT

Abstract supertype for all Actions.

PersistAction extends Action

Persist action causes the data to be stored to database.

persistAction : { : Object}

Closure, which is executed after the persist happened.

ViewModelAction extends Action

Action performed on view mode.

clearViewModel : { : Set<UIComponent>}

Specified view models will be cleared.

mergeViewModel : { : Set<UIComponent>}

Specified view models will be merged.

viewModelInit : { : Object}

Closure, which is usually used to initialize view model after it was cleared.

SubmitAction extends Action

Action which causes submit of document or todo. With submit also persist is performed.

SaveAction extends Action

Save action which results in save of current todo or document.

saveAction : {Todo, SavedDocument : Object}

Closure, which receives saved document or todo object as parameter and is usually used to associate saved document\todo with business data.

ValidationErrorABSTRACT

Abstract supertype of all validation error types.

shownOn : Set<UIComponent>

Components, on which the validation error is shown (i.e. it might be automatically placed on some component based on binding).

DataValidationError extends ValidationError

Validation errors produced by contraints.

constraintViolation : ConstraintViolation
UIValidationError extends ValidationError

Validation errors produced by UI validators.

message : String

Error message.

placement : Set<UIComponent>

Components, on which validation error should be displayed.

MenuListener extends Listener

Listener which listens for MenuEvents.

handle : {MenuEvent : Object}

Closure that is executed when listener is fired.

ItemExpandedListenerDEPRECATED extends Listener
handle : {ItemExpandedEvent : Object}
ItemCollapsedListenerDEPRECATED extends Listener
handle : {ItemCollapsedEvent : Object}
TreeListener extends Listener

Listener which listens for TreeEvents.

handle : {TreeEvent : Object}

Closure that is executed when listener is fired.

PopupCloseRequestListener extends Listener

Listener which listens for PopupCloseRequestEvents.

handle : {PopupCloseRequestEvent : Object}

Closure that is executed when listener is fired.

TablePageSizeChangeListener extends Listener
handle : {TablePageSizeChangeEvent : Object}

Closure that is executed when listener is fired.

AsynchronousTextChangeListener extends Listener

Listener which listens for AsynchronousTextChangeEvents. The events are fired asynchronously, a new one can be fired even if the old one is still being processed.

handle : {AsynchronousTextChangeEvent : Object}

Closure that is executed when listener is fired.