Перечень компонентов и их атрибутов
===============================================

.. toctree::
   :maxdepth: 3
   :glob:
   :numbered:
   
   
Виды компонентов
---------------------------

**Стандартные**
~~~~~~~~~~~~~~~~~~~

* **Панель** - специальный тип компонента, который может содержать в себе вложенные компоненты, в том числе и другие панели.

* **Надпись** - позволяет задать текстовый заголовок на компоненте.

* **Кнопка** - интерактивный компонент, при нажатии на который запускается связанное с ним событие или действие.

* **Представление реестра** - компонент, отображающий записи реестра в Synergy.

* **Проигрыватель форм** - компонент, отображающий форму документа из Synergy.

* **Поле для ввода** - компонент, позволяющий вводить текстовые данные (например, логин и пароль на странице авторизации)

* **Выбор языка** - компонент для смены локали приложения.

* **Список файлов** - компонент, отображающий список файлов папки в Хранилище Synergy.

* **Список работ** - компонент, отображающий список работ авторизованного пользователя из Synergy.

* **Изображение** - добавление графических файлов на страницу приложения.

* **Видео** - добавление видеофайлов на страницу приложения


**Пользовательские** 
~~~~~~~~~~~~~~~~~~~

Компоненты, разработанные специально для одного или нескольких приложений конструктора.


Описание компонентов
---------------------------

Панель
~~~~~~~~~~~~~~~~~~~

**Описание** - компонент предназначен для группировки и настройки способа отображения компонентов и других панелей на странице. 
Сама страница представляет собой панель с кодом 'root-panel'.

**Специальные свойства**

* Тип панели

  * Обычная
  * Горизонтальная
  * Вертикальная
  * Итератор
  
Для Обычной/Горизонтальная/Вертикальная:

* Выравнивание по горизонтали
* Выравнивание по вертикали
* Выравнивать содержимое

Для итератора:

* Источник
* URL


**Входные параметры**

*Не имеет собственных значений*

**Выходные параметры**

*Не имеет собственных значений*

**Событие**

*Не имеет собственных значений*

**Специальные Действия над компонентом (для группы действий "Выполнить на странице")**

*Не имеет собственных значений*

Надпись
~~~~~~~~~~~~~~~~~~~

**Описание** - компонент предназначен для размещения на странице статичного текста, недоступного пользователю на редактирование, 
но имеющего возможность меняться под влиянием внешних обработчиков событий.


**Свойства**

* Текст (с переводами)
* Тип (Текст/Заголовок)
* Стиль
* Размер
* Выравнивание
* Выравнивание текста
* Стиль текста

**Входные параметры**

* Текст 
* Локализованный текст 


**Выходные параметры**

* Текст
* Локализованный текст

**Событие**

* Клик

**Специальные Действия над компонентом (для группы действий "Выполнить на странице")**

* Изменить текст

Параметры действия: Источник:

* Произвольный текст (поле для ввода URL)                     
* Параметры страницы (поле для выбора параметра)               
* Значения компонента (поле для выбора компонента)            
* Локализованный текст (поле для ввода URL)                    
* Параметр итератора (поле для ввода параметра)                
* Кастомный источник  

Кнопка
~~~~~~~~~~~~~~~~~~~

**Описание** - компонент предназначен для осуществления назначенных на него событий или действий.


**Свойства**

* Текст (с переводами)
* Иконка
* Расположение иконки
* Тултип
* Заблокировано
* Размер
* Тип

**Входные параметры**

*Не имеет собственных значений* 


**Выходные параметры**

*Не имеет собственных значений* 

**Событие**

* Клик

**Специальные Действия над компонентом (для группы действий "Выполнить на странице")**

* Скрыть/показать
* Включить/Выключить
* Изменить подпись кнопки
* Изменить размер кнопки
* Изменить тип кнопки
* Изменить URL (для типа кнопки "ссылка")

Поле для ввода
~~~~~~~~~~~~~~~~~~~

**Описание** - компонент предназначен для ввода пользователем текста на странице.


**Свойства**

* Значение по умолчанию
* Лейбл
* Иконка
* Плейсхолдер
* Настройки (Иконка справа/Не отображать вводимые символы/Обязательное/Многострочный/Заблокировано)
* Корректное значение (маска ввода)

**Входные параметры**

* Значение
* Значение по умолчанию
* Лейбл
* Плейсхолдер


**Выходные параметры**

* Значение
* Значение по умолчанию
* Лейбл
* Плейсхолдер


**Событие**

* Фокусировка на поле ввода
* Пустое поле ввода
* Заполнение значения
* Изменение значения
* Корректное значение
* Некорректное значение
* Нажатие кнопки Enter


**Специальные Действия над компонентом (для группы действий "Выполнить на странице")**

* Включить/Выключить
* Отобразить/Скрыть вводимые символы
* Обязательное/Не обязательное
* Корректное/Не корректное значение

Выбор языка
~~~~~~~~~~~~~~~~~~~

**Описание** - компонент предназначен для смены локали


**Свойства**

* код локали

**Входные параметры**

*Не имеет собственных значений* 


**Выходные параметры**

*Не имеет собственных значений* 

**Событие**

* Локаль

**Специальные Действия над компонентом (для группы действий "Выполнить на странице")**

* Скрыть/показать

Изображение
~~~~~~~~~~~~~~~~~~~

**Описание** - компонент предназначен для добавления графических изображений на страницу.


**Свойства**

* Источник
* Плейсхолдер

**Входные параметры**

*Не имеет собственных значений* 

**Выходные параметры**

*Не имеет собственных значений* 

**Событие**

* Клик

**Специальные Действия над компонентом (для группы действий "Выполнить на странице")**

* Изменить ссылку
* Изменить id файла из хранилища
* Скрыть/показать
* Изменить UUID записи по форме
* Изменить код компонента формы

Видео
~~~~~~~~~~~~~~~~~~~

**Описание** - компонент предназначен для добавления медиаконтента на страницу.


**Свойства**

* Источник
* Плейсхолдер

**Входные параметры**

*Не имеет собственных значений* 

**Выходные параметры**

*Не имеет собственных значений* 

**Событие**

* Клик

**Специальные Действия над компонентом (для группы действий "Выполнить на странице")**

* Изменить ссылку
* Изменить id  файла из хранилища
* Скрыть/показать
* Изменить UUID записи по форме
* Изменить код компонента формы

Представление реестра
~~~~~~~~~~~~~~~~~~~~~~~~~~

**Описание** - компонент предназначен для отображения существующих реестров Synergy.


**Свойства**

* Код реестра
* Код фильтра
* Количество записей на странице
* Скрыть пагинатор
* Положение пагинатора
* Заголовки жирным шрифтом
* Чередующаяся заливка строк
* Отключить фильтр поиска

**Входные параметры**

*Не имеет собственных значений*  


**Выходные параметры**

*Не имеет собственных значений*  

**Событие**

* Выбрать запись реестра
* Существует предыдущая страница
* Отсутствует предыдущая страница
* Существует следующая страница
* Отсутствует следующая страница

**Специальные Действия над компонентом (для группы действий "Выполнить на странице")**

* Изменить реестр
* Изменить фильтр реестра
* Изменить количество отображаемых записей
* Отобразить следующую страницу
* Отобразить предыдущую страницу
* Скрыть/показать
* Обновить данные
* registry_header_bold
* registry_paginator_position
* registry_hide_paginator
* registry_visible_cols
* registry_disable_filter_input
* registry_color_filling

Проигрыватель форм
~~~~~~~~~~~~~~~~~~~~~~~~~~

**Описание** - компонент предназначен для отображения существующих форм Synergy.


**Свойства**

* Код формы
* Код представления
* Идентификатор данных по форме
* Открывать в режиме редактирования
* Создать запись реестра 
* Активировать запись реестра
* Код реестра

**Входные параметры**

*Не имеет собственных значений*


**Выходные параметры**

*Не имеет собственных значений* 

**Событие**

* Успешная загрузка данных
* Изменение записи по форме
* Корректно заполнены поля
* Некорректно заполнены поля
* Успешное создание записи по форме
* Неуспешное создание записи по форме
* Успешное сохранение данных по форме
* Неуспешное сохранение данных по форме

**Специальные Действия над компонентом (для группы действий "Выполнить на странице")**

* Изменить форму
* Изменить запись
* Выбрать представление формы
* Изменить режим отображения
* Сохранить форму
* Создать запись по форме
* Скрыть/показать

Список файлов
~~~~~~~~~~~~~~~~~~~~~~~~~~

**Описание** - компонент предназначен для отображения файлов из хранилища Synergy


**Свойства**

* Папка в хранилище
* Отображать название
* Отображать размер
* Отображать иконку
* Отображать дату изменения
* Отображать загрузившего
* Чередующаяся заливка строк
* Сортировать по полю
* Направление сортировки

**Входные параметры**

*Не имеет собственных значений*


**Выходные параметры**

*Не имеет собственных значений*

**Событие**

* Выбрать запись из списка

**Специальные Действия над компонентом (для группы действий "Выполнить на странице")**

* Изменить папку
* Измениь сортировку
* Отображение даты изменения
* Отображение загрузившего
* Отображение размера
* Обновить данные
* Отображение названия
* Отображение иконок
* file_list_color_filling
* Скрыть/показать

Список работ
~~~~~~~~~~~~~~~~~~~~~~~~~~

**Описание** - компонент предназначен для отображения существующих работ из Потоков работ Synergy.


**Свойства**

* Количество работ на страницце
* Фильтр работ
* Отображать удаленные
* Отображать завершенные
* Чередующаяся заливка строк
* Период работ

**Входные параметры**

*Не имеет собственных значений*


**Выходные параметры**

*Не имеет собственных значений* 

**Событие**

* Клик по определенной работе
* Двойной клик по определенной работе

**Специальные Действия над компонентом (для группы действий "Выполнить на странице")**

* Изменить фильтр работ
* Изменить код фильтра
* Изменить период работ
* Изменить количество отображаемых записей
* Отображать завершенные работы
* Отображать удаленные работы
* Обновить список работ
* worklist_color_filling
* Скрыть/показать