Skip to main content

Страницы

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

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-sizesm lgРазмер модального окна, если страница открыта в модальном окне
show-titletrue falseПоказывать заголовок страницы?false

Тело

Виджет

<page>#

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

Атрибуты

НаименованиеТипОписаниеЗначение по умолчанию
srcСтрокаРеализация страницы
nameСтрокаНаименование страницы
titleСтрокаЗаголовок страницы
html-titleСтрокаЗаголовок вкладки браузераНаименование страницы
routeСтрокаURL страницыФормируется из идентификатора страницы
modal-sizesm lgРазмер модального окна, если страница открыта в модальном окне
show-titletrue 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-sizesm lgРазмер модального окна, если страница открыта в модальном окне
show-titletrue 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-sizesm lgРазмер модального окна, если страница открыта в модальном окне
show-titletrue falseПоказывать заголовок страницы?false
scroll-top-buttontrue 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СтрокаШирина региона
fixedtrue falseЗафиксирован ли регион. Фиксироваться может максимум 2 региона из 3false
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-sizesm lgРазмер модального окна, если страница открыта в модальном окне
show-titletrue 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-modedefaults, 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СтрокаИденитификатор источника данных
modelfilter,resolve,edit,datasourceМодель источника данныхresolve

Пример

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

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

Атрибуты

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

Пример

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

<action>#

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

Атрибуты

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

Тело

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

Пример

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

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

Атрибуты

НаименованиеТипОписаниеЗначение по умолчанию
placetopLeft, topRight, bottomLeft, bottomRight, breadcrumbLeftМесто расположения менюtopLeft
generatecrud, 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СтрокаМестоположение региона на странице
srcReact компонентРеализация регионаДля каждого вида региона своё значение по умолчанию
classCSS классCSS класс панели
styleCSS свойствоСтиль панели

<tabs>#

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

Атрибуты

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

Пример

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

<tab>#

Вкладка.

Атрибуты

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

Пример

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

Тело

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

<line>#

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

Атрибуты

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

Пример

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

Тело

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

<panel>#

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

Атрибуты

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

Пример

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

Тело

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

<region>#

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

Пример

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

Тело

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

<scrollspy>#

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

Атрибуты

НаименованиеТипОписаниеЗначение по умолчанию
activeСтрокаАктивный элемент по умолчанию
titleСтрокаОбщий некликабельный заголовок меню
placementleft rightРасположение менюleft
headlinestrue falseНаличие разделительной строки между блокамиfalse
routabletrue falseВосстановление активного элемента по URLtrue
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>

Тело

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