Uicommon

SelectItem

A single option for components that present a list of selectable items (combobox, select list etc.).

value : Object

Value itself.

label : String

Label for the value.

GeographicCoordinates

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.

ResourceConverter

A converter interface which provides a method to convert a value to a resource.

convert(value : Object) : Resource

Converts a value to a resource.

Parameters:

value the value to convert to a resource

StringToExternalResourceConverter

A converter which converts a string value to an ExternalResource.

convert(value : Object) : ExternalResource

Converts a String value to an external resource.

Parameters:

value the value to convert to a resource

Returns:

the external resource

StringToThemeResourceConverter

A converter which converts a string value to a ThemeResource.

convert(value : Object) : ThemeResource

Converts a String value to a theme resource.

Parameters:

value the value to convert to a resource

Returns:

the theme resource

DateEditor extends Editor

Definition of a date editor for the grid cell date values.

formatPattern : String

The date format pattern. For the format pattern syntax see http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html

resolution : DateTimeResolution

The resolution of the date fields used by the editor. The finer the resolution the more precise date/time can be set through the editor.

EnumerationEditor extends Editor

Definition of the enumeration editor for the enumeration values.

NumberEditor extends Editor

Definition of a number editor for the grid cell values which represent numbers.

formatPattern : String

The number format pattern. For the format pattern syntax see https://docs.oracle.com/javase/7/docs/api/java/text/DecimalFormat.html.

Editor^ABSTRACT

This abstract record type defines grid cell editor definition. Records extending this type provide definition of grid cell editors.

FileResource extends DownloadableResource

Provides contents of given File.

file : { : File}

When asked, the resource runs given closure in database transaction. The file contents are then served back to the client.

FileResource(file : { : File}) ^CONSTRUCTOR

FileResource(file : File) ^CONSTRUCTOR

fromModule(module* : String, path* : String) : FileResource

Loads given file from the module.

Parameters:

module the module name
path the path, e.g. "images/image_15596.png"

FontAwesome extends Resource

The Font Awesome resource, renders as a single Font Awesome characters. This type of resource is not downloadable (it has no downloadable byte stream content like PNG does, for example) and it may only be usable for #setIcon().

name : String

The name of the icon in the Font Awesome font. Please see https://fortawesome.github.io/Font-Awesome/icons/ for a list of available icons. This string must be a lowercase string, separated with dashes. Either name or codepoint must be non-null.

codepoint : Integer

The code of the icon in the Font Awesome font. Please see https://fortawesome.github.io/Font-Awesome/icons/ for a list of available icons. Either name or codepoint must be non-null.

fontFamily : String

Some font awesome icons are found in both regular and solid icon sets. Use font family to specify which set should be used. Regular set is denoted by "far" and solid set by "fas".

FontAwesome(codepoint : Integer) ^CONSTRUCTOR
FontAwesome(name : String) ^CONSTRUCTOR
FontAwesome(fontFamily : String, codepoint : Integer) ^CONSTRUCTOR
FontAwesome(fontFamily : String, name : String) ^CONSTRUCTOR

ExternalResource extends DownloadableResource

url : String

A resource which may be found on another site. Use this resource to navigate in Links.

ExternalResource(url : String) ^CONSTRUCTOR

ThemeResource extends DownloadableResource

Loads images and files from your currently selected Vaadin Theme.

resourceId : String

The resource ID available in your current Vaadin theme. For example if the resourceId is "img/themeimage.png", the the full class-path name of the icon will be "VAADIN/themes/mytheme/img/themeimage.png"

ThemeResource(resourceId : String) ^CONSTRUCTOR

Resource^ABSTRACT

An abstract resource. The hierarchy is closed - please do not add your own custom resources, they will not work.

DownloadableResource^ABSTRACT extends Resource

Resources of this type are able to provide a file with a byte array content. Only resources of this type can be downloaded via the Link component, or displayed via the Image component.

DateTimeResolution

Resolution for date fields.

Second
Minute
Hour
Day
Month
Year

DownloadStyle

Link
Button

Orientation

Horizontal
Vertical