Страницы

Тип метаданных

page

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

http://n2oapp.net/framework/config/schema/page-4.0

Виды страниц

<simple-page>

Страница с единственным виджетом.

Пример

<?xml version='1.0' encoding='UTF-8'?><simple-page xmlns="http://n2oapp.net/framework/config/schema/page-4.0"    name="Моя страница">    <form>...</form></simple-page>

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
name	Строка	Наименование страницы	Берётся из виджета
title	Строка	Заголовок страницы
html-title	Строка	Заголовок вкладки браузера	Наименование страницы
route	Строка	URL страницы	Формируется из идентификатора страницы
modal-size	sm lg	Размер модального окна, если страница открыта в модальном окне
show-title	true false	Показывать заголовок страницы?	false

Тело

Виджет

<page>

Страница с регионами.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
src	Строка	Реализация страницы
name	Строка	Наименование страницы
title	Строка	Заголовок страницы
html-title	Строка	Заголовок вкладки браузера	Наименование страницы
route	Строка	URL страницы	Формируется из идентификатора страницы
modal-size	sm lg	Размер модального окна, если страница открыта в модальном окне
show-title	true false	Показывать заголовок страницы?	false

Тело

Список регионов, Список действий, Меню управляющих кнопок страницы

Пример

<?xml version='1.0' encoding='UTF-8'?><page xmlns="http://n2oapp.net/framework/config/schema/page-4.0"    name="Моя страница">    <regions>...</regions>    <actions>...</actions>    <toolbar>...</toolbar>    <datasources>...</datasources></page>

<left-right-page>

Страница с двумя регионами.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
src	Строка	Реализация страницы
name	Строка	Наименование страницы
title	Строка	Заголовок страницы
html-title	Строка	Заголовок вкладки браузера	Наименование страницы
route	Строка	URL страницы	Формируется из идентификатора страницы
modal-size	sm lg	Размер модального окна, если страница открыта в модальном окне
show-title	true false	Показывать заголовок страницы?	false

Тело

Регионы left и right, Список действий, Меню управляющих кнопок страницы

Пример

<?xml version='1.0' encoding='UTF-8'?><left-right-page xmlns="http://n2oapp.net/framework/config/schema/page-4.0"    name="Моя страница">    <datasources>...</datasources>    <actions>...</actions>    <toolbar>...</toolbar>    <left>...</left>    <right>...</right></left-right-page>

Регионы <left> <right>

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
width	Строка	Ширина региона

Тело

Список регионов Список виджетов

Пример

<left width="40%">...</left><right width="60%">...</right>

<top-left-right-page>

Страница с тремя регионами.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
src	Строка	Реализация страницы
name	Строка	Наименование страницы
title	Строка	Заголовок страницы
html-title	Строка	Заголовок вкладки браузера	Наименование страницы
route	Строка	URL страницы	Формируется из идентификатора страницы
modal-size	sm lg	Размер модального окна, если страница открыта в модальном окне
show-title	true false	Показывать заголовок страницы?	false
scroll-top-button	true false	Показывается ли кнопка скролла в начало страницы	false

Тело

Регионы top, left и right, Список действий, Меню управляющих кнопок страницы

Пример

<?xml version='1.0' encoding='UTF-8'?><top-left-right-page xmlns="http://n2oapp.net/framework/config/schema/page-4.0"    name="Моя страница">    <datasources>...</datasources>    <actions>...</actions>    <toolbar>...</toolbar>    <top>...</top>    <left>...</left>    <right>...</right></top-left-right-page>

Регионы <top> <left> <right>

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
width	Строка	Ширина региона
fixed	true false	Зафиксирован ли регион. Фиксироваться может максимум 2 региона из 3	false
offset	Число	Отступ от верхней границы при фиксировании

Пример

<top fixed="true" offset="100">...</top><left width="40%">...</left><right fixed="true" width="60%" offset="100">...</right>

Тело

Список регионов Список виджетов

<searchable-page>

Страница с поисковой строкой.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
src	Строка	Реализация страницы
name	Строка	Наименование страницы
title	Строка	Заголовок страницы
html-title	Строка	Заголовок вкладки браузера	Наименование страницы
route	Строка	URL страницы	Формируется из идентификатора страницы
modal-size	sm lg	Размер модального окна, если страница открыта в модальном окне
show-title	true false	Показывать заголовок страницы?	false

Тело

Поисковая строка, Список регионов, Список действий, Меню управляющих кнопок страницы

Пример

<?xml version='1.0' encoding='UTF-8'?><searchable-page xmlns="http://n2oapp.net/framework/config/schema/page-4.0"    name="Моя страница">    <search-bar/>    <regions>...</regions>    <actions>...</actions>    <toolbar>...</toolbar></page>

<search-bar>

Поисковая строка.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
class	Строка	CSS класс стилей
placeholder	Строка	Подсказка для ввода
datasource	Строка	Идентификатор источника данных, в котором производится поиск	Главный виджет страницы
search-filter-id	Строка	Идентификатор фильтра
search-param	Строка	Параметр поиска	Идентификатор виджета + Идентификатор фильтра (table_name)

Пример

<search-bar button-label="Искать" datasource="main" search-filter-id="name"/>

Источники данных

Пример

<datasources>  <datasource id="ds1">...</datasource>  <datasource id="ds2">...</datasource>  <datasource id="ds3">...</datasource></datasource>

<datasource>

Источник данных

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
id	Строка	Идентификатор источника данных
query-id	Строка	Идентификатор выборки, на основе которой происходит получение данных
object-id	Строка	Идентификатор объекта
default-values-mode	defaults, query, merge	Подстановка значений по умолчанию. defaults - значения по умолчанию заполняются данными прописанными в полях query - значения по умолчанию заполняются данными из запроса merge - значения по умолчанию заполняются путем мержа данных прописанных в полях и полученных из запроса(полученные из запроса в приоритете), id игнорируется	query
size	Число	Размер выборки	10
route	Строка	URL получения данных	true

Тело

Предустановленная фильтрация
Отправка полей на сервер при их изменении
Зависимости источника данных

Пример

<datasource id="ds1">  <filters>    <eq field-id="id" value={id}/>    ...  </filters>  <submit>    ...  </submit>  <dependencies>    <fetch on="ds2"/>    ...  </dependencies></datasource>

Зависимости источника данных

Обновление данных при изменении зависимых источников данных <fetch>

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
on	Строка	Иденитификатор источника данных
model	filter,resolve,edit,datasource	Модель источника данных	resolve

Пример

<dependencies>    <fetch on="ds2" model="filter"/></dependencies>

Действия на странице

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
generate	crud, submit, close	Генерация стандартных действий

Пример

<actions generate="save, close">  <action>...</action>  <action>...</action>  <action>...</action></actions>

<action>

Действие на странице.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
id	Строка	Идентификатор действия
name	Строка	Наименование	Вычисляется по операции объекта
route	Строка	URL действия	Формируется из идентификатора действия
icon	CSS класс	Иконка действия	Вычисляется, если id действия из списка стандартных действий.
hotkey	Сочетание клавиш	Горячая клавиша вызова	Вычисляется, если id действия из списка стандартных действий. Например, для save горячая клавиша Enter.
visible	true false	Видимость действия	true
enabled	true false	Доступность действия	true
model	resolve filter edit multi datasource	Модель, на которой выполнится действие	resolve
datasource	true false	Идентификатор источника данных для выполнения действия	true

Тело

Обработчик действия

Пример

<action  id="save">  <invoke    operation-id="update"    model="edit"    confirm="false"/></action>

Меню управляющих кнопок страницы

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
place	topLeft, topRight, bottomLeft, bottomRight, breadcrumbLeft	Место расположения меню	topLeft
generate	crud, submit, close	Генерация стандартных кнопок

Пример

<toolbar place="topLeft" generate="submit, close">  <group>...</group>  <button>...</button>  <sub-menu>...</sub-menu></toolbar>

<button>

Кнопка

<sub-menu>

Кнопка с выпадающим меню

<group>

Группа кнопок

Регионы

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

http://n2oapp.net/framework/config/schema/region-3.0

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

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
id	Строка	Идентификатор региона	Местоположение региона на странице + порядковый номер
place	Строка	Местоположение региона на странице
src	React компонент	Реализация региона	Для каждого вида региона своё значение по умолчанию
class	CSS класс	CSS класс панели
style	CSS свойство	Стиль панели

<tabs>

Регион в виде вкладок.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
always-refresh	true false	Возможность обновления данных при переключении между вкладками	false
lazy	true false	Ленивая загрузка вкладок	true
active-param	Строка	Имя параметра активной вкладки в URL
routable	true false	Восстановление активных вкладок по URL	true
hide-single-tab	true false	Скрытие единственной доступной вкладки и отображение только ее содержимого	false
max-height	Строка	Максимальная высота содержимого вкладок
scrollbar	true false	Отображение полосы прокрутки	false

Пример

<tabs always-refresh="true">  <tab> <!-- Первая вкладка -->    ...  </tab>  <tab> <!-- Вторая вкладка -->    ...  </tab></tabs>

<tab>

Вкладка.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
id	Строка	Идентификатор вкладки
name	Строка	Наименование вкладки

Пример

<tab id="tab1" name="Вкладка">  <form/>  <panel/>  <table/></tab>

Тело

Список регионов Список виджетов

<line>

Регион с горизонтальным делителем.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
label	Строка	Заголовок региона
collapsible	true false	Возможность раскрытия и сворачивания региона	true
has-separator	true false	Наличие горизонтального делителя	true
expand	true false	Исходное раскрытие региона	true

Пример

<line collapsible="true" label="Line1">  <table/>  <panel/>  <form/></line>

Тело

Список регионов Список виджетов

<panel>

Регион в виде панелей.

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
title	Строка	Заголовок
collapsible	true false	Возможность раскрытия и сворачивания содержимого панели	true
header	true false	Наличие заголовка	true
icon	CSS класс	Класс иконки
color	Строка	Стиль панели
open	true false	Раскрытие панели	true
footer-title	Строка	Заголовок для подвала региона

Пример

<panel collapsible="true" class="bg-primary">  <form/>  <line/>  <table/></panel>

Тело

Список регионов Список виджетов

<region>

Кастомный регион.

Пример

<region>  <table/>  <tabs/>  <form/></region>

Тело

Список регионов Список виджетов

<scrollspy>

Регион с отслеживанием прокрутки

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
active	Строка	Активный элемент по умолчанию
title	Строка	Общий некликабельный заголовок меню
placement	left right	Расположение меню	left
headlines	true false	Наличие разделительной строки между блоками	false
routable	true false	Восстановление активного элемента по URL	true
active-param	Строка	Имя параметра активного элемента в URL

Пример

<scrollspy active="mi1"            title="regionTitle"            placement="right"            headlines="true"            routable="false">    <menu-item>        ...    </menu-item>    <sub-menu>        ...    </sub-menu></scrollspy>

Тело

Список элементов меню Список вложенных меню

<menu-item>

Элемент меню

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
id	Строка	Идентификатор элемента меню
title	Строка	Название элемента меню

Пример

<menu-item id="mi1" title="First item title in the list">     <table/>     <form/></menu-item>

Тело

Список регионов Список виджетов

<sub-menu>

Вложенное меню

Атрибуты

Наименование	Тип	Описание	Значение по умолчанию
id	Строка	Идентификатор вложенного меню
title	Строка	Заголовок вложенного меню

Пример

<sub-menu id="mi3" title="Third item title in the list">     <menu-item>        ...     </menu-item>     <menu-item>        ...     </menu-item></sub-menu>

Тело

Список элементов меню Список вложенных меню