Перейти к основному содержимому
Версия: 7.0

Контроллер представления React

Компонент представления React работает с формой, открытой в интерактивном представлении, через свой контроллер, props.controller: задаёт текущие объекты и значения свойств, выполняет действия, меняет сортировки, фильтры и узлы дерева.

Контроллер — один на проекцию: props.controller React-представления принадлежит его контейнеру и называет ровно то, что показывает props.data этого контейнера. Объект, который классическое представление и custom-редактор ячейки получают как controller.form, действие INTERNAL CLIENT — аргументом, а React-представление — как props.controller.form, — это контроллер ФОРМЫ: данных он не проецирует, поэтому членов, описанных ниже, на нём нет — член говорит, что data.<group>.<property> существует, — а то, до чего он достаёт, ему называют строкой, и платформа проверяет имя при вызове. Контроллер представления повторяет структуру props.data: его члены — это записи контейнера, причём они создаются один раз, при открытии формы, и каждый лежит по тому же пути, что и его данные: то, что представление читает как data.o.qty, оно меняет через controller.o.qty, а data.total — через controller.total. Каждая группа объектов, часть которой рисует это представление, — член контроллера под своим SID, каждое свойство, ЗНАЧЕНИЕ которого это представление несёт, — член этой группы под своим интеграционным именем, а каждое свойство пустой группы (уровня формы) — член самого контроллера. Форма, в которой одно из этих имён означало бы два свойства одного контейнера, отклоняется при построении. Член и есть адрес: второго, строкового набора глаголов, говорящего то же самое, у контроллера представления нет, а опечатка в имени — это несуществующий член, а не строка, которую платформе приходится проверять.

Представление читает только части своего контейнера, а члены его контроллера меняют то, что несут его props.data. То, что рисует другой контейнер или платформа, представление меняет через контроллер формы, по именам (между контейнерами). Общее у контейнеров — сама форма: её текущие объекты, сортировки, фильтры и сессия, поэтому фильтр или текущий объект, изменённые в одном контейнере, видны в другом так же, как в стандартном клиенте.

Члены​

Необязательные аргументы — в скобках.

членчто делаетвозвращает
<group>.change(row[, {selection}])задаёт текущий объект группы — только там, где рисуются строки группы. У группы вне дерева принимает также первую или последнюю строку всего списка и меняет выделенные строкиPromise
<group>.properties.change(column[, {selection}])задаёт текущую колонку и меняет выделенные колонки — только там, где рисуются строки группы вне дереваPromise
<group>.selectAll()выделяет все строки и колонки — только там, где рисуются строки группы вне дереваPromise
<group>.copy()текст выделенных ячеек для буфера обмена — только там, где рисуются строки группы вне дереваPromise
<group>.paste(text)вставляет текст в выделенные ячейки — только там, где рисуются строки группы вне дереваPromise
<group>.orders.change(order)меняет одну из сортировок группы, не трогая остальные и их приоритет, — только там, где рисуются строки группы. У дерева — <tree>.orders, в узле дерева там, где рисуются его строки, каждое свойство названо <group>.<property>Promise
<group>.orders.change(orders)массив заявляет их все, его порядок — приоритетPromise
<group>.<property>.change(value[, row])задаёт значение — на текущем объекте или на переданной строкеPromise
<group>.<property>.exec([row])выполняет событие изменения свойства либо действие — на текущем объекте или на переданной строкеPromise
<group>.<property>.getValues(value[, {row, mode, count}])ограниченный список подсказок с сервераPromise
<property>.change(value) / .exec() / .getValues(...)то же для свойства пустой группы — без строкиPromise
<group>.expand(row) / .collapse(row) / .toggle(row)раскрывает или сворачивает один узел дерева — узел это строка группы; только там, где рисуются строки дереваPromise
<group>.expandAll() / .collapseAll()раскрывает все узлы группы и групп под ней — у верхней группы всё дерево — или сворачивает их; там, где рисуются строки дереваPromise
<group>.filters.change(condition)меняет одно условие пользовательского фильтра группы, не трогая остальные: первое по его свойству, сохраняя то, чего не указывает, как фильтр по свойству, — там, где стоит FILTERS(<group>). У дерева это <tree>.filters там, где стоит FILTERS(TREE <tree>), и каждое свойство называется <group>.<property> (Фильтры)Promise
<group>.filters.change(conditions)массив задаёт все условия, которые может назвать: заменяет список условий — условие по свойству, которому у него нет имени, остаётся на месте, — условие без значения сравнивает с NULLPromise
<group>.addFilter() / .applyFilters() / .resetFilters()«добавить», «применить» и «сбросить» управляющих элементов фильтров, как кнопки платформы, — там, где стоит FILTERCONTROLS(<group>). У дерева это <tree>.addFilter() и остальные там, где стоит FILTERCONTROLS(TREE <tree>)Promise
<group>.<filterGroup>.change(index)выбирает один из фильтров группы фильтров по индексу, null — ни одного, — там, где стоит FILTERGROUP(<filterGroup>)Promise
<group>.filter.<property>.change(value[, {compare, negation, or}])задать значение фильтра по свойству — в его условии, первом по свойству, или, если условия нет, на собственном месте фильтра, со сравнением, отрицанием и связкой, которые задают параметры; null снимает это условие — там, где рисуется FILTER(<property>)Promise
<group>.viewFilters.change(conditions)задать фильтры представления группы — собственные условия представления, по которым сервер фильтрует её строки вместе с пользовательскими фильтрами: массив задаёт их все, пустой — ни одного — только там, где рисуются строки группы вне дереваPromise
<group>.getCount() / .getSum(property)число строк группы и сумма их колонки, только по отмеченным строкам, если пользователь их отметил, — там, где стоит TOOLBARSYSTEM(<group>), что бы ни говорили флаги дизайна show…, — его кнопкиPromise
<group>.export() / .update() / .manual.change(on) / .filterControlsVisible.change(shown) / .listView.change(name)выгружает строки, подтягивает придержанные сервером изменения, включает или выключает ручное обновление, показывает или прячет управляющие элементы фильтров платформы, показывает строки в другом виде отображения — там, где стоит TOOLBARSYSTEM(<group>), что бы ни говорили флаги дизайна show…Promise
<tree>.expandCurrent()раскрывает текущий узел дерева и все узлы под ним — собственный член дерева, в его узле там, где рисуются строки дерева; над штатным деревом — член его тулбара, там, где стоит TOOLBARSYSTEM(TREE <tree>)Promise
<tree>.export() / .filterControlsVisible.change(shown) / .expandTree()выгружает дерево, показывает или прячет управляющие элементы фильтров дерева платформы — в узле дерева, там, где стоит TOOLBARSYSTEM(TREE <tree>) (его тулбар); над штатным деревом ещё и раскрывает его от группы выделенного узла внизPromise
batch(fn)выполнить fn; изменения, которые в ней делают члены, показываются сразу и уходят вместе, одним запросом, когда она вернётся, в порядке вызовов, — пакет формы, он же form.batch(fn)Promise
controller.o.note.change('checked');   // текущая строка группы `o`
controller.o.sum.change(100, row); // ... переданная строка
controller.o.edit.exec(row); // действие: выполнить на этой строке
controller.o.change(row); // текущий объект группы
controller.o.orders.change([]); // её сортировки: массив заявляет их все — здесь ни одной
controller.o.filters.change({property: 'name', value: 'an'}); // одно условие — оно ложится в data.o.filters
controller.o.customer.getValues(text, {mode: 'objects'}); // Promise его подсказок
controller.total.change(500); // свойство пустой группы

Помимо членов и batch контроллер несёт form — контроллер формы.

change и exec члена не спрашивают подтверждения, которого требует дизайн свойства (CONFIRM у действия, askConfirm в дизайне): его спрашивают редактор и кнопка платформы, а вызов представления сразу уходит на сервер. Запись свойства говорит, спрашивать ли и что именно, — askConfirm и askConfirmMessage (опции отображения), — поэтому представление, которому нужен этот вопрос, задаёт его до вызова.

Члены — это то, что это представление может изменить: записи, которые оно несёт, минус то, что рисует ПЛАТФОРМА — у свойства с NOCUSTOM — или с функцией отображения CUSTOM, заданной в FORM, — есть запись (обычная запись колонки, чтобы вид нарисовал заголовок колонки) и нет члена, потому что его значение рисует и правит собственный рендерер, который это представление ставит через <Platform name row/>, а у любого другого дочернего компонента, который рисует платформа, есть только называющая его запись — у действия, которое рисует платформа, панельного или в каждой строке, только запись, без заголовка и изображения — это лицо его кнопки, а запускает его кнопка платформы. Поэтому группа становится членом контроллера каждого контейнера, у которого есть data.<group>, — пустым, если контейнер только размещает то, что платформа рисует для этой группы, — а свойство — членом группы там, где ИМЕННО ЭТОТ контейнер несёт его значение: списочное — там, где рисуются строки, панельное — там, где стоит само свойство. Член есть, пока есть его запись, — с самого начала, скрыта она или нет: SHOWIF, скрывающий свойство, оставляет член на месте, а вызов через него, пока запись hidden, отклоняется с ошибкой о том, что форма сейчас это свойство не показывает. Событие изменения свойства — то самое, которое пользователь запускает правкой ячейки, поэтому у свойства, которого форма не показывает, его некому вызывать. <group>.change(row) есть только там, где рисуются строки группы, — текущий объект выбирается среди них, — как и orders.change(...) — группы, а у дерева в узле дерева, — ведь сортировка это порядок, в котором рисуются эти строки; и строку принимают только там: сам <group>.change и член списочного свойства, который живёт там же, где строки. Член панельного свойства и член пустой группы строку не принимают: они действуют на текущих объектах. Для того, чего представление не видит, у него нет и члена: остальная форма достигается через контроллер формы, form, — его методы между контейнерами и change / exec / eval / evalAction, которые принимают имена и код lsf, а не имена проекции. Там, где состояние, которое хранит представление, называет свойство, — сортировка, условие пользовательского фильтра, — оно называет его интеграционным именем, а не членом: состояние — это данные, которые пишутся в том же виде, в каком их публикует props.data, и могут называть свойство, у которого члена нет, например колонку, которую рисует платформа. Сортировка — это {property: 'sum', desc: true}, условие — {property: 'sum', compare: '>', value: 100}, и имя у обоих ищется среди свойств группы, где бы они ни были нарисованы: состояние группы принадлежит группе, а не одному представлению, — FILTERS(<group>) может стоять вовсе не рядом с колонкой, а строки не обязаны рисоваться рядом со свойством, по которому они отсортированы (Сортировки, Фильтры). Вызов же называет то, что меняет, членом. У свойства, сгруппированного по колонкам, члена нет нигде — по той же причине, по которой оно не проецируется: его значения адресуются ключом «строка и колонка». (Классический changeProperty — CUSTOM-группы объектов и контроллера формы, form.changeProperty, — другая, более старая поверхность, и она по-прежнему называет всю форму.) Изменяющие члены — change и exec свойства и члены, меняющие текущий объект группы, её выделение, сортировки, пользовательские фильтры, фильтры представления или группу фильтров, узлы дерева, а также управляющие элементы фильтров, — возвращают Promise своего запроса: новое состояние приходит со следующим обновлением формы. export(), update(), manual.change() и listView.change() тулбара тоже возвращают Promise своего запроса. Вызовы сервера формы (form.exec / form.eval / form.evalAction / form.change) возвращают Promise, как и getValues() свойства, который спрашивает у сервера подсказки, и getCount() и getSum() тулбара — и getCount, getSum и getValues контроллера формы, — которые спрашивают у него число.

Promise вызова изменяющего члена выполняется, когда его запрос закончен — сервер довёл его до конца, на открытые им диалоги ответили, и форма приняла его ответ, — и отвергается с Error с причиной, по которой запрос упал, — платформа показывает её пользователю, как и упавшую правку, поэтому вызов, Promise которого представление не ждёт, ничего сверх этого не сообщает. После закрытия формы он отвергается с Form is closed; вызов, сделанный, пока закрытие ещё не завершено, отправляется — см. Вызовы сервера. change или exec свойства, на которые платформа не делает запроса, — удаление, когда удалять нечего, закрытие формы, которое пользователь не подтвердил, — сразу выполняют свой Promise вне пакета; если сервер не выдал новому объекту идентификатор, Promise отвергается с причиной, как у упавшего запроса. Вызовы пользовательских фильтров — в том числе изменение, которое придерживает ручной режим применения, и applyFilters, когда отправлять нечего, — ждут завершения последнего выполняющегося запроса фильтров таблицы. expandCurrent и expandTree дерева так же ждут завершения его последнего выполняющегося запроса раскрытия. Если такого запроса нет, они сразу возвращают выполненный Promise, как и другие вызовы вне пакета, не делающие запроса.

Имена членов​

Имя, не являющееся идентификатором JavaScript, адресуется через скобки: свойство с EXTID 'unit price' — это controller.o['unit price'].change(v). SID группы — всегда идентификатор: группа из нескольких объектов, чей SID был бы их именами через точку, отклоняется при построении формы, пока её не назовут (OBJECTS pair = (d = X, t = Y)).

Имя, которое перекрыло бы член самой поверхности, отклоняется при построении формы — как и собственные зарезервированные имена проекции: SID группы, имя дерева там, где представление рисует его строки или другую часть дерева, или свойство пустой группы, совпадающее с тем, что несёт контроллер помимо членов (form, batch), либо друг с другом (контроллер — одно пространство имён на свою проекцию, поэтому группа и свойство пустой группы, которые проецирует один и тот же контейнер, не могут оба быть total, — а два разных контейнера могут), а также свойство группы, названное как один из её собственных членов в том же контейнере. Лечится переименованием или EXTID. Сортировки дерева, его текущая строка и собственный expandCurrent, там, где рисуются его строки, а также его пользовательские фильтры, тулбар и управляющие элементы фильтров лежат в узле дерева, который не несёт свойств.

Правка формы и вызов сервера​

Запуск действия через его член — controller.o.edit.exec(row), вне пакета (batch), — тот же запрос, что и нажатие на форме: синхронный, блокирующий ввод до своего завершения и показывающий индикатор ожидания после его задержки, если действие не выведено с NOWAIT (опция свойства syncType). exec, eval, evalAction и change формы идут асинхронными запросами. Поэтому обновление по таймеру через контроллер не делают — см. Живые данные.

Правка формы и вызов сервера различаются ещё по двум признакам — нужна ли проверка доступа и как в них адресуется объект:

группаметодыпроверка доступакак передаётся объект
правка формы<group>.change / <property>.change / <property>.exec; у контроллера формы — changeObject / changeOrders / … (между контейнерами)нетстрока-цель — строкой данных (row), дескриптором (row.objects) или своим ключом (только у члена); объект-значение (FK) — своим id
вызов сервераexec / eval / evalAction / change контроллера формы, form@@api / права администратора / CUSTOMS формыобъект — своим id

Пользовательское представление обычно читает состояние из props.data и меняет его через члены правки формы — в том числе выполняя действие, добавленное на форму, через controller.<action>.exec(). Его члены меняют то, что представление рисует, — строки, текущую и выделенные, сортировки, фильтры, узлы дерева и тулбар. Для вкладки или контейнера, которые рисует платформа, собственного члена нет: разместите действие формы с ACTIVATE TAB, COLLAPSE CONTAINER или EXPAND CONTAINER в контейнере представления и выполните через его член. Вызовы сервера формы (exec / eval / evalAction / change) — это запасной путь, нужный только для того, что формой не выражается: произвольного вычисления на сервере, записи в глобальное свойство, создания объекта.

Правка формы идёт обычным каналом правки и не требует проверки доступа. Вызовы сервера её проходят (см. Вызовы сервера). Редактируемая строка адресуется дескриптором, а любой другой объект — значение FK или параметр действия — передаётся своим числовым id (объект lsFusion из JS передать нельзя).

Изменение текущего объекта и значений свойств​

controller.<group>.change(row) задаёт текущий объект группы. Он есть только в контейнере, который рисует строки группы, — другой контейнер задаёт его через контроллер формы, controller.form.changeObject('<group>', row) (между контейнерами), — а row — строка данных этой группы, непосредственный дескриптор objects либо ключ, который дала строке проекция (см. правила идентификации). Там, где представление рисует строки группы вне дерева, change принимает вместо строки также первую или последнюю строку всего списка и говорит, что станет с выделенными строками, а properties.change и selectAll меняют текущую колонку и выделение (выделенные строки и колонки).

Для перехода к первой или последней строке передайте в change группы вместо строки край списка — {to: 'home'} или {to: 'end'}. Эти же два значения есть у контроллера формы — form.HOME и form.END:

<>
<button onClick={() => controller.o.change(controller.form.HOME)}>Первая</button>
<button onClick={() => controller.o.change(controller.form.END)}>Последняя</button>
</>

Прочитанные при переходе строки заменяют list. Тем же вызовом можно изменить выделенные строки. Такой же переход выполняет действие с ACTIVATE FIRST / LAST, размещённое в контейнере представления и выполненное через его член.

Группа дерева объектов край списка не принимает, а её list содержит все строки под раскрытыми узлами без страниц (поиск объектов в дереве). Чтобы перейти к первому или последнему узлу, вызовите controller.<group>.change(row) через член группы этого узла, передав строку первого или последнего узла в собственном порядке отрисовки представления — родитель, затем дети, — а не первый или последний элемент list одной группы.

controller.<group>.<property>.change(value) изменяет свойство для текущего объекта группы, а .change(value, row) — для переданной строки. Аргументы идут в этом порядке, и ничего по ним не угадывается: сначала значение — оно обязательно, null его очищает, — затем строка, необязательная. .exec() выполняет событие изменения свойства — то, которое пользователь запускает правкой ячейки, — на текущем объекте, а для действия выполняет само действие, и .exec(row) делает это на переданной строке. Действию нечего задавать в значение, поэтому .change на нём отклоняется: вызывайте exec. Строку принимает только член списочного свойства, который живёт там, где рисуются строки группы. Член панельного свойства и член пустой группы её не принимают и действуют на текущих объектах. Выбор изменяется выбранным — формы вызова описаны там.

Член принимает строку только там, где рисуются строки группы, — это <group>.change(row) и член списочного свойства, который живёт там же, — и там он принимает объект строки, её дескриптор objects либо строковый ключ, который дала ей проекция: ключ ищется в byKey этого представления. Член панельного свойства и член пустой группы строку не принимают: они действуют на текущих объектах. Что означает каждый из трёх, сказано в разделе Идентификация строки.

Для controller.<g>.<p>.exec(row), .change(value, row) или .getValues(query, {row}) свойство или действие должно иметь вид GRID в группе в виде GRID. Действие для строки добавляется как PROPERTIES(i) addToCart GRID: по умолчанию действия имеют вид PANEL. Свойства в виде PANEL, TOOLBAR или POPUP относятся к текущему объекту, не имеют ячеек в list / byKey, а вызовы их членов с указанием строки отклоняются при выполнении с сообщением '<p>' is a panel property. Редакторы по строкам, размещаемые через <Platform name row/> или usePlatform(name, {row}), тоже требуют свойства в виде GRID.

Значение, переданное в change, попадает в обработку изменения свойства, только если та запрашивает значение у пользователя — обработка по умолчанию либо обработка с запросом значения: переданное значение подставляется вместо ввода пользователя. null — такое же значение, как любое другое. У действия нет значения, которое можно задать: change его члена отклоняется, а запускается оно через exec, который значения не передаёт, — controller.o.edit.exec(row), — поэтому действию, запрашивающему значение у пользователя, через его член значение не передать.

У вызова члена нет ячейки, в которую пользователь ввёл бы значение, поэтому он значения у пользователя не запрашивает. Там, где платформа запрашивает значение у пользователя до того, как выполнить обработку изменения, — например, при асинхронном вводе обработки по умолчанию, — exec члена отклоняется: значение свойства представление передаёт само, через change(value), а значение действия не передать ни через какой член. Значение, которое обработка запрашивает только по ходу выполнения, — скажем, ввод в одной из её ветвей, — отменяется, как отменяет ввод пользователь, и обработка продолжается так же, как в этом случае; почему, говорит консоль браузера.

Группа объектов встроенного примитивного класса — например, навигатор DATE — переводится к значению записью значения самого объекта (controller.<g>.VALUE.change(d)), вызовом controller.<g>.change(row) со строкой из props.data.<g>.list (она несёт дескриптор objects) либо, если группа отфильтрована по data-свойству, изменением этого свойства-фильтра. Дата передаётся как JS-Date (new Date(year, month - 1, day)) или как строка, которая есть в значении поля ввода даты этого класса ('2026-11-18' для DATE), как и для любого свойства-даты (см. форматы значений); любое другое значение — timestamp, строка, которую даёт Date.toISOString(), день, которого нет в месяце, — отклоняется: change бросает <значение> is not a date: ….

Как и правка пользователя в штатной таблице, изменение выполняется в сессии изменений формы: представление сразу видит новое значение в props.data, а в базу данных оно попадает при применении сессии — кнопкой «Сохранить» либо действием с оператором APPLY. Если редактируемое свойство помечено на форме опцией APPLY, его стандартная обработка изменения применяет правку сразу (по умолчанию — фиксируя всю сессию формы), поэтому отдельное сохранение после .change не нужно. Подробности описаны у опции. Для простой правки из представления — перенос, изменение размера, правка значения по месту — это предпочтительнее отдельного серверного действия. Серверное действие (controller.form.exec) остаётся для того, что правкой свойства не выражается: создания объекта (NEW), многошаговой логики, открытия формы.

Когда представление задаёт значение свойства через change члена несколько раз, не дожидаясь ответов сервера, props.data показывает последнее заданное значение, пока приходят ответы на предыдущие изменения: ответ сервера заменяет его, только если сервер сохранил иное или отклонил изменение.