Backoffice UI Properties
jmix.ui.app-window-mode
Determines an initial mode for the main application window – TABBED
or SINGLE
. In the SINGLE
mode, when a screen opens with the NEW_TAB
parameter, it completely replaces the current screen instead of opening a new tab.
Default value: TABBED
.
jmix.ui.data-grid.default-column-max-width
Defines the maximum allowed pixel width of the DataGrid column when it is set to expand. It can be overridden for a concrete column using the maximumWidth XML attribute.
Default value: -1
. The value of -1
means there is no limitations.
jmix.ui.data-grid.default-column-min-width
Defines the minimum guaranteed pixel width of the DataGrid column when it is set to expand. It can be overridden for a concrete column using the minimumWidth XML attribute.
Default value: 10
.
jmix.ui.default-screen-can-be-closed
Defines whether the default screen can be closed by close button, ESC button or TabSheet
context menu when TABBED
work area mode is used.
Default value: true
.
jmix.ui.default-screen-id
Defines a screen to be opened after login. This setting will be applied to all users.
For example:
jmix.ui.default-screen-id = sample_Order.browse
jmix.ui.component.entity-field-actions
Defines actions to be added to the selection component for the specified entity in generic mechanisms like Filter parameters or editable cells of Table and DataGrid.
For example, to use EntityLookupAction, EntityOpenAction and EntityClearAction in the components selecting the uiex1_City
entity, set the property as follows:
jmix.ui.component.entity-field-actions.uiex1_City = entity_lookup,entity_open,entity_clear
jmix.ui.component.entity-field-type
Defines the component to be used for selecting the specified entity in generic mechanisms like Filter parameters or editable cells of Table and DataGrid. This component should implement the EntityPicker
interface.
Specify the component’s XML name as a value of this property. For example, to use EntityComboBox for selecting the uiex1_City
entity, set the property as follows:
jmix.ui.component.entity-field-type.uiex1_City = entityComboBox
By default, generic mechanisms use the EntityPicker component.
jmix.ui.main-screen-id
An identifier of a screen to be used as main screen of the application.
Default value: MainScreen
.
jmix.ui.max-tab-count
Defines the maximum number of tabs that can be opened in the main application window. The value of 0 disables this limitation.
Default value: 20
.
jmix.ui.login-screen-id
An identifier of a screen to be used as login screen of the application.
Default value: LoginScreen
.
jmix.ui.component.combo-box-page-length
Defines the default number of options on one page of the drop-down list in the ComboBox and EntityComboBox components. It can be overridden for a concrete instance of the component using the pageLength XML attribute.
Default value: 10
.
jmix.ui.component.filter-auto-apply
When set to true
, the Filter component works in the immediate mode when every change of filter parameters automatically reloads data. When set to false
, filter will be applied only after the Refresh button is clicked. This property can be overridden for a concrete instance of the Filter
component using the autoApply XML attribute.
Default value: true
.
jmix.ui.component.filter-columns-count
Sets the default number of columns for placing conditions on the filter panel. It can be overridden for a concrete instance of the Filter
component using the columnsCount XML attribute.
Default value: 3
.
jmix.ui.component.filter-properties-hierarchy-depth
Defines the properties hierarchy depth in the Add Condition editor in filter. For example, if the depth value is 2, then you can select an entity attribute contractor.city.country
, if the value is 3, then contractor.city.country.name
, etc.
Default value: 2
.
jmix.ui.component.filter-show-configuration-id-field
Determines whether the Configuration id field should be visible in the Configuration editor screen of the Filter
component. By default, the Configuration id field is not shown, and the configurationId
is generated depending on the configurationName
.
Default value: false
.
jmix.ui.component.html-sanitizer-enabled
Determines whether the HtmlSanitizer
bean should be used by the UI components implementing the HasHtmlSanitizer
interface to prevent cross-site scripting (XSS) in HTML content. The sanitization can also be enabled or disabled by individual components using htmlSanitizerEnabled attribute.
Default value: true
.
jmix.ui.component.pagination-items-per-page-options
Defines the options for the drop-down list that can be used as a number of items per page for Pagination. To configure a custom list of options for a concrete instance of the Pagination
component, use the itemsPerPageOptions XML attribute.
Default value: 20
, 50
, 100
, 500
, 1000
, 5000
.
jmix.ui.component.upload-field-max-upload-size-mb
Maximum file size (in megabytes) that can be uploaded using the FileUploadField, FileMultiUploadField, FileStorageUploadField components.
Default value: 20
.
jmix.ui.screen.close-shortcut
Defines the keyboard shortcut that closes the current screen.
Default value: ESCAPE
.
jmix.ui.screen.use-save-confirmation
Defines the layout of the dialog displayed when a user attempts to close a screen with unsaved changes in DataContext
.
Value of true
corresponds to a layout with three possible actions: "Save changes", "Don’t save", "Don’t close the screen".
The value of false
corresponds to a form with two options: "Close the screen without saving changes", "Don’t close the screen".
Default value: true
.
jmix.ui.theme-config
Defines a <theme-name>-theme.properties
file or files that store theme variables, such as default popup window dimensions and input field width.
Default value:
io/jmix/ui/theme/helium-theme.properties \
io/jmix/ui/theme/halo-theme.properties \
io/jmix/ui/theme/hover-theme.properties
jmix.ui.theme.default-mode-to-use
Defines the name of the color preset to be used if no other settings are available. Either cookie or user settings obtained from UserSettingService
have precedence over this value.
jmix.ui.theme.default-size-to-use
Defines the name of the theme size preset to be used if no other settings are available. Either cookie or user settings obtained from UserSettingService
have precedence over this value.
jmix.ui.theme.modes
Defines the list of available theme modes, that is, color presets. Default modes are light
and dark
.
Default value:
jmix.ui.theme.modes = light, dark
jmix.ui.theme.sizes
Defines the list of available theme size presets. Default theme size presets are small
, medium
, large
.
Default value:
jmix.ui.theme.sizes = small, medium, large
jmix.ui.theme.name
Defines the name of the theme used as default. See also jmix.ui.theme-config.
Default value: helium
.
jmix.ui.url-handling-mode
Defines how URL changes should be handled.
Possible values are the elements of UrlHandlingMode
enumeration:
-
NONE
- URL changes are not handled at all; -
URL_ROUTES
- changes are handled by the URL History and Navigation feature.
Default value: URL_ROUTES
.
jmix.ui.background-task-timeout-check-interval
Defines interval in ms for checking timeout of a Background Task.
Default value: 5000
.
jmix.ui.background-task.threads-count
Defines number of a Background Task threads.
Default value: 10
.