The Properties tab contains basic properties of the screen:
- Module is a UI module the screen belongs to. If you change it, all screen files will be relocated under the new module's source root and registered in the appropriate screens.xml.
- Decsriptor is a path to the screen XML descriptor relative to the Module source root. When you change the path, Studio automatically moves the screen's controller and messages pack to ensure that they are located in the same directory as the XML descriptor.
- Id is the screen identifier, assigned to it in the screens.xml configuration file.
- Descriptor extends is a base screen identifier in case of a screen extension.
- Controller name is a fully qualified name of the controller class.
- Controller extends defines a base class of the screen controller. You can either select it from the set of known base classes, or enter a fully-qualified name of a custom class.
- Messages pack is the default messages pack of the screen.
- Caption is displayed in the application's main window when the screen is open. You can enter the caption text right into the field, or put it into the message pack by entering a message key with
msg://
prefix into the field and pressing button next to the field to localize the caption.
- Focus component receives focus right after the screen is open.
- Datasource is the main datasource that contains the entity instance being edited. This field is enabled and required only for editor screens extending
AbstractEditor
.
- Lookup component is used for entity instance selection. This field is enabled and required only for lookup screens extending
AbstractLookup
.
- Agent is the device type for which the screen is designed. You can create multiple screens with the same Id but different agents, so at runtime, the platform will select the most suitable screen layout depending on the current device.
- Multiple open enables to open multiple instances of this screen in separate main window tabs.
The Actions button allows you to manage the list of actions associated with the screen. Clicking the button opens the Actions window. To add a new action, click Add and set the following attributes:
- id - action ID, which should be unique within a given screen.
- invoke - the name of a controller method invoked when the action is executed.
- caption - a localizable caption, for example
msg://myAction
.
- icon - the reference to an icon, for example
icons/my_action.png
.
- shortcut - a keyboard shortcut to invoke the action, for example
CTRL-ALT-T
.
- enable - a checkbox that defines whether the action is enabled by default.
- visible - a checkbox that defines whether the action is visible by default.
Actions themselves are invisible, but they delegate properties to visual components associated with them.
The Timers button allows you to manage the list of timers associated with the screen.
The Dialog mode button allows you to control geometry and behaviour of the screen when it is opened as a dialog.