Действия

Библиотека компонентов

http://n2oapp.net/framework/config/schema/action-1.0

Базовые свойства

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
model	resolve filter multi edit datasource	Модель, над которой выполнится действие. Если модель пустая, то действие будет заблокировано.	resolve
src	Имя javaScript функции	Реализация действия	Для каждого действия свои умолчания. Для <custom> атрибут обязательный.

<open-page>

Открыть страницу поверх текущей.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
page-id	Ссылка на страницу	Страница, которая будет открыта поверх текущей
object-id	string	Идентификатор объекта
route	Строка	URL действия	Формируется из идентификаторов страницы, виджета и действия
upload	query, defaults, copy, resolve	Источник данных мастер виджета при открытии страницы	query
page-name	Строка	Наименование страницы
master-field-id	Ссылка на поле	Поле в модели текущего виджета
detail-field-id	Ссылка на поле	Поле в фильтрах мастер виджета на открываемой странице
submit-operation-id	Ссылка на операцию в объекте	На открываемой странице будут добавлены кнопки "Сохранить" и "Отмена". Кнопка "Сохранить" будет выполнять заданную операцию объекта.
submit-model	resolve filter multi edit datasource	Модель, с которой будет выполняться операция по кнопке "Сохранить".
submit-label	Строка	Название кнопки отправки формы на открываемой странице	Сохранить
focus-after-submit	true false	Поставить фокус в текущем виджете на запись, которую вернёт операция объекта
close-after-submit	true false	Закрыть окно после успешного выполнения операции объекта	true
redirect-url-on-submit-success	Строка	Переадресовать на URL после успешного выполнения операции объекта.
redirect-target-on-submit-success	self, newWindow, application	Сценарий переадресации после успешного выполнения операции объекта.

Пример

<open-page  page-id="employee"  submit-operation-id="create"  model="filters"  upload="defaults">  ...</open-page>

<pre-filters>

Тело

Предустановленные фильтры

<path-param>, <query-param>

Тело

Параметры действия

<show-modal>

Действие открытия модального окна

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
page-id	Ссылка на страницу	Страница, которая будет открыта поверх текущей
object-id	string	Идентификатор объекта
route	Строка	URL действия	Формируется из идентификаторов страницы, виджета и действия
upload	query, defaults, copy, resolve	Источник данных мастер виджета при открытии страницы	query
page-name	Строка	Наименование страницы
master-field-id	Ссылка на поле	Поле в модели текущего виджета
detail-field-id	Ссылка на поле	Поле в фильтрах мастер виджета на открываемой странице
modal-size	sm, lg	Размер модального окна	lg
scrollable	true false	Будет ли модальное окно фиксированного размера, а полоса прокрутки внутри
submit-operation-id	Ссылка на операцию в объекте	На открываемой странице будут добавлены кнопки "Сохранить" и "Отмена". Кнопка "Сохранить" будет выполнять заданную операцию объекта.
submit-label	Строка	Название кнопки отправки формы на открываемой странице	Сохранить
submit-model	resolve filter multi edit datasource	Модель, с которой будет выполняться операция по кнопке "Сохранить".
focus-after-submit	true false	Поставить фокус в текущем виджете на запись, которую вернёт операция объекта
close-after-submit	true false	Закрыть окно после успешного выполнения операции объекта	true
redirect-url-on-submit-success	Строка	Переадресовать на URL после успешного выполнения операции объекта.
unsaved-data-prompt-on-close	true false	Предупредить о несохраненных данных на форме при закрытии модального окна?	true
refresh-widget-id	Строка	Идентификатор виджета, который необходимо обновить после успешного закрытия окна	Текущий виджет
refresh-on-close	true false	Обновление виджета после закрытия модального окна	false
submit-action-type	invoke copy	Действие при нажатии кнопки "Сохранить"	invoke
copy-model	resolve edit filter multi datasource	Модель виджета открываемой страницы, которая будет скопирована	resolve
copy-widget-id	Строка	Идентификатор виджета открываемой страницы, данные которого будут копироваться	Главный виджет страницы
copy-field-id	Строка	Идентификатор поля виджета открываемой страницы, данные которого будут копироваться	Вся модель
target-model	resolve edit filter multi datasource	Модель виджета текущей страницы, в которую будут скопированы данные	resolve
target-widget-id	Строка	Идентификатор виджета текущей страницы, в которую будут скопированы данные	Текущий виджет
target-field-id	Строка	Идентификатор поля виджета текущей страницы, в которое будут скопированы данные	Вся модель
copy-mode	merge replace add	Тип слияния	merge
has-header	true false	Наличие шапки	true
class	CSS класс	Класс модального окна
backdrop	false true static	Наличие фона модального окна и закрытие по клику на фон. false - прозрачный фон, клик по фону не закрывает модальное окно; true - темный фон, клик по фону закрывает модальное окно; static - темный фон, клик по фону не закрывает модальное окно.	static
style	CSS свойство	Стиль окна

Пример

<show-modal  page-id="employee"  submit-operation-id="create"  upload="defaults">  ...</show-modal>

<pre-filters>

Тело

Предустановленные фильтры

<path-param>, <query-param>

Тело

Параметры действия

<open-drawer>

Открыть страницу drawer.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
page-id	Ссылка на страницу	Страница, которая будет открыта поверх текущей
object-id	string	Идентификатор объекта
route	Строка	URL действия	Формируется из идентификаторов страницы, виджета и действия
upload	query, defaults, copy, resolve	Источник данных мастер виджета при открытии страницы	query
page-name	Строка	Наименование страницы
master-field-id	Ссылка на поле	Поле в модели текущего виджета
detail-field-id	Ссылка на поле	Поле в фильтрах мастер виджета на открываемой странице
submit-operation-id	Ссылка на операцию в объекте	На открываемой странице будут добавлены кнопки "Сохранить" и "Отмена". Кнопка "Сохранить" будет выполнять заданную операцию объекта.
submit-label	Строка	Название кнопки отправки формы на открываемой странице	Сохранить
submit-model	resolve filter multi edit datasource	Модель, с которой будет выполняться операция по кнопке "Сохранить".
focus-after-submit	true false	Поставить фокус в текущем виджете на запись, которую вернёт операция объекта
close-after-submit	true false	Закрыть окно после успешного выполнения операции объекта	true
close-on-escape	true false	Закрыть окно по кнопке Esc	true
redirect-url-on-submit-success	Строка	Переадресовать на URL после успешного выполнения операции объекта.
unsaved-data-prompt-on-close	true false	Предупредить о несохраненных данных на форме при закрытии модального окна?	true
master-param	Строка	Параметр фильтра
refresh-widget-id	Строка	Идентификатор виджета, который необходимо обновить после успешного закрытия окна	Текущий виджет
refresh-on-close	true false	Обновление виджета после закрытия drawer	false
closable	true false	Есть ли крестик для закрытия	true
backdrop	true false	Включение маски(backdrop)	true
width	Строка	Ширина компонента
height	Строка	Высота компонента
placement	left top right bottom	Позиция компонента
level	Строка	Сдвиг элемента или группы элементов при открытии
fixed-footer	true false	Фиксирование footer внизу drawer.	false
submit-action-type	invoke copy	Действие при нажатии кнопки "Сохранить"	invoke
copy-model	resolve edit filter multi datasource	Модель виджета открываемой страницы, которая будет скопирована	resolve
copy-widget-id	Строка	Идентификатор виджета открываемой страницы, данные которого будут копироваться	Главный виджет страницы
copy-field-id	Строка	Идентификатор поля виджета открываемой страницы, данные которого будут копироваться	Вся модель
target-model	resolve edit filter multi datasource	Модель виджета текущей страницы, в которую будут скопированы данные	resolve
target-widget-id	Строка	Идентификатор виджета текущей страницы, в которую будут скопированы данные	Текущий виджет
target-field-id	Строка	Идентификатор поля виджета текущей страницы, в которое будут скопированы данные	Вся модель
copy-mode	merge replace add	Тип слияния	merge

Пример

<open-drawer  page-id="employee"  submit-operation-id="create"  upload="defaults">  ...</open-drawer>

<pre-filters>

Тело

Предустановленные фильтры

<path-param>, <query-param>

Тело

Параметры действия

<pre-fields>

Тело

Предустановленные поля

<a>

Открыть страницу браузера.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
href	Строка	Адрес URL. Возможно использование плейсхолдеров {placeholder}
target	self, newWindow, application	Сценарий открытия ссылки: self - в текущей вкладке, newWindow - в новой вкладке, application - в текущем приложении (без обращения к серверу)	self

<path-param>, <query-param>

Тело

Параметры действия

Пример

<a href="https://google.com"/>

<print>

Действие печати

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
url	Строка	Адрес документа для печати

<path-param>, <query-param>

Тело

Параметры действия

Пример

<print url="/files/:doc_id">      <path-param name="doc_id" value="{doc_id}"/></print>

<refresh>

Действие обновления данных виджета

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
widget-id	Строка	Идентификатор обновляемого виджета	Текущий виджет

Пример

<refresh widget-id="reports"/>

<invoke>

Выполнить операцию объекта.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
operation-id	Ссылка на операцию объекта	Операция объекта, которая будет выполнена над моделью виджета
object-id	Ссылка на объект	Ссылка на объект содержащий выполняемую операцию	Объект виджета
route	Строка	URL адрес действия	Формируется изидентификаторов страницы, виджета и действия
close-on-success	true false	Закрыть окно после успешного выполнения действия. Закроется модальное окно, либо откроется предыдущая страница в хлебных крошках.	false
refresh-on-success	true false	Необходимо ли обновлять виджет после успешного выполнения действия	true
message-on-success	true false	Показать сообщение об успешном выполнении действия	true
message-on-fail	true false	Показать сообщение о неудачном выполнении действия	true
message-position	fixed relative	Фиксированное или относительное положение сообщения
message-placement	top bottom	Положение сообщения при фиксации
redirect-url	Строка	URL адрес, на который произойдет переход сразу после успешного выполнения действия. Можно задавать относительный путь и плейсхолдеры, например, redirect-url="../:id"
redirect-target	self, newWindow, application	Сценарий открытия ссылки сразу после успешного выполнения операции (См. target в <a>).	self
refresh-widget-id	Строка	Идентификатор виджета, который необходимо обновить после успешного выполнения действия	Текущий виджет
optimistic	true false	Включение режима optimistic запросов на сервер	false
method	POST, PUT, DELETE.	Вызываемый метод.	POST

<path-param>, <form-param>, <header-param>

Тело

Параметры действия

Пример

<invoke operation-id="update" model="edit"  confirm="false" close-on-success="true" method="POST">    <form-param id="..." value="..."/>    <path-param name="..." value="..."/>    <header-param name="..." value="..."/></invoke>

<perform-validation>

Провалидировать виджет.

Пример

<perform-validation model="edit"/>

<close>

Закрыть страницу.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
unsaved-data-prompt	true false	Показать предупреждение о наличии несохраненных данных.	true
refresh	true false	Обновлять родительский виджет при закрытии модального/дровер окна.	false

Пример

<close unsaved-data-prompt="false"/>

<copy>

Копирование данных.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
source-model	resolve edit filter multi datasource	Модель, которая будет скопирована	resolve
source-widget-id	Строка	Идентификатор виджета источника	Текущий виджет
source-field-id	Строка	Идентификатор копируемого поля источника	Вся модель
target-model	resolve edit filter multi datasource	Модель, в которую будут скопированы данные	resolve
target-page-id	Строка	Идентификатор целевой страницы	Текущая страница
target-widget-id	Строка	Идентификатор целевого виджета	Текущий виджет
target-field-id	Строка	Идентификатор поля целевого виджета, в которое будут скопированы данные	Вся модель
mode	merge replace add	Тип слияния данных	merge

Пример

<copy source-field-id="id" target-widget-id="table"      target-field-id="dictionary.id"/>

<clear>

Очистить модель.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
model	resolve filter multi edit datasource	Модель, которая будет очищена.	Текущая модель виджета.
close-on-success	true, false	Закрыть окно после успешного выполнения действия.	false

Пример

<clear model="edit"/>

<set-value>

Установить значение в модель.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
target-field-id	Ссылка на поле модели	Поле модели, которое будет перезаписано значением, которое вернет функция в теле. При отсутствии, будет перезаписана вся модель.

Тело

JavaScript функция.

Пример

<set-value model="edit" target-field-id="fullname">  return firstName + lastName;</set-value>

<execute-query>

Сделать запрос за выборкой данных.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
query-id	Ссылка на выборку	Выборка, которая будет запрошена
target-field-id	Ссылка на поле модели	Поле модели, которое будет перезаписано значением, которое вернет выборка. При отсутствии, будет перезаписана вся модель.
value-field-id	Ссылка на поле выборки	Поле выборки, которое будет взято для записи в модель. При отсутствии, будет взята вся выборка. Если выборка вернула несколько значений, в каждом значении возьмется только это поле.

Тело

Фильтры

Пример

<execute-query  model="edit"  query-id="users"  target-field-id="name"  value-field-id="fullname">  <pre-filters>    <eq field-id="username" value="admin"/>  </pre-filters></execute-query>

<perform>

Настраиваемое действие Redux с произвольными атрибутами.

Пример

<button src="MyCustomButton" ext:prop1="value1">  <perform type="n2o/custom/ACTION" ext:prop2="value2"/></button>

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
type	Строка	Тип действия Redux.

<set-value>

Установка значения в заданную модель.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
source-widget	Строка	Ссылка на исходный виджет	Текущий виджет
source-model	resolve filter edit multi datasource	Исходная модель	resolve
to	Строка	Поле для записи значения	Вся модель
target-widget	Строка	Ссылка на целевой виджет	Текущий виджет
target-model	resolve filter edit multi datasource	Целевая модель	resolve
merge-mode	merge, replace, add	Тип слияния данных	replace

Пример

<button label="Сколько время?">  <set-value to="clock">moment().format('hh:mm:ss')</set-value></button><output-text id="clock" label="Время"/>

<submit>

Отправка значения на сервер при его изменении

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
operation-id	Строка	Идентификатор операции, которая должна вызваться
message-on-success	true false	Показать сообщение об успешном выполнении действия	false
message-on-fail	true false	Показать сообщение о неудачном выполнении действия	false
message-position	fixed relative	Фиксированное или относительное положение сообщения
message-placement	top bottom	Положение сообщения при фиксации
route	Строка	URL запроса
refresh-on-success	true false	Необходимо ли обновлять виджет	false
refresh-widget-id	Строка	Ссылка на обновляемый виджет

Пример

<submit operation-id="saveName" route="/saveName/{a}">    <path-param/>    <query-param/>    <header-param/>    <form-param/></submit>

<path-param>

Параметры URL

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
name	Строка	Название параметра
value	Строка	Значение параметра
ref-widget-id	Строка	Идентификатор виджета, по полю которого будет фильтрация
ref-model	resolve edit filter multi datasource	Модель виджета, по полю которого будет фильтрация

Пример

<path-param name="a" value="{id}" ref-widget-id="master" ref-model="filter"/>

<header-param>

Параметры заголовка запроса

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
name	Строка	Название параметра
value	Строка	Значение параметра
ref-widget-id	Строка	Идентификатор виджета, по полю которого будет фильтрация
ref-model	resolve edit filter multi datasource	Модель виджета, по полю которого будет фильтрация

Пример

<header-param name="b" value="{id}" ref-widget-id="master" ref-model="filter"/>

<form-param>

Параметры тела запроса

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
id	Строка	Идентификатор параметра
value	Строка	Значение параметра
ref-widget-id	Строка	Идентификатор виджета, по полю которого будет фильтрация
ref-model	resolve edit filter multi datasource	Модель виджета, по полю которого будет фильтрация

Пример

<form-param id="c" value="{id}" ref-widget-id="master" ref-model="filter"/>