CUBA Platform. Developer's Manual
4.5.2. Visual Components Library

Possible values are:

An attribute setting a visual component's caption.

Attribute value can either be a message string or a key for the message pack. In case of a key, the value should begin with msg://prefix.

If captionProperty is not defined, names of instances contained in a list will be shown.

The attribute contains a description of an action that will be executed when a user clicks in a cell or a field (for the FieldGroup component). Two types of actions are possible:

Sets the number of extra grid columns that the component should occupy (default is 1).

This attribute can be defined for any component located immediately within a GridLayout container.

Intended for setting a data source, described in a dsContext section of a screen XML-descriptor.

When setting a datasource attribute for a component implementing a DatasourceComponent interface, a property attribute should also be set.

An attribute defining hint text for a component.

An attribute indicating that the component’s content can be edited (do not mix with enable).

Possible values − true, false. Default value is true.

Ability to edit content of a component linked to data (inheritor of DatasourceComponent or ListComponent) is also influenced by the security subsystem. If the security subsystem data indicates that a component should not be editable, the value of its editable attribute will be ignored.

An attribute defining component state:

If a component is disabled, it does not accept input focus. Disabling a container disables all of its components as well. Possible values are true, false. By default all components are enabled.

Defines a component within a container that should be expanded to cover all available space in the directions of component placement. For a container with components vertical placement, this attribute sets 100% height to a component; for the containers with horizontal placement - 100% width. Additionally, resizing a container will also resize this component.

Can be set in pixels or in percents of the parent container height. For example: 100px, 100%, 50. If it is specified without units, pixels are assumed.

Setting a value in % means that the component will occupy the corresponding height within an area provided by the parent container.

When set to AUTO or -1px, a default value will be used for the component height. For a container, height is defined by the content, according to a sum of heights of all nested components.

Attribute value should contain a path to an icon file relative to the themes folder. For example::

icon="icons/create.png"

If the icon should be changed depending on the user’s language, you can set a path to it in the messages package and specify a message key in an icon attribute, for example:

icon="msg://addIcon"

Font elements of Font Awesome can be used instead of files in web client with Halo theme (or derived from it). For this, specify the name of the required constant of the com.vaadin.server.FontAwesome class in the icon property with the font-icon: prefix, for example:

icon="font-icon:BOOK"

It’s recommended that values are generated using the rules for Java-identifiers and camelСase is used, for example, userGrid, filterPanel. It can be specified for any component and should be unique within a screen.

Defines a string which is displayed in the field when its value is null.

The attribute is used for TextField, LookupField, LookupPickerField, SearchPickerField components in web client only.

margin attribute defines indentation between the outer borders and the container content.

Selection of this option is equal to setting the null value.

Attribute is used for LookupField, LookupPickerField, and SearchPickerField components.

Example for a LookupField, component, setting an attribute value in an XML-descriptor:

<lookupField datasource="orderDs"
             property="customer"
             nullName="(none)"
             optionsDatasource="customersDs" width="200px"/>

Example for a LookupField, component, setting an attribute value in a controller:

<lookupField id="customerLookupField" optionsDatasource="customersDs"
             width="200px" datasource="orderDs" property="customer"/>

customerLookupField.setNullOption("<null>");

Sets the name of a data source, used to generate a list of options.

captionProperty attribute can be used together with optionsDatasource.

An attribute of a component implementing a DatasourceComponent interface.

It is intended to set the name of an entity attribute which value will be displayed and edited using this visual component.

It is always used together with a datasource attribute.

An attribute of a visual component implementing a Field interface. Identifies that this field requires a value.

Possible values − true, false. Default is false.

requiredMessage attribute can be used together with required.

An XML-attribute used together with a required attribute. It allows setting a message that will be displayed to a user when the required rule is not fulfilled..

An attribute should contain a key of a message from a package, for example: requiredMessage="msg://infoTextField.requiredMessage"

Sets the number of additional grid lines that the component should occupy (default is 1).

This attribute can be set for any component located immediately within a GridLayout container.

spacing attribute sets spacing between components within a container.

Possible values − true, false.

By default spacing is disabled.

An attribute defining a style name for a component.

An attribute setting component visibility. Possible values − true, false.

If a container is invisible all its components are invisible. By default all components are visible.

An attribute defining component width.

The value can be set in pixels or in percents of the width of the parent container. For example: 100px, 100%, 50. If specified without units, pixels are assumed. Setting a value in % means that the component will occupy the corresponding width within an area provided by the parent container.

When set to AUTO or -1px, a default value will be used for a component width. For a container, width is defined by the content, according to the sum of widths of all nested components.