View Designer

Дизайнер экранов представляет собой ряд панелей и окон инструментов, которые позволяют разрабатывать макет экрана и задавать свойства компонентов пользовательского интерфейса в стиле WYSIWYG. Редактор XML экранов интегрирован с Дизайнером экранов, поэтому XML-файл можно редактировать напрямую или использовать панели дизайнера для генерации кода.

Для этой функции требуется подписка RAD или Enterprise. Если у вас нет подписки, см. как получить пробную версию.

Панель Jmix UI реализована как независимое окно инструментов IDE и отображается автоматически при открытии дескриптора экрана в редакторе.

Панель Jmix UI состоит из панели иерархии и панели инспектора.

Source Code Editor - редактор исходного кода
Top Actions Panel - верхняя панель действий
Layout Preview Panel - панель предварительного просмотра компоновки
Jmix UI Hierarchy Panel - панель иерархии компонентов Jmix UI
Jmix UI Inspector Panel - панель инспектора Jmix UI

Панель предварительного просмотра компоновки

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

Используйте кнопки в правом верхнем углу редактора компоновки экрана.

Editor only - в редакторе отображается только исходный код.
Editor and Preview - пространство редактора разделено так, чтобы отображать и исходный код, и предварительный просмотр.
Preview only - в редакторе отображается только предварительный просмотр.
Preview in Window - исходный код отображается в редакторе, а предварительный просмотр отображается в отдельном окне.

Панель имеет несколько элементов управления, расположенных в правом верхнем углу:

Кнопка Restart → Just Restart перезагружает содержимое страницы предварительного просмотра.
Кнопка Restart → Clean and Restart очищает все фронтенд-файлы и заново запускает сборку фронтенда.
Кнопка Console открывает или закрывает консоль с выводом сборки фронтенда, что может помочь в диагностике проблем.
Выпадающий список Theme позволяет вам выбрать одну из предопределенных тем: светлую или темную.

Палитра компонентов

Вы можете открыть палитру компонентов, используя следующие способы:

Нажмите на кнопку Add Component на верхней панели действий:
Щелкните правой кнопкой мыши на пункте Add Component в контекстном меню панели иерархии Jmix UI:
Используя ⌘N на MacOS или Alt+Insert на Windows и Linux, откройте меню Generate:

Палитра компонентов отображает набор доступных элементов экрана: визуальные компоненты, контейнеры, HTML компоненты, компоненты данных - контейнеры и загрузчики, фасеты, в том числе действия и настройки диалоговых окон.

Используйте поле поиска, чтобы найти необходимый компонент.

Чтобы добавить компонент в макет, перетащите его из палитры в соответствующее место в исходном коде XML или на панель иерархии Jmix UI.

Щелкните правой кнопкой мыши по компоненту в палитре, чтобы открыть контекстное меню со следующими действиями:

Add to Design - добавляет выбранный компонент на экран внутри выбранного элемента в иерархии.
Jmix Documentation - открывает страницу документации компонента.

Панель иерархии Jmix UI

На панели иерархии Jmix UI отображается дерево компонентов, добавленных в компоновку.

Вы можете перемещать элементы из палитры компонентов или изменять порядок элементов в дереве. Когда элемент выбран, на панели инспектора Jmix UI отображаются его свойства.

Щелкните правой кнопкой мыши по элементу, чтобы открыть его контекстное меню со следующими действиями:

Add Component открывает палитру компонентов.
Inject to Controller инжектирует компонент в контроллер экрана или переходит к существующему объявлению инжектирования.
Generate Handler используется для генерации обработчика для компонента.
Go to XML позволяет перейти к тегу XML в исходном коде.
Delete, Copy, Cut или Paste удаляет, копирует, вырезает или вставляет элемент.

Панель инспектора Jmix UI

На панели инспектора Jmix UI отображаются вкладки Properties и Handlers.

Для некоторых типов выбранных элементов отображается кнопка + Add, которая позволяет добавить соответствующий подэлемент, например, действие таблицы, колонку, форматер, валидатор и так далее.

Чтобы добавить действие компонента entityPicker или действие компонента valuePicker, выберите соответствующий компонент в XML-дескрипторе экрана или на панели иерархии Jmix UI и нажмите Add → Action в панели инспектора Jmix UI. Появится диалоговое окно Add Action:

Выберите какое-нибудь стандартное действие из списка.

Чтобы добавить пользовательское декларативное действие, выберите New Base Action и нажмите OK. Появится диалоговое окно BaseAction Required Properties:

Затем реализуйте пользовательскую логику в контроллере экрана, подписавшись на ActionPerformedEvent.

Чтобы добавить действие с коллекцией, выберите компонент dataGrid или treeDataGrid в XML-дескрипторе экрана или на панели иерархии Jmix UI и нажмите Add → Action в панели инспектора Jmix UI. Появится диалоговое окно Add Action:

Чтобы добавить column, выберите компонент dataGrid или treeDataGrid в XML-дескрипторе экрана или на панели иерархии Jmix UI и нажмите Add → Columns → Column на панели инспектора Jmix UI. Появится диалоговое окно Add Column:

Этот список содержит свойства, которые включены в фетч-план, но еще не отображены компонентом dataGrid.

Вкладка Properties

Вкладка Properties показывает атрибуты выбранного элемента экрана и позволяет их редактировать.

Некоторые свойства имеют значения по умолчанию, которые выделены серым цветом.

Используйте поле поиска, чтобы найти необходимый атрибут.

Атрибуты по умолчанию упорядочены по имени. В первой колонке перечислены имена атрибутов для выбранного компонента. Во второй колонке на вкладке Properties отображаются значения свойств следующим образом:

Когда свойство выбрано, значение сменяется полем редактирования, в котором можно ввести новое значение.
Если значение представляет собой список, при выборе свойства появляется кнопка выпадающего списка.
Если значение является логическим, его можно изменить с помощью флажка:

Такие свойства, как title, label, helperText, имеют возможность задавать локализованные имена. Нажмите кнопку , чтобы открыть диалоговое окно, в котором можно задать локализованное сообщение для атрибута.

Нажмите кнопку для свойства themeNames, чтобы открыть диалоговое окно ThemeNames Property Editor:

Вкладка Handlers

На вкладке Handlers отображаются слушатели событий и делегаты компонентов, которые могут быть связаны с выбранным компонентом. Чтобы сгенерировать необходимый метод слушателя, просто дважды щелкните соответствующую строку.

Вы будете перенаправлены на контроллер экрана с фрагментом кода.

Верхняя панель действий

Панель действий расположена в верхней части редактора исходного кода. Она предоставляет доступ к следующим действиям:

Controller - переходит к контроллеру экрана.
<entity class name> - отображается, если экран представляет собой экран списка или экран деталей сущности и позволяет перейти к сущности, связанной с текущим экраном.
Add Component - открывает палитру компонентов:

Кроме того, вы можете переключаться между дескриптором и контроллером экрана с помощью маркера на поле слева.