Свойства UI

Общие

jmix.ui.composite-menu

Определяет, строится ли меню с элементами меню из установленных дополнений.

При установке в true в меню будут включены как элементы из menu.xml приложения, так и элементы из menu.xml каждого установленного дополнения, содержащего такой файл.

При установке в false в меню будут включены только те элементы, которые добавлены в menu.xml приложения.

Используйте Дизайнер меню Studio для управления структурой меню в обоих режимах.

Значение по умолчанию: true.

jmix.ui.default-max-fetch-size

Определяет для всех сущностей максимальное количество экземпляров, которые могут быть загружены на уровень UI.

Значение по умолчанию: 10000

См. также jmix.ui.entity-max-fetch-size.

jmix.ui.default-page-size

Определяет для всех сущностей количество элементов на странице по умолчанию для компонента simplePagination.

Значение по умолчанию: 50

См. также jmix.ui.entity-page-size.

jmix.ui.default-view-id

Задает экран, который будет открыт после входа в систему внутри главного экрана. Например:

jmix.ui.default-view-id = User.list

См. также jmix.ui.main-view-id.

jmix.ui.entity-max-fetch-size

Определяет для конкретной сущности максимальное количество экземпляров, которые могут быть загружены на уровень UI.

В следующем примере настраивается максимальный размер выборки для двух сущностей. Для всех остальных сущностей используется значение из jmix.ui.default-max-fetch-size.

jmix.ui.entity-max-fetch-size.Product = 500
jmix.ui.entity-max-fetch-size.Customer = 1000

jmix.ui.entity-page-size

Определяет для конкретной сущности размер страницы по умолчанию для компонента simplePagination.

В следующем примере настраивается размер страницы для двух сущностей. Для всех остальных сущностей используется значение по умолчанию из jmix.ui.default-page-size.

jmix.ui.entity-page-size.Product = 100
jmix.ui.entity-page-size.Customer = 500

jmix.ui.main-view-id

Идентификатор экрана, который будет использоваться в качестве главной страницы приложения.

Значение по умолчанию: main.

См. также jmix.ui.default-view-id.

jmix.ui.menu-config

Определяет путь к файлу menu.xml. Файл загружается с использованием интерфейса Resources, поэтому он может находиться в classpath или в каталоге конфигурации.

Например:

jmix.ui.menu-config = com/company/onboarding/menu.xml

jmix.ui.login-view-id

Идентификатор экрана, который будет использоваться в качестве страницы входа в приложение.

Значение по умолчанию: login.

jmix.ui.save-exported-byte-array-data-threshold-bytes

Определяет порог, в байтах, на котором байтовые массивы, загруженные через ByteArrayDownloadDataProvider, будут сохранены во временные файлы для предотвращения утечек памяти HTTP-сессии.

Значение по умолчанию: 102400

jmix.ui.use-session-fixation-protection

Определяет, будет ли сессия переинициализирована после входа, чтобы защититься от атак фиксации сессии.

Значение по умолчанию: true

jmix.ui.view-file-extensions

Для бина Downloader определяет список расширений файлов, которые будут отображаться во вкладке веб-браузера вместо автоматической загрузки.

Значение по умолчанию: [htm, html, jpg, png, jpeg, pdf]

jmix.ui.view.close-shortcut

Определяет клавишу быстрого доступа, которая используется для закрытия текущего экрана.

jmix.ui.view.save-shortcut

Определяет клавишу быстрого доступа, которая используется для сохранения изменений.

jmix.ui.view.create-action-adds-first

Определяет, будет ли созданная в диалоговом окне сущность добавлена в начало списка, а не в конец.

Значение по умолчанию: true

jmix.ui.view.reload-unfetched-attributes-from-lookup-views

Определяет, будет ли LookupBuilder перезагружать сущность после выбора ее из окна поиска, если выбранная сущность не содержит все необходимые атрибуты сущности.

Значение по умолчанию: true

jmix.ui.view.use-save-confirmation

Определяет, какие варианты отображаются в диалоговом окне при закрытии экрана с несохраненными изменениями в DataContext. В зависимости от этого свойства, экран деталей сущности вызывает либо метод showSaveConfirmationDialog(), либо showUnsavedChangesDialog() бина ViewValidation.

Если установлено значение true, диалоговое окно содержит три варианта: Save, Don’t save, Cancel.

Если установлено значение false, диалоговое окно содержит только два варианта: Yes - закрыть без сохранения и No - остаться и продолжить редактирование.

Значение по умолчанию: true.

jmix.ui.view.prevent-browser-tab-closing

Specifies whether a confirmation dialog is shown if a user attempts to close a browser tab, and the corresponding property of the view is also set to true using the setPreventBrowserTabClosing method.

Default value: false.

jmix.ui.view.validation-notification-duration

Определяет продолжительность (в миллисекундах) отображения уведомлений об ошибках валидации экрана.

Значение по умолчанию: 3000

jmix.ui.view.validation-notification-position

Устанавливает позицию уведомлений о валидации на странице. Возможные значения: TOP_STRETCH, TOP_START, TOP_CENTER, TOP_END, MIDDLE, BOTTOM_START, BOTTOM_CENTER, BOTTOM_END, BOTTOM_STRETCH.

Значение по умолчанию: BOTTOM_END

jmix.ui.view.validation-notification-type

Определяет вариант стандартных уведомлений об ошибках валидации экрана. Принимает одно из значений перечисления Notifications.Type: DEFAULT, ERROR, SUCCESS, SYSTEM, WARNING.

Значение по умолчанию: DEFAULT

jmix.ui.navigation.use-crockford-uuid-encoder

Определяет, используется ли Base32 Crockford Encoding для кодирования/декодирования UUID-параметров URL.

Значение по умолчанию: false

Компоненты

jmix.ui.component.default-notification-duration

Определяет продолжительность отображения уведомления, в миллисекундах.

Значение по умолчанию: 3000

jmix.ui.component.default-notification-position

Определяет позицию уведомления по умолчанию на странице. Возможные значения: TOP_STRETCH, TOP_START, TOP_CENTER, TOP_END, MIDDLE, BOTTOM_START, BOTTOM_CENTER, BOTTOM_END, BOTTOM_STRETCH.

Значение по умолчанию: MIDDLE

jmix.ui.component.entity-field-actions

Определяет действия, которые необходимо добавить в компонент выбора для указанной сущности в механизмах стратегии генерации, таких как параметры genericFilter или редактируемые ячейки dataGrid.

Например, чтобы использовать действия entity_lookup, entity_open и entity_clear в компонентах, выбирающих сущность User, задайте свойство следующим образом:

jmix.ui.component.entity-field-actions.User = entity_lookup, entity_open, entity_clear

jmix.ui.component.entity-field-fqn

Определяет компонент, используемый для выбора указанной сущности в механизмах стратегии генерации, таких как параметры genericFilter или редактируемые ячейки dataGrid.

Укажите полное имя класса (FQN) в качестве значения свойства. Например, чтобы использовать entityComboBox для выбора сущности User, задайте свойство следующим образом:

jmix.ui.component.entity-field-fqn.User = io.jmix.flowui.component.combobox.EntityComboBox

По умолчанию, общие механизмы используют компонент entityPicker.

Полное имя класса (FQN) для entityPicker - io.jmix.flowui.component.valuepicker.EntityPicker.

jmix.ui.component.filter-apply-shortcut

Определяет клавишу быстрого доступа для применения условий в компоненте genericFilter в том случае если они не применяются автоматически.

Например, можно отключить автоматическое применение условий в фильтрах и указать сочетание клавиш для применения их вручную:

jmix.ui.component.filter-auto-apply = false
jmix.ui.component.filter-apply-shortcut = ALT-ENTER

Это свойство может быть переопределено для конкретного компонента genericFilter с использованием его XML-атрибута applyShortcut.

jmix.ui.component.filter-auto-apply

При установке в true настраивает компоненты genericFilter на работу в режиме немедленного выполнения, при котором каждое изменение параметров автоматически перезагружает данные.

При установке в false перезагрузка происходит только после нажатия кнопки Refresh.

Это свойство может быть переопределено для конкретного компонента genericFilter с использованием его XML-атрибута autoApply.

Значение по умолчанию: true

jmix.ui.component.filter-configuration-unique-names-enabled

При установке в true проверяет уникальность имен для конфигураций фильтра созданных во время выполнения программы. В то же время позволяет задать одинаковые имена для конфигурации времени выполнения и конфигурации созданной на этапе разработки.

Обратите внимание, что конфигурации, созданные во время разработки, помечены звездочкой (*) для отличия их от конфигураций времени выполнения.

Значение по умолчанию: true

jmix.ui.component.filter-properties-hierarchy-depth

Определяет глубину иерархии свойств в редакторе "Добавить условие" в genericFilter. Например, если глубина равна 2, то можно выбирать атрибут сущности contractor.city.country, если значение равно 3, то contractor.city.country.name и так далее.

Это свойство может быть переопределено для конкретного компонента genericFilter с использованием его XML-атрибута propertyHierarchyDepth.

Значение по умолчанию: 2

jmix.ui.component.filter-show-configuration-id-field

Определяет, будет ли видно поле идентификатора конфигурации в диалоге сведений о конфигурации genericFilter.

Значение по умолчанию: false

jmix.ui.component.grid-add-shortcut

Определяет клавишу быстрого доступа, которая используется для выполнения действия list_add.

jmix.ui.component.grid-create-shortcut

Определяет клавишу быстрого доступа, которая используется для выполнения действия list_create.

jmix.ui.component.grid-edit-shortcut

Определяет клавишу быстрого доступа, которая используется для выполнения действия list_edit.

Значение по умолчанию: ENTER

jmix.ui.component.grid-read-shortcut

Определяет клавишу быстрого доступа, которая используется для выполнения действия list_read.

Значение по умолчанию: ENTER

jmix.ui.component.grid-remove-shortcut

Определяет клавишу быстрого доступа, которая используется для выполнения действия list_remove.

jmix.ui.component.pagination-items-per-page-items

Определяет варианты числа элементов на странице в компоненте simplePagination.

Для настройки пользовательского списка вариантов для конкретного экземпляра simplePagination используйте атрибут XML itemsPerPageItems.

Значение по умолчанию: [20, 50, 100, 500, 1000, 5000]

jmix.ui.component.picker-clear-shortcut

Определяет клавишу быстрого доступа, которая используется для очистки ввода компонента выбора.

jmix.ui.component.picker-lookup-shortcut

Определяет клавишу быстрого доступа, которая используется для открытия экрана поиска для компонента выбора.

jmix.ui.component.picker-open-shortcut

Определяет клавишу быстрого доступа, которая используется для открытия экрана деталей для выбранной сущности в компоненте выбора.

jmix.ui.component.show-error-message-below-field

Управляет отображением сообщений об ошибках непосредственно под полями. Значение по умолчанию - true, то есть сообщения об ошибках отображаются под соответствующими полями. Установка этого свойства в false скрывает эти встроенные сообщения; вместо них появляется уведомление, содержащее все ошибки, когда пользователь нажимает кнопку OK (или аналогичную кнопку отправки).

Значение по умолчанию: true.

Фоновые задачи

jmix.ui.background-task.task-killing-latency

Определяет время ожидания после которого фоновые задачи, которые не обновляют свой статус, завершаются (время выполнения задачи плюс время задержки). Если суффикс длительности (ns, us, ms, s, m, h и d для наносекунд, микросекунд, миллисекунд, секунд, минут, часов и дней соответственно) не указан, будут использоваться секунды.

Значение по умолчанию: 60

jmix.ui.background-task.threads-count

Определяет количество потоков для исполнения фоновых задач.

Значение по умолчанию: 10

jmix.ui.background-task.timeout-expiration-check-interval

Определяет интервал проверки срока действия фоновых задач. Если суффикс длительности (ns, us, ms, s, m, h и d для наносекунд, микросекунд, миллисекунд, секунд, минут, часов и дней соответственно) не указан, будут использоваться миллисекунды.

Значение по умолчанию: 5000