Skip to main content

Структура приложения

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

application

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

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

<application>

Атрибуты

НаименованиеТипОписаниеЗначение по умолчанию
navigation-layoutСтрокаМакет отображения элементов управления.
Возможные значения:
fullSizeHeader - заголовок во всю ширину экрана
fullSizeSidebar - боковая панель во всю высоту экрана
fullSizeHeader
navigation-layout-fixedtrue falseЗафиксированы ли header и sidebarfalse
welcome-page-idСтрокаСсылка на страницу, которая открывается по root(/)

Настройки

# Макет отображения элементов управления.
n2o.application.navigation_layout=fullSizeHeader
# Зафиксированы ли header и sidebar
n2o.application.navigation_layout_fixed=false

Тело
<datasources> - Источники данных
<events> - События
<header> - Шапка
<sidebars> - Боковые панели
<footer> - Подвал

Пример

<?xml version='1.0' encoding='UTF-8'?>
<application xmlns="http://n2oapp.net/framework/config/schema/application-3.0"
navigation-layout="fullSizeSidebar" navigation-layout-fixed="true" welcome-page-id="index">
<datasources>...</datasources>
<events>...</events>
<header>...</header>
<sidebars>...</sidebars>
<footer>...</footer>
</application>

<events>

События.

Тело
<stomp-event> - Событие, приходящее через STOMP протокол

Пример

<?xml version='1.0' encoding='UTF-8'?>
<application xmlns="http://n2oapp.net/framework/config/schema/application-3.0">
<events>
...
</events>
</application>

<stomp-event>

Событие, приходящее через STOMP протокол.

Атрибуты

НаименованиеТипОписаниеЗначение по умолчанию
idСтрокаИдентификатор события
destinationСтрокаМесто назначения

Тело
<alert> - Действие уведомления

Пример

<?xml version='1.0' encoding='UTF-8'?>
<application xmlns="http://n2oapp.net/framework/config/schema/application-3.0">
<events>
<stomp-event id="ev1" destination="/notifications">
...
</stomp-event>
</events>
</application>

Шапка.

Атрибуты

НаименованиеТипОписаниеЗначение по умолчанию
srcСтрокаReact компонент шапкиHeader
classCSS классКласс компонента шапки
styleCSS свойствоСтиль компонента шапки
datasourceСсылка на источник данныхИдентификатор источника данных
titleСтрокаЗаголовок шапки. Поддерживаются плейсхолдеры
visibletrue falseВидимость шапкиtrue
logo-srcСтрокаПуть к файлу с логотипом, который будет отображаться в шапке
home-page-urlСтрокаURL домашней страницы(переход на нее происходит по клику на логотип или название в шапке)
sidebar-iconКласс иконкиИконка открытия боковой панели, если не задана, значит кнопки не будет
sidebar-toggled-iconКласс иконкиИконка скрытия боковой панели, если не задана, значит кнопки не будет

Тело
<nav> - Основное меню
<extra-menu> - Дополнительное меню
<search> - Панель поиска

Пример

<?xml version='1.0' encoding='UTF-8'?>
<application xmlns="http://n2oapp.net/framework/config/schema/application-3.0">
<header title="N2O">
<nav>...</nav>
<extra-menu>...</extra-menu>
<search query-id="q1">...</search>
</header>
</application>

Боковые панели.

Тело
<sidebar> - Боковая панель

Пример

<?xml version='1.0' encoding='UTF-8'?>
<application xmlns="http://n2oapp.net/framework/config/schema/application-3.0">
<sidebars>
...
</sidebars>
</application>

Боковая панель.

Атрибуты

НаименованиеТипОписаниеЗначение по умолчанию
srcСтрокаReact компонент боковой панелиSidebar
classCSS классКласс компонента боковой панели
styleCSS свойствоСтиль компонента боковой панели
titleСтрокаНазвание в заголовке боковой панели
ref-idСтрокаСсылка на родительский файл боковой панели
subtitleСтрокаНазвание в подзаголовке боковой панели
datasourceСсылка на источник данныхИдентификатор источника данных боковой панели
pathСтрокаURL по которому будет отображаться боковая панель
visibletrue falseВидимость боковой панелиtrue
sideleft rightСторона появления боковой панелиleft
welcome-page-idСсылкаСсылка на страницу
logo-srcСтрокаПуть к файлу с логотипом, который будет
отображаться в заголовке боковой панели
home-page-urlСтрокаURL страницы, переход на которую происходит
по клику на логотип или название
в заголовке боковой панели
logo-classCSS классCSS класс для области с логотипом и названием
default-statenone micro mini maxiСостояние сайдбара по умолчанию.
Возможные значения:
none - скрыт полностью
micro - отображается тонкая полоска
mini - отображаются только иконки
maxi - широкая боковая панель
none, если у <header> задан атрибут sidebar-icon или sidebar-toggled-icon, иначе maxi
toggled-statenone micro mini maxiСостояние боковой панели принимаемое
при нажатии на кнопку toggle-sidebar, которую можно
добавить в меню заголовка приложения с помощью атрибута sidebar-toggled-icon. Возможные значения:
none - скрыт полностью
micro - отображается тонкая полоска
mini - отображаются только иконки
maxi - широкая боковая панель
toggle-on-hovertrue falseОткрывается ли панель по hoverfalse
overlaytrue falseПерекрывает ли боковая панель контент страницыtrue

Настройки

#Сторона появления
n2o.api.sidebar.side=left
#Открывается ли панель по hover
n2o.api.sidebar.toggle_on_hover=false
#Перекрывает ли боковая панель контент страницы
n2o.api.sidebar.overlay=false
#Количество записей в боковой панели (число)
n2o.api.sidebar.size=1

Тело
<datasource> - Стандартный источник данных
Список элементов навигационной панели

Пример

<?xml version='1.0' encoding='UTF-8'?>
<application xmlns="http://n2oapp.net/framework/config/schema/application-3.0">
<sidebars>
<sidebar title="N2O">
<datasource id="ds1"/>
<nav>...</nav>
<extra-menu>...</extra-menu>
</sidebar>
</sidebars>
</application>

Подвал.

Атрибуты

НаименованиеТипОписаниеЗначение по умолчанию
srcСтрокаReact компонент подвалаDefaultFooter
classCSS классКласс компонента подвала
styleCSS свойствоСтиль компонента подвала
right-textСтрокаТекст в подвале справа
left-textСтрокаТекст в подвале слева
visibletrue falseВидимость подвалаtrue

Пример

<?xml version='1.0' encoding='UTF-8'?>
<application xmlns="http://n2oapp.net/framework/config/schema/application-3.0">
<footer left-text="N2O"/>
</application>

Основное меню.

Атрибуты

НаименованиеТипОписаниеЗначение по умолчанию
srcСтрокаReact компонент меню
ref-idСсылкаСсылка на родительский файл меню

Тело
Список элементов меню

Пример

<nav>
<a href="http://google.com/"/>
<page page-id="ProtoPage" route="/proto" label="Контакты"/>
<sub-menu>...</sub-menu>
</nav>

<extra-menu>

Дополнительное меню.

Атрибуты

НаименованиеТипОписаниеЗначение по умолчанию
srcСтрокаReact компонент шапки
ref-idСсылкаСсылка на родительский файл меню

Тело
Список элементов меню

Пример

<extra-menu>
<page page-id="ProtoPage" route="/proto" label="Контакты"/>
<a href="http://google.com/"/>
<sub-menu>...</sub-menu>
</extra-menu>

Панель поиска.

Атрибуты

НаименованиеТипОписаниеЗначение по умолчанию
query-idСтрокаЗапрос за данными
filter-field-idСтрокаИдентификатор поля фильтра
url-field-idСтрокаПоле выборки, отвечающее за ссылку перехода на результат поиска
label-field-idСтрокаПоле выборки, отвечающее за заголовок
icon-field-idСтрокаПоле выборки, отвечающее за иконку
description-field-idСтрокаПоле выборки, отвечающее за описание
advanced-targetself newWindow applicationТип сценария открытия ссылки
advanced-urlСтрокаБазовый url
advanced-paramСтрокаПараметр фильтра

Пример

<search
query-id="popupSearch"
filter-field-id="filterValue"
url-field-id="href"
label-field-id="label"
icon-field-id="icon"
description-field-id="description"
advanced-target="application"
advanced-url="/search"
advanced-param="q"
/>