Brief: пользовательские представления
Выбор пользовательского представления
Пользовательское представление передаёт отрисовку клиентскому коду приложения, когда стандартная таблица, сводная таблица (PIVOT), календарь (CALENDAR) или карта (MAP) не подходят: нужна канбан-доска, лента карточек, расписание либо другое расположение или взаимодействие. Представления React подходят для новых представлений, а классические функции отображения остаются доступными для существующих представлений на JavaScript.
| Место | Что рисует клиентский код | Когда использовать |
|---|---|---|
custom контейнера DESIGN | Всё поддерево контейнера | Область формы со своим расположением и взаимодействием |
Собственный custom компонента | Таблицу дерева, тулбар, управляющие элементы фильтров, группу фильтров или фильтр по свойству на месте этого компонента | Заменить только эту часть формы |
CUSTOM свойства | Одно значение одного объекта в ячейке таблицы или на панели | Виджет для одного поля |
CUSTOM группы объектов | Строки одной группы на месте её таблицы | Другое представление одного списка с тулбаром и фильтрами платформы вокруг него |
CUSTOM окна WINDOW или NAVIGATOR CUSTOM | Содержимое окна или расположение окон | Меню, окно форм, панель сообщений или расположение окон приложения |
Это представления веб-клиента. На формах десктоп-клиент сохраняет стандартные представления и обычное поддерево контейнера. custom контейнера может быть и HTML-шаблоном: он размещает по именам потомков, которых рисует платформа, и не получает данных. Компонент React нужен, когда отрисовка должна читать данные или обеспечивать собственное взаимодействие.
Проекция формы
Компонент React получает props.data, проекцию формы: свойства, части групп объектов и записи дизайна, которые его представление рисует или размещает. У каждого контейнера React своя проекция. Обычные контейнеры DESIGN могут располагать несколько таких областей на одной форме.
Данные попадают в пользовательское представление через группы объектов с серверным листанием и фильтрами: строки группы в props.data.<g>.list для контейнера React, props.data.list для компонента React в CUSTOM, зарегистрированного как reactView, и список update для классического CUSTOM-представления группы объектов. Свойство JSON несёт значение одного объекта, а не группу объектов с постраничным чтением.
Проецируемое свойство несёт значение и атрибуты отображения. Проекция также несёт текущий объект и там, где представление их рисует, сортировки, фильтры, выделение и состояние тулбара. То, что продолжает рисовать платформа, компонент размещает, а не рисует заново из значений свойств.
Контроллеры представления и формы
Пользовательское представление получает данные и локальный контроллер того, что оно показывает. Компонент React получает этот контроллер как props.controller: его члены повторяют проекцию и меняют значения свойств, запускают действия формы, выбирают текущие объекты, меняют сортировки, фильтры и узлы дерева. За выбор и порядок строк и вычисления над ними по-прежнему отвечает форма. Изменения попадают в сессию изменений формы, как при редактировании стандартной таблицы.
Контроллер формы доступен как controller.form в представлениях React, классических представлениях и редакторах. Он по именам меняет то, что рисует другой контейнер или платформа, объединяет изменения в batch и предоставляет вызовы сервера (exec, change, eval, evalAction). CUSTOMS формы перечисляет действия и свойства, доступные для вызова из этой формы без открытия доступа через внешний HTTP API. Авторизация и форматы параметров определены в разделе вызова сервера.
Вне формы контроллер навигатора активирует элементы навигатора и предоставляет вызовы сервера. У такого вызова своя сессия, а не сессия открытой формы.
Отрисовка и поведение формы
Платформа предоставляет компоненты и хуки для представления React, поэтому клиентский код может рисовать свой интерфейс, используя данные и поведение формы:
| Статья | Возможности и их назначение |
|---|---|
| Отрисовка в React | List для строк, Buckets для размещения строк по визуальным ячейкам, useSeekOnScroll для листания при прокрутке, Image и Caption для изображений и заголовков платформы |
| Компоненты, которые рисует платформа | <Platform> размещает потомка или свойство строки, сохраняющее собственное представление и редактор, useShown сообщает, какие области показаны |
| Поведение формы в React | Фокус и загрузка формы, привязки клавиш и мыши, живые данные через SCHEDULE формы и скрытые представления |
| Деревья, сортировки и выделение в React | Узлы дерева, серверные сортировки, выделенные строки и колонки, копирование и вставка |
| Фильтры и тулбар в React | Пользовательские фильтры, фильтры по свойству (FILTER), фильтры представления, управляющие элементы фильтров, FILTERGROUP и операции тулбара |
Окна и расположение окон
Окна в React получают содержимое окна в props.data, а его операции — в props.controller. CUSTOM инструкции WINDOW выбирает отрисовщик окна, а EXTEND WINDOW ... CUSTOM меняет отрисовщик уже объявленного окна.
| Представление | Что получает и рисует |
|---|---|
| Окно навигатора | Свои элементы навигатора и контроллер навигатора, чей activate выбирает папку или запускает элемент. Компонент React рисует по данным, а HTML-шаблон размещает кнопки платформы |
Окно FORMS — System.forms или объявленное приложением | Свои открытые формы и операции их выбора и закрытия. Компонент React размещает формы с помощью <Platform> и рисует управляющие элементы вокруг них |
System.log | Сообщения журнала и операцию закрепления. Компонент React размещает разметку сообщений платформы с помощью <Platform> |
NAVIGATOR CUSTOM | Окна и контроллер навигатора. Компонент React задаёт размеры окон и размещает их с помощью <Platform>, заменяя стандартное расположение по POSITION |
Окна форм и сообщений принимают только компонент React: ему передаётся то, что держит окно, вместо элементов навигатора. Остальные NATIVE-окна не содержат элементов навигатора и не принимают ни компонента, ни шаблона. Пользовательские окна и расположение окон рисует только десктопный веб-клиент. Мобильный веб-клиент и десктопный клиент сохраняют стандартный интерфейс.
Классические функции отображения и редактирования
CUSTOM может передавать отрисовку классической JavaScript-функции отображения или компоненту React, явно зарегистрированному как reactView. Группа объектов использует CUSTOM renderFunction [OPTIONS optionsExpr] в блоках объектов, а свойство — CUSTOM renderFunction [CHANGE [editFunction]] в блоке свойств и действий.
Классическая функция отображения возвращает render, update и необязательную clear: платформа передаёт им элемент, локальный контроллер, а при обновлении — строки группы или одно значение свойства. Контроллер группы читает значения свойств и предоставляет изменение строк и свойств, обновление по изменениям через diff и серверные фильтры представления. Контроллер свойства меняет его значение и получает подсказки. Оба получают доступ к вызовам сервера через controller.form.
Функция редактирования заменяет редактирование одного значения независимо от его отображения: она может дополнить стандартное текстовое поле ввода, нарисовать редактор в ячейке или открыть оконный редактор. Её имя задаётся после CHANGE в CUSTOM свойства либо в блоке CUSTOM оператора INPUT. Контроллер редактора подтверждает или отменяет редактирование. Подтверждённые значения проходят через обычный канал изменения свойства. Она нужна, когда полю требуется собственный редактор, а остальное представление остаётся стандартным.
Клиентские модули JavaScript
Клиентские модули JavaScript содержат компоненты React, классические функции отображения и редактирования и функции, вызываемые действиями INTERNAL CLIENT.
| Проект | Где находится код и как он доступен |
|---|---|
| Со сборкой | .js, .jsx, .ts и .tsx в src/main/web. Каждый файл вне lib становится автоматически загружаемым собранным файлом, общие вспомогательные модули из lib подключаются через импорт. Именованные экспорты автоматически регистрируются под именами, которые использует код lsFusion |
| Без сборки | .js или .jsx в src/main/resources/web. web/init автоматически загружает файлы, не зависящие от порядка загрузки, остальные файлы перечисляются в onWebClientInit[STRING]. JSX преобразуется при выдаче файла. Скрипты используют общие глобальные имена вместо импорта локальных модулей |
React и ReactDOM предоставляет платформа. Компонент React для контейнера, окна или NAVIGATOR CUSTOM выбирается по идентификатору, начинающемуся с заглавной буквы. Компонент в CUSTOM свойства или группы объектов требует явной регистрации как reactView, даже если он экспортируется по имени. Классические функции используют тот же реестр window.lsfusion.custom, а имена на window служат запасным вариантом для существующих скриптов. CSS-модули дают стили, локальные для компонента, а CSS собранного модуля загружается вместе с ним.