UI Component Generation

This page is used for UI component files generation.

The page consists of 3 main blocks.

The first one is used for selecting a UI component type. Studio can generate stubs for 3 types of UI components:

The second block is used for defining a type-specific set of properties.

The third block is common for all component types and defines parameters for the integration into the cuba GUI. Its fields are described in the end of this help page

Vaadin add-on component type

Add-on maven dependency - defines add-on maven coordinates here. You can define coordinates in 2 formats:

Inherited widget set - add-on widget set name, that should be inherited in your project widgetset descriptor. Example: org.vaadin.risto.stepper.widgetset.StepperWidgetset. You can find this value in the add-on source code or documentation.

JavaScript component type

Vaadin component for integration with JavaScript library and a connector file stub will be created.

Vaadin component class name - a class name for vaadin component that will be generated.

New GWT component type

A set of files for new GWT widget and vaadin component that is integrated with this widget will be generated.

Vaadin component class name - a class name for vaadin component that will be generated.

Generic UI integration block

Integrate into generic UI - this checkbox defines whether the created component should be integrated into the platform generic UI. If checked then the following operations will be performed:

Component name in screen XML - a tag name that will be used in screen XML descriptors

Component interface name - a name of the component interface in gui module.

FQN of vaadin component from add-on - this option is available for the 'Vaadin add-on' component type only. If the field is not empty then the 'component' property of the web-component implementation will be initialized by the instance of defined class. The value should be taken from add-on documentation or source code.