Окна в React
Вне формы компонент React может рисовать окно вместо его стандартной отрисовки — окно навигатора, окно форм, окно сообщений, — а также располагать окна на рабочем столе вместо стандартного расположения. Как и представление React формы, такой компонент получает данные в props.data и контроллер в props.controller, а то, что рисует платформа, размещает через <Platform name/>.
Окно навигатора
Компонент React может рисовать и окно навигатора — само меню — вместо стандартной панели. Имя компонента задаётся WINDOW, а данными компонента становятся элементы, помещённые в это окно:
WINDOW appMenu VERTICAL POSITION(0, 6, 20, 94) HIDETITLE CUSTOM 'AppMenu';
NAVIGATOR {
NEW FOLDER sales 'Продажи' WINDOW appMenu PARENT {
NEW orders;
NEW invoices;
}
}
EXTEND WINDOW задаёт компонент существующему окну:
EXTEND WINDOW System.toolbar CUSTOM 'AppMenu';
Окну тогда не выдаются классы, которыми стандартная панель раскладывает свою полосу: при вертикальной панели навигации System.logo, System.root и System.system не выравнивают свои элементы по началу, а System.logo не подгоняет значок под высоту горизонтальной полосы — собственная разметка компонента сохраняет раскладку, которую он ей задаёт.
props.data — собственные элементы этого окна по каноническому имени. Канонические имена содержат точки, поэтому они являются ключами отображения, а не полями:
| Поле | Значение |
|---|---|
root | Канонические имена элементов, рисуемых на верхнем уровне, в порядке отображения |
byName | Каждый элемент по каноническому имени |
а каждый элемент содержит:
| Поле | Значение |
|---|---|
name | Собственное каноническое имя, чтобы компонент, получивший одну запись, мог обратиться к элементу |
caption, elementClass | Заголовок и CSS-класс, текущие — выражение HEADER или CLASS применяется по мере изменения. Заголовок рисуется через <Caption value={e.caption}/> |
image | Значок, рисуется через <Image value={e.image}/> — см. Отрисовка изображения — либо null |
folder | Является ли элемент папкой, а не действием |
hidden | Скрыт ли он сейчас через SHOWIF. В отличие от стандартной панели, которая такой элемент просто не рисует, проекция его сохраняет, и компонент сам решает, как с ним поступить |
selected | Является ли он выбранным элементом этого окна |
children | Канонические имена его потомков, которые рисует это окно |
Элемент, объявленный NOCUSTOM, рисует платформа, поэтому то, что она рисует, не проецируется: в его записи остаются name, caption, image, hidden, children и platformDrawn: true, и больше ничего. Пока его hidden — true, <Platform> скрывает место его кнопки.
Окно получает те элементы, за которые отвечает: элемент, ушедший в другое окно, и поддерево, отсечённое потому, что его родитель не выбран, отсутствуют — по тому же правилу, по которому определяется содержимое стандартной панели. Всё, что это правило оставило, проекция сохраняет, скрытое оно или нет. Компонент отрисовывается, когда навигатор определил элементы окна, и окно без элементов тоже отрисовывается — с пустым root. props.controller — контроллер навигатора, чей activate делает то же, что нажатие на элемент: выбирает папку либо выполняет действие.
Поэтому окно может получить элементы, которых модуль не объявлял. WINDOW у папки называет окно её потомков, и потомок, попавший в другое окно, рисуется там, пока папка выбрана. В штатном приложении так устроено «Администрирование»: сама папка лежит в System.system, а её разделы объявлены с WINDOW toolbar PARENT, поэтому, пока она выбрана в верхней панели, их вместе с их потомками рисует окно System.toolbar — после EXTEND WINDOW System.toolbar CUSTOM это ваш компонент. Компонент, который рисует только известные ему элементы, такие разделы потеряет. Всё, что окну досталось, обходится через root и children.
Стандартная кнопка
Элемент, который компонент не хочет рисовать сам, помещается через <Platform name/> — тот тег, которым на форме размещается потомок дизайна, где name — каноническое имя элемента. Платформа ставит внутрь свою кнопку, со своим значком, заголовком, подсказкой и поведением при нажатии, но без того, что к ней добавляет расположение стандартной панели: её заголовок не скрывается до наведения мыши на окно, как в незакреплённом навигаторе, и у неё нет отступа по глубине. Где кнопка находится и как показывается её глубина, решает компонент. Сам узел остаётся таким, каким его нарисовал компонент, без пометок, которые получает узел на форме.
NOCUSTOM выбирает кнопку платформы:
NAVIGATOR {
Sale.sales NOCUSTOM;
}
Пять ошибок сообщаются прямо на странице: имя, которого нет ни у одного элемента навигатора, имя без NOCUSTOM — такой элемент компонент должен рисовать сам, по проекции, — имя элемента, который рисует другое окно, имя, которое размещает второй <Platform>, и передача row в <Platform>, хотя кнопка размещается целиком. Имя, которое окно сейчас просто не рисует — элемент, скрытый SHOWIF, отсечённый потому, что его родитель не выбран, — ошибкой не является и не сообщается: место ждёт, а заполняется, как только окно начнёт рисовать этот элемент. До тех пор место элемента, скрытого SHOWIF, скрыто, как говорит hidden его записи, а место отсечённого, у которого записи нет, остаётся пустым. То, в каком окне рисуется элемент, к таким случаям не относится: ждать кнопку, которой владеет другое окно, пришлось бы вечно.
HTML-шаблон вместо компонента
EXTEND WINDOW System.toolbar CUSTOM
'<div class="menu"><div class="menu-head">Справочники</div><Platform:items><Platform:partners></div>';
Компонент остаётся нужен тогда, когда разметка зависит от того, что компонент читает сам.
Окно форм
Компонент React может рисовать и окно, в котором открываются формы, вместо стандартных вкладок. Окну WINDOW System.forms задаётся имя компонента, а его данными становятся открытые формы - и так же любому другому окну FORMS, которое объявило приложение: ему передаются формы, открытые в него оператором SHOW ... WINDOW windowName:
EXTEND WINDOW System.forms CUSTOM 'FormsBoard';
Форму компонент не рисует никогда: он рисует место для той формы, которую хочет показать, а платформа переносит туда её собственное представление. Этим местом и является <Platform name/>, где name — имя, которое проекция даёт форме. Представление формы он размещает так же, как размещает дочерний элемент дизайна и элемент навигатора. Как и узел размещения дочернего элемента дизайна, это место несёт метки — класс lsf-platform и data-lsf-sid с именем формы, — а представление формы заполняет его. Форме, место которой изменило размер, об этом сообщается.
Прямо на странице сообщается о трёх ошибках: имя, которого нет ни у одной открытой формы, второй <Platform> для той же формы и передача row в <Platform>, хотя форма размещается целиком.
props.data — открытые формы и состояние самого окна. Компонент отрисовывается сразу вместе с окном, до открытия какой-либо формы, — open тогда пуст, — поэтому то, что показывается, пока ничего не открыто, рисует он сам:
| Поле | Значение |
|---|---|
open | Имена открытых форм в том порядке, в котором их показывает стандартная полоса |
byName | Каждая форма по имени |
editMode | Имя выбранного режима редактирования — того, который выбирает кнопка режима на панели платформы и который сохраняется между сеансами. Режим, включённый удержанием Ctrl, Shift или Alt, действует, пока клавиша нажата, и editMode не меняет |
editModes | Все режимы редактирования в том порядке, в котором их предлагает кнопка режима |
fullScreen | Развёрнуто ли System.forms на весь экран, когда страница рисует его одно; компонент другого окна форм всегда получает false |
и каждая форма несёт:
| Поле | Значение |
|---|---|
name | Собственное имя, чтобы компонент, которому передали только запись, всё равно мог обратиться к форме |
canonicalName | Каноническое имя формы — для компонента, который рисует конкретную форму по-своему |
caption, image | Заголовок и значок, текущие: заголовок, который показывает вкладка, и его значок. Рисуются через <Caption value={e.caption}/> и <Image value={e.image}/> |
selected | Является ли форма текущей в этом окне — той, которую показала бы его стандартная полоса. Клавиатура работает в ней, если это окно получает ввод с клавиатуры. Из нескольких окон FORMS такой ввод может получать только одно |
loading | Не пришла ли форма ещё с сервера. Пока не пришла, caption — тот, который нёс запрос на её открытие, а image пуст; остальные поля записи на месте, как всегда |
blocked | Открыта ли поверх этой формы форма, вызванная из неё. Такую форму закрыть нельзя — поэтому стандартная вкладка выключает у неё кнопку закрытия |
а каждый режим редактирования в editModes — то, чем его показывает кнопка режима:
| Поле | Значение |
|---|---|
name | Собственное имя режима — то, которое принимает setEditMode, и то, с которым сравнивается editMode |
caption, image | Название режима и его значок. Рисуются через <Caption value={m.caption}/> и <Image value={m.image}/> |
props.controller содержит методы контроллера навигатора — exec, eval, evalAction, change, activate — для вызовов в сессии навигатора. Он также делает то, что с открытой формой может сделать только платформа: select(name) делает её текущей — так же, как щелчок по её вкладке, — а close(name) просит её закрыться, как её кнопка закрытия. Закрытие — это просьба: форма с несохранёнными изменениями сначала спросит пользователя и может остаться открытой, поэтому форма исчезает из open тогда, когда действительно закрылась, а не когда был вызван close.
select, close, closeAll, setEditMode и toggleFullScreen ничего не возвращают, поэтому await controller.close(name) не ждёт закрытия формы. Изменения читаются из props.data: select, setEditMode и toggleFullScreen действуют сразу.
select и close отклоняют вызов, если открытой формы с переданным именем нет, close — если форма заблокирована, а setEditMode — если режима нет в editModes. Вызов выбрасывает Error с причиной отказа в message.
Форма, которую компонент никуда не поместил, остаётся открытой и скрытой — ровно то, чем уже является фоновая вкладка: стандартная полоса просто прячет формы, которые не показывает. Поэтому компонент, помещающий только текущую форму, даёт приложение без вкладок, в котором все открытые ранее формы никуда не делись, и, поместив форму снова, её видно в том состоянии, в котором её оставили. Закрывается форма только через close(name) или closeAll() — либо так же, как она закрывается без компонента.
В окне форм, которое рисует компонент React, комбинации клавиш действуют в текущей форме, даже если компонент её никуда не поместил. Поэтому компонент должен размещать текущую форму.
Собственная панель платформы — режим редактирования, полный экран, мобильное меню — есть только у System.forms, в его стандартной полосе вкладок, поэтому компонент, который рисует System.forms, её не показывает, а у других окон её нет. То, что делает панель, компонент любого окна форм делает через контроллер: setEditMode(name) выбирает режим редактирования, один на всю страницу, — так же, как кнопка режима, — где name — имя режима из editModes, а toggleFullScreen() разворачивает System.forms на весь экран и возвращает обратно — так же, как кнопка полного экрана и ALT+F11. Полный экран всегда у System.forms, компонент какого бы окна его ни попросил: страница рисует тогда одно System.forms, без навигатора и других окон, поэтому окно другого компонента не рисуется, и этот компонент никогда не видит fullScreen равным true. Отсюда же доступно и то, что предлагает контекстное меню стандартной вкладки: closeAll() просит закрыться каждую открытую форму, начиная с последней в этом порядке. Закрытие каждой из них — такая же просьба, поэтому форма, которая не закрылась, остаётся открытой, а остальные закрываются. Выбранный режим и полный экран платформа знает сама, поэтому она их и проецирует: режим, выбранный компонентом, и полный экран, включённый по ALT+F11, компонент видит одинаково — в props.data. Мобильное меню компоненту не нужно: на мобильном веб-клиенте окно форм рисует платформа.
Скрывая кнопку закрытия неактивной вкладки, стандартная полоса выполняет пользовательскую настройку Не показывать кнопку закрытия на неактивной вкладке (dontShowCloseButtonOnInactiveTab), поэтому окну System.forms, которое рисует компонент, не задаётся класс, который её скрывает, — dont-show-close-button: он скрыл бы и кнопки закрытия, которые компонент рисует с именами классов стандартных вкладок. Показывать ли на своих вкладках кнопку закрытия, решает компонент. Мобильный веб-клиент, который рисует стандартную полосу, этот класс сохраняет.
Окно форм обрезает то, что рисуется в нём. Большой z-index тоже не спасает: элемент самого окна - это контекст наложения (position: relative; z-index: 0), поэтому слой внутри него никогда не поднимется над соседними окнами. Портал в тело страницы уходит от обоих ограничений.
Окно сообщений
Компонент React может рисовать и окно, в котором появляются сообщения пользователю, вместо стандартной панели. Окну WINDOW System.log задаётся имя компонента, а его данными становятся выведенные сообщения:
EXTEND WINDOW System.log CUSTOM 'MessageLog';
Сообщение компонент не рисует никогда: сообщение — это разметка, которую построила платформа (текст со значком или таблица, выведенная действием рядом с ним), поэтому компонент рисует место для каждого сообщения, которое хочет показать, а платформа переносит туда эту разметку. Этим местом и является <Platform name/>, где name — имя, которое проекция даёт сообщению. Разметку сообщения он размещает так же, как размещает дочерний элемент дизайна, элемент навигатора и открытую форму. Как и у кнопки навигатора, место остаётся таким, каким его нарисовал компонент, без пометок, которые получает узел размещения на форме.
Прямо на странице сообщается о трёх ошибках: имя, которого нет ни у одного выведенного сообщения, второй <Platform> для того же сообщения и передача row в <Platform>, хотя сообщение размещается целиком.
props.data — выведенные сообщения, и компонент отрисовывается ещё до прихода первого из них, с пустым messages:
| Поле | Значение |
|---|---|
messages | Имена выведенных сообщений, начиная с последнего — в том порядке, в котором их показывает стандартная панель |
byName | Каждое сообщение по имени |
и каждое сообщение несёт:
| Поле | Значение |
|---|---|
name | Собственное имя, чтобы компонент, которому передали только запись, всё равно мог поместить сообщение |
caption | Заголовок действия, которое вывело сообщение; рисуется через <Caption value={m.caption}/> |
time | Время появления сообщения в миллисекундах — то, которое стандартная панель печатает в строке с датой |
failed | Является ли сообщение ошибкой — единственное различие между двумя сообщениями, которое делает панель, и то, по которому компонент их оформляет |
Сообщение — это разметка, поэтому проекция несёт только то, что стандартная панель пишет рядом с ней сама. Имя — собственное имя платформы: два сообщения могут нести один и тот же текст, заголовок и секунду, поэтому ничто в самом сообщении его не определяет.
props.controller содержит методы контроллера навигатора — exec, eval, evalAction, change, activate — для вызовов в сессии навигатора. Он также делает то, что с окном сообщений может сделать только платформа: togglePin() переключает режим закрепления окна так же, как кнопка закрепления платформы. togglePin ничего не возвращает и не сообщает о завершении, как и нажатие. Закрепление — настройка среды отображения, общая с десктоп-клиентом, поэтому компонент просит платформу изменить её. Текущий режим ему тоже не передаётся, потому что его не знает и клиент: незакреплённое окно делает незакреплённым класс, который вычисляет сервер.
Сообщение, которое компонент никуда не поместил, всё равно выведено и всё равно есть в проекции: ничто его не удаляет — так же, как стандартная панель хранит все напечатанные сообщения. Поэтому компонент, показывающий только последнее сообщение или только ошибки, ничего не теряет: помещённое снова сообщение видно в том же виде. Ни очистки, ни закрытия сообщения нет ни в проекции, ни в контроллере, потому что их нет и в платформе.
Само окно остаётся окном платформы: компонент рисует внутри него, поэтому в стандартном расположении окон окно так же скрывается, выдвигается поверх формы и показывается при появлении сообщения, как и раньше. Когда окна располагает собственный компонент, окно показывается там, куда его помещает этот компонент.
Расположение окон
Опция CUSTOM инструкции NAVIGATOR задаёт компонент расположения окон:
NAVIGATOR CUSTOM 'AppLayout';
Окно компонент не рисует никогда: он рисует место для каждого окна, которое хочет показать, а платформа переносит туда собственный вид окна, отрисованный так же, как без компонента, — кнопки окна навигатора или то, что рисует собственный компонент окна, открытые в окне FORMS формы, сообщения System.log. Этим местом и является <Platform name/>, где name — каноническое имя окна. Окно он размещает так же, как дочерний элемент дизайна и открытую форму, с теми же пометками места: вид окна заполняет место, а размер места задаёт компонент. Окну, место которого изменило размер, об этом сообщается, как при перетаскивании границы стандартного расположения, поэтому таблица, диаграмма сводной таблицы или карта на форме заново измеряют себя.
Прямо на странице сообщается о трёх ошибках: имя, которого нет ни у одного окна, второй <Platform> для того же окна и передача row в <Platform>, хотя окно размещается целиком.
props.data описывает все окна, включая System.forms:
| Поле | Значение |
|---|---|
windows | Массив канонических имён окон: окна навигатора, System.log, прикладные окна FORMS, затем System.forms. Окна навигатора и прикладные окна FORMS идут в порядке объявления внутри каждого модуля, а модули — в порядке инициализации |
byName | Записи под каноническими именами окон, например data.byName['System.toolbar'] |
Каждая запись в byName содержит:
| Поле | Значение |
|---|---|
name | Собственное каноническое имя, чтобы компонент, которому передали только запись, всё равно мог поместить окно |
caption | Заголовок окна — тот, который стандартное расположение пишет на вкладке окон с общим местом. У окна, объявленного без заголовка, как системные окна, это его имя |
hidden | Не показало бы окно сейчас стандартное расположение: окно скрыто HIDE WINDOW или это окно навигатора, которому нечего рисовать, — у выбранной папки нет для него элементов, — кроме System.root и окна с CUSTOM. Пока запись это говорит, <Platform> скрывает место. Компонент читает поле, чтобы свернуть свою разметку вокруг места |
vertical | Рисует ли окно свои кнопки столбиком. Настройка дизайна «Панель навигации: Вертикальная» делает такими System.logo, System.root и System.system, кто бы их ни располагал |
props.controller содержит методы контроллера навигатора — exec, eval, evalAction, change, activate — для вызовов в сессии навигатора. Окна рисует и меняет платформа, а в их расположении нет ничего платформенного.
Окно, которое компонент никуда не поместил, не показывается, но продолжает жить: его кнопки навигатора обновляются, открытая в него форма открыта — скрыта, как фоновая вкладка, — его сообщения выводятся. Помещённое позже, оно показывается таким, каким стало к этому моменту. Поэтому компонент, размещающий только известные ему окна, скрывает окно, которое добавит другой модуль. Компонент, рассчитанный на любые окна, размещает остальные по data.windows.
То, что стандартное расположение делает своими панелями, под компонентом не делается: перетаскивание пользователем границы между окнами и размеры, сохраняемые между сеансами, вкладки окон с общим местом, превращение верхней полосы в колонку при вертикальной панели навигации, выдвижение незакреплённых навигатора и окна сообщений поверх формы. Режимы закрепления — способ стандартного расположения размещать навигатор и окно сообщений, поэтому окно, которое располагает компонент, не получает классы, которые сворачивают его и выдвигают поверх формы или показывают подписи верхней полосы только при наведении: закрепление там не меняет расположения. Полноэкранный режим (ALT+F11) — такой же, как без компонента: System.forms рисуется поверх страницы один, а компонент на это время скрыт — он остаётся смонтированным и сохраняет своё состояние. О полноэкранном режиме ему не сообщается: fullScreen получает только компонент System.forms. Service.resetWindowsLayout выключает полноэкранный режим и возвращает объявленную видимость окон, а до размеров, которые компонент хранит сам, он не дотягивается.