Компоненты, которые рисует платформа
Внутри контейнера с компонентом React компонент дизайна, которому задан custom = NULL или собственное пользовательское представление, рисует платформа. Представление React такой компонент не рисует, а размещает: через <Platform> или usePlatform указывает, в какое место своей разметки попадает его представление. Так же представление размещает в каждой отрисованной им строке редактор свойства таблицы, которое рисует платформа, а окно, которое рисует React, — представления платформы, которые оно показывает.
Отрисовка платформой
По умолчанию компонент рисует всё поддерево контейнера по props.data. Дочерний компонент с собственным представлением, заданным через custom или CUSTOM / NOCUSTOM, размещается через <Platform name/>.
FORM orders 'Orders'
OBJECTS o = Order
PROPERTIES(o) READONLY number, date, sum
PROPERTIES() comment = orderComment // ниже задано `custom = NULL`; его запись — data.comment
;
DESIGN orders {
NEW board {
custom = 'Board';
MOVE BOX(o) { custom = NULL; } // штатная таблица, размещаемая компонентом
MOVE PROPERTY(comment) { custom = NULL; }
}
}
Дочерний компонент, который рисует платформа, не попадает в props.data — платформа строит его представление, передаёт в него значения свойств и отрисовывает его так же, как в обычном контейнере. Компонент определяет только его место. Исключение — его заголовок и изображение, а у свойства ещё и комментарий: они попадают в компонент в data, а не в собственное представление дочернего компонента. Такое свойство проецирует только { caption, image, comment, hidden } — у него нет .value, так как значение платформа рисует вместе с остальным оформлением дочернего компонента. Эта запись есть и тогда, когда у него нет ни заголовка, ни изображения, ни комментария: тогда, пока форма его показывает, она пуста. Такое действие проецирует только { hidden }: его заголовок и изображение — лицо его кнопки, их рисует платформа. Такой контейнер проецируется так же, как любой контейнер, который рисует представление: компонент читает его caption и image из data и решает, куда поместить представление платформы.
Запись содержит caption, image — у свойства ещё comment — и, пока форма скрывает дочерний компонент, hidden (у действия — только hidden) — у свойства таблицы это вся запись его колонки — и находится в том же месте data, что и опции отображения, под тем же именем, по которому лежит значение дочернего компонента:
| Дочерний компонент, который рисует платформа | Где его запись | Ключ |
|---|---|---|
| Свойство в таблице группы объектов, рисуемое в каждой строке | data.<g>.<integrationSID>, обычная запись колонки рядом с остальными колонками группы | Интеграционный SID свойства, qty |
| Свойство в панели или свойство пустой группы | data.<g>.<integrationSID>, в узле его группы (data.<integrationSID> для пустой группы), — там, где было бы его значение, если бы его рисовал React | Интеграционный SID свойства, note |
| Контейнер или любой другой компонент | data.<componentSID>, всегда на верхнем уровне | Его идентификатор компонента дизайна, BOX(o), GRID(o) |
Свойство называется интеграционным SID — и в таблице, и в панели, и его запись, и его место. Запись лежит в узле его группы, там, где была бы запись свойства, которое рисует React, а <Platform> называет панельное свойство тем путём, по которому эта запись читается: <Platform name="o.note"/> — для data.o.note, <Platform name="note"/> — для data.note пустой группы; хост он прячет, пока эта запись говорит hidden. Рендерер свойства таблицы в строке называется так же, <Platform name="o.quantity" row={row}/> — для записи его колонки data.o.quantity, а строка говорит, какой это рендерер: она должна быть строкой этой группы — строка нижней группы дерева проходит и обрезается до пути к группе, как её принимает change(row) группы, — и запись колонки этот хост не прячет. Контейнер и любой другой компонент называется идентификатором дизайна, <Platform name="BOX(o)"/> и data['BOX(o)']. Поэтому имя, по которому компонент размещает дочерний компонент, — это путь, по которому он читает его запись.
Такую запись, data['<component SID>'] = { caption, image, hidden }, на верхнем уровне data этого представления получает каждый компонент, который оно рисует, кроме свойства, которое оно несёт, — контейнер, объявленный через NEW и сгенерированный (PANEL(o), TOOLBAR(o), …) одинаково, грид (GRID(o)) или дерево (GRID(TREE t)), панель инструментов (TOOLBARSYSTEM(o)), — и каждый компонент, который рисует платформа и который оно размещает, кроме свойства, — кроме того, что лежит внутри контейнера, который рисует платформа: его платформа рисует целиком, и компонент туда не заглядывает. У самого контейнера с компонентом React записи в его собственных data нет: его заголовок и изображение здесь никто не рисует — их рисует платформа вокруг контейнера, а у контейнера, который размещает другое представление React, — это представление, по его записи у себя. Поле hidden записи следует за SHOWIF — собственным у компонента или у контейнера выше, — а не за тем, показывает ли представление этот компонент: у вкладки, которую представление не показывает, остаётся заголовок, а hidden нет. Пока оно есть в записи размещённого компонента, <Platform> и usePlatform скрывают узел, который его размещает, — узел получает hidden и остаётся: компонент по-прежнему размещён, поэтому продолжает читаться и возвращается вместе со своим SHOWIF. Запись входит в проецируемые data, поэтому динамический заголовок или изображение перерисовывают компонент как любое другое изменение данных.
Контейнер с компонентом React подчиняется собственному SHOWIF, как любой другой компонент: платформа скрывает его блок. Внутри того, что рисует React, tabbed, collapsed, popup и activated ничего не делают: это содержимое раскладывает React, и полосы вкладок или заголовка сворачивания, к которым они бы относились, нет — вместо них у представления есть запись каждого контейнера, и показывает оно то, что хочет. ACTIVATE TAB, COLLAPSE или EXPAND из скрипта над компонентом там приводит к ошибке, как и над дочерним компонентом, который рисует платформа: его видимость принадлежит представлению.
Открытие формы внутри контейнера (SHOW ... IN).
Platform, usePlatform, useShown, Caption и Image — глобальные переменные времени выполнения, как и List, поэтому перед использованием в примерах ниже их нужно связать с локальными именами: const { Platform, usePlatform, useShown, Caption, Image } = window.lsfusion;.
Компонент называет каждый размещаемый дочерний компонент и сам рисует заголовок там, где ему нужно:
export function Board(props) {
const data = props.data;
return <div className="board">
<h3><Caption value={data['BOX(o)'].caption}/></h3>
<Platform name="BOX(o)"/>
<h3><Caption value={data.comment.caption}/></h3>
<Platform name="comment"/>
</div>;
}
Размещение дочернего компонента
Дочерний компонент, который рисует платформа, не обязан быть непосредственным потомком контейнера: он может лежать внутри контейнеров, которые представление рисует само, на любой глубине — включая запись таблицы, которую рисует представление, то есть то, что дизайн кладет в GRID(<group>), — и размещает его по имени всё тот же контейнер с компонентом React над ним — поэтому дизайн группирует такие части так же, как их рисует представление, по страницам или секциям. Внутри контейнера, который рисует платформа, отдельно не размещается ничего: такой контейнер платформа рисует целиком, со всем, что внутри. Исключение — компоненты, которые вложенный контейнер с компонентом React размещает так же, как свои собственные.
Представление такого дочернего компонента переносится в узел размещения — узел DOM, которым владеет React и в который он никогда не отрисовывает дочерние элементы. React размещает представление относительно узла, которым владеет, и владеть им обязан, чтобы продолжать отрисовывать окружающее дерево. Какой это узел — единственное различие между двумя способами размещения:
// узел создаёт платформа — <div> внутри секции
<section className="board-panel"><Platform name="BOX(o)"/></section>
// узлом размещения становится собственный элемент компонента — на один узел меньше
<section {...usePlatform('BOX(o)', { className: 'board-panel' })}/>
<Platform> короче. usePlatform(name, { className, row }) — для элемента, который компонент отрисовывает и так: панели, карточки, ячейки сетки, — чтобы представление попадало прямо в него: он возвращает свойства, делающие этот элемент узлом размещения, — ref, переносящий туда представление, пометки узла и, пока запись дочернего компонента говорит об этом, hidden, — а также, в children, компоненты React в размещённом дочернем компоненте. Передайте их элементу разворотом ({...}), а класс элемента — в usePlatform, а не самому элементу: className, записанный после разворота, заменяет тот, с которым объединены пометки.
Всё остальное у них общее. Узел размещения несёт класс lsf-platform и атрибут data-lsf-sid с именем дочернего компонента, кто бы его ни создал: <Platform> и usePlatform отрисовывают их собственными свойствами, объединёнными с классом, который компонент даёт узлу, поэтому класс, меняющийся между отрисовками, их не стирает. Любой узел размещения стилизуется так, что представление его заполняет, каким бы ни был дочерний компонент, поэтому компонент задаёт размер узлу, а представление следует за ним:
.board > .lsf-platform[data-lsf-sid="BOX(o)"] { height: 260px; }
Об изменении размера узла размещения сообщается размещённому дочернему компоненту, в том числе представлению свойства в строке.
Размер задаёт компонент, так как атрибуты width, height, fill и выравнивания размещённого дочернего компонента не применяются: они задают его положение внутри штатного контейнера, а здесь окружающий элемент — это разметка самого компонента. Его caption и image дочерний компонент тоже не рисует — кроме действия, у которого это лицо его кнопки: они передаются компоненту в data, поэтому компонент, размещающий дочерние компоненты сам, рисует их там, где ему нужно, — иначе их не нарисует никто:
<section className="board-panel">
<h3><Image value={props.data['BOX(o)'].image}/><Caption value={props.data['BOX(o)'].caption}/></h3>
<Platform name="BOX(o)"/>
</section>
Рисуются через <Caption> и <Image> — ровно затем они и есть: заголовок не всегда обычный текст, а изображение — либо адрес, либо готовый элемент.
Именно это делает возможной полосу вкладок, и ради этого запись и существует. Компонент, показывающий по одному размещённому дочернему компоненту, всё равно должен как-то назвать те, которые он не показывает, а называть их больше нечем. Работает это благодаря двум вещам: запись не следует за размещением — она есть с самого начала у каждого дочернего компонента, которого размещает контейнер, а её hidden следует за SHOWIF, а не за тем, показывает ли его представление, поэтому у закрытой вкладки есть подпись, — и заголовок продолжает читаться, пока тело скрыто, поэтому вычисляемый заголовок закрытой вкладки не устаревает.
Заголовок и изображение есть только у контейнера и у свойства, поэтому в записи размещённого GRID(o) нет заголовка — она говорит только о том, скрывает ли форма грид.
Размещение ограничено следующими правилами:
- Каждый дочерний компонент, который рисует платформа, размещается не более чем одним узлом. Не размещённый ни одним узлом дочерний компонент не показывается. Повторный узел сообщает о себе на странице и в консоли, а первый сохраняет за собой дочерний компонент.
- Компонент внутри контейнера, представление которого платформа строит, хотя
custom = NULLему не задан, — перенесённая внутрь группа фильтров, которая не фильтрует ни по одному объекту, — не показывает никто, и консоль один раз сообщает об этом вместе со способом исправить. Это не касается компонента, часть которого рисует представление, — блока фильтров, управляющих элементов фильтров или тулбара группы или дерева либо группы фильтров группы: представление получает эту часть. - Узел должен попасть на страницу. Узел, который к концу создавшей его отрисовки так и остался вне документа, отдаёт дочерний компонент: представление возвращается в ожидание, его получает
<Platform>с тем же именем, который на странице есть, а в консоль пишется, какое имя было отдано. Узел, добавляемый порталом в эффекте, к этому моменту уже на странице и размещается как обычно. - Узел, который отрисовывает
<Platform>, содержит представление lsFusion, поэтому он должен оставаться пустым: ему задаются класс или стиль, но не дочерние элементы. custom = NULL.
Размещение, которое не может сработать, сообщает об этом в самом узле, а не только в консоли: имя, не называющее ничего внутри контейнера (и внутри контейнеров, которые он рисует сам), компонент, который представление рисует само, второй узел для того же дочернего компонента, имя, переданное с row, которое не называет свойство таблицы, которое платформа рисует построчно, из группы, которую рисует это представление, row другой группы, и row, не являющийся строкой, — каждый случай выводит своё сообщение в узел, в элементе с классом lsf-view-error. Собственный класс узла остаётся таким, каким его задал компонент.
Представление сообщает серверу, какие из дочерних компонентов, которые рисует платформа, оно размещает, — их набор, а не монтирования и размонтирования, которые его изменили: набор вычисляется после каждого изменения размещения и один раз после первой отрисовки компонента, а отправляется только то, что изменилось. Дочерний компонент, у которого есть узел размещения — с его представлением или в ожидании его, — размещён. Дочерний компонент, который не размещает ни один <Platform>, считается скрытым компонентом, а его заголовок, изображение и комментарий доступны представлению для показа вне этого компонента. Поэтому компонент, показывающий по одному дочернему компоненту, отрисовывает только его, а не прячет остальные средствами CSS: скрытый через CSS компонент для сервера остаётся размещённым и продолжает читаться. По той же причине видимость размещённого дочернего компонента принадлежит только компоненту: его атрибуты collapsible, collapsed и activated игнорируются, а COLLAPSE / EXPAND или ACTIVATE TAB из скрипта над ним приводит к ошибке.
Контейнер, который представление рисует само, — страницу полосы вкладок, которую оно раскладывает, раздел, который оно сворачивает, — сервер читает как показанный, пока представление ничего о нём не говорит: что показывает представление, ему не видно. useShown(name, shown) говорит это. Контейнер, о котором сообщено, что он не показан, и всё внутри него подчиняются правилам чтения скрытых компонентов, включая размещённый там дочерний компонент платформы, есть у него узел размещения или нет. Его заголовок и изображение остаются доступны представлению вне него. Вызывайте его там, где он остаётся смонтированным, пока контейнер появляется и исчезает, — в полосе вкладок, а не на странице, — по одному хуку на контейнер, с именем контейнера в дизайне: размонтированный, хук оставляет контейнер показанным — это сервер и предполагает о контейнере, который не называет ни один хук. shown, если его опустить, равно true. Имя, которое не называет контейнер, рисуемый самим представлением, выводится в консоль. SHOWIF контейнера остаётся за формой, и hidden его записи говорит только о нём.
// вкладка полосы: смонтирована, пока смонтирована полоса, какая бы страница ни была показана
function Tab(props) {
useShown(props.name, props.active);
return <button role="tab" aria-selected={props.active} onClick={props.onClick}>
<Caption value={props.entry.caption}/>
</button>;
}
Живой редактор в каждой строке
Списочное свойство размещается в представлении, которое рисует строки его группы, где бы само свойство ни стояло в дизайне. Размещённый дочерний компонент рисуется один раз. Свойство таблицы, которому в FORM задано NOCUSTOM, рисуется один раз на строку, поэтому компонент может поместить настоящий редактор lsFusion в каждую отрисовываемую им строку — вместо того чтобы показывать значение и строить редактирование самому:
FORM orders 'Orders'
OBJECTS o = Order
PROPERTIES(o) number READONLY, date
PROPERTIES(o) quantity NOCUSTOM, note NOCUSTOM
;
DESIGN orders {
NEW board {
custom = 'OrderBoard';
MOVE BOX(o); // строки рисует React, по data.o
}
}
NOCUSTOM говорит, что свойство рисует платформа, штатным представлением: оно является компонентом, а не значением. То же говорит функция отображения CUSTOM — значение тогда платформа рисует этой функцией — и SELECT вместе с NOCUSTOM — значение тогда платформа рисует выбором из списка: один SELECT говорит, что рисуется, а не кто рисует (выбор). Дизайн говорит то же атрибутом custom свойства, как и caption: custom = NULL — это NOCUSTOM, а PROPERTY(quantity(o)) { custom = 'starRating'; } — это PROPERTIES(o) quantity CUSTOM 'starRating'. Где оно размещается, не говорится — и не может: у свойства таблицы нет собственного места в дизайне, а его отрисовщики попадают в строки, поэтому размещает их тот компонент, который эти строки рисует. Здесь это компонент, которому группу отдал MOVE BOX(o). MOVE свойства таблицы отклоняется при построении формы — с NOCUSTOM или без. Компонент называет свойство так, как ключуется запись его колонки, — с группой — и передаёт строку:
{data.o.list.map(row => (
<tr key={row.key}>
<td>{row.number.value}</td>
<td><Platform name="o.quantity" row={row}/></td>
<td><Platform name="o.note" row={row}/></td>
</tr>
))}
Передавайте объект строки из проецируемых данных — по одному ключу строку восстановить нельзя. Одно и то же свойство размещается один раз на строку, и только один раз.
Что автор получает и что остаётся за ним:
- Редактор принадлежит платформе со всем, что из этого следует: редактирование,
READONLYIF,BACKGROUNDи остальные опции ячейки, — и всё это вычисляется для этой строки. - Свойство уходит из строк: теперь это компонент, поэтому
row.quantityтам нет, и члена для него у контроллера нет — значения рисует и правит платформа. Запись его колонки остаётся — обычная, вdata.o.quantity:caption,image,footer,comment,type,hidden, — иpropertiesеё перечисляет. Его редакторы размещаются по тому же имени,o.quantity, поэтому имя у него должно быть: свойство, объявленное сNOEXTID, отклоняется при построении формы. Если значение нужно ещё и как данные, объявите второе, обычное свойство. - Заголовок в строке не рисуется, как и комментарий: своих у построчных редакторов нет. Как и заголовок размещённого дочернего компонента, оба приходят в узле колонки группы —
data.o.quantity.caption,data.o.quantity.comment, — поэтому компонент размещает их там, где нужно, обычно один раз, в шапке. В записи колонки действия нет ни заголовка, ни изображения: они остаются на его кнопках, это их лицо. - Отрисовщик существует для каждой строки, которую группа показывает сейчас, независимо от того, отрисовывает компонент эту строку или нет. Строка, ушедшая за пределы прокрутки, свой редактор сохраняет. Теряет его только строка, покидающая этот набор.
- Его клавиша (
CHANGEKEY) одна на все строки, как у колонки таблицы: нажатая в любом месте формы, она открывает редактор в текущей строке, пока редактор этой строки размещён, — редактор строки, которую компонент не рисует, клавишу не берёт.
Там, где строки группы не рисует контейнер с компонентом React, NOCUSTOM — просто штатное представление: свойство рисует таблица платформы, без пользовательских функций отображения и редактирования. Свойство таблицы, сгруппированное в колонки, отклоняется с указанием свойства там, где его строки рисует представление React: построчный редактор не может адресовать ячейку на пересечении строки и колонки.
Расширение контейнера размещаемыми дочерними компонентами
Другой модуль добавляет в контейнер дочерний компонент из DESIGN:
EXTEND FORM orders PROPERTIES() rating;
DESIGN orders {
board { MOVE PROPERTY(rating) { custom = NULL; } }
}
Сам по себе компонент его не подхватит. Каждый дочерний компонент, который рисует платформа, размещается тем <Platform>, который его называет, поэтому дочерний компонент, не названный ни одним <Platform>, не показывается, и такое добавление требует правки JSX: расширение DESIGN объявляет дочерний компонент, а компонент решает, где он окажется. Расположение из DESIGN тоже не расширяется: композицию React там изменить нельзя. Чтобы изменить расположение, компонент заменяется целиком через custom = 'OtherBoard', а дочерние компоненты остаются объявленными в DESIGN.
Размещение в разных представлениях
<Platform> и usePlatform размещают следующие представления. Если у места есть пометки, представление заполняет его, а data-lsf-sid содержит имя размещаемого элемента:
| Пользовательское представление | Что называет <Platform name> | Ждёт ли место отсутствующее представление? | Пометки места | Откуда берётся hidden | Сообщается ли размещённому представлению об изменении размера | props.controller |
|---|---|---|---|---|---|---|
| Контейнер / компонент формы | Дочерний компонент контейнера (идентификатор дизайна или путь к свойству) либо представление свойства в строке (путь к свойству и row) | Да, пока известного представления нет | lsf-platform, data-lsf-sid | SHOWIF дочернего компонента или контейнера над ним. Для представления в строке не используется | Да, в том числе представлению в строке | Члены своей проекции и form |
| Окно навигатора | Каноническое имя элемента этого окна с NOCUSTOM | Да, пока окно не рисует элемент | Нет | SHOWIF элемента | Нет | Контроллер навигатора |
| Окно форм | name открытой формы | Нет, даже у ещё загружаемой формы представление уже есть | lsf-platform, data-lsf-sid | В записи нет hidden | Да | Методы контроллера навигатора и select, close, closeAll, setEditMode, toggleFullScreen |
| Окно сообщений | name выведенного сообщения | Нет | Нет | В записи нет hidden | Нет | Методы контроллера навигатора и togglePin |
| Расположение окон | Каноническое имя окна | Нет | lsf-platform, data-lsf-sid | data.byName[name].hidden: HIDE WINDOW либо пустое окно навигатора без CUSTOM, кроме System.root | Да | Контроллер навигатора |