Skip to content

S
Synergy Constructor
Commit ba55ec9b authored by Irina Oleynik's avatar Irina Oleynik
Browse files
Options

Update events.rst

parent 111b579d
Hide whitespace changes
Inline Side-by-side
Showing with 184 additions and 133 deletions
user_manual/events.rst
View file @ ba55ec9b
События конструктора
===========
Общие события для компонентов
--------
Событие скрытия компонента
~~~~~~~~~~~~~~~~~
......@@ -15,7 +19,22 @@
* fire(event, 'код компонента, который хотим скрыть')
*/
SET_HIDDEN = 'set_hidden',
Событие блокировки компонента
~~~~~~~~~~~~~~~~~
.. code-block:: js
* Событие блокировки компонента, может быть использовано для "Поле для ввода" (input) и "Кнопка" (button)
* Пример генерации события:
* let event = {
* type: 'set_disabled',
* disabled: false
* }
* fire(event, 'код компонента, который хотим скрыть')
*/
SET_DISABLED = 'set_disabled',
Событие для изменения store Пользовательского компонента
~~~~~~~~~~~~~~~~~
......@@ -31,7 +50,57 @@
*/
CHANGE_CUSTOM_COMP_STORE = 'change_custom_comp_store',
Событие для изменения отображаемого фильтра (централизованного) в компоненте "Список работ"
Событие рендера кастомного компонента
~~~~~~~~~~~~~~~~~
.. code-block:: js
* Событие рендера кастомного компонента
* Пример подписки на событие:
* addListener('render_custom_comp', 'my_form_code', (e) => { // ...Your Code })
*/
RENDER_CUSTOM_COMP = 'render_custom_comp',
Событие для отображения сообщения
~~~~~~~~~~~~~~~~~
.. code-block:: js
* Событие для отображения сообщения. Принимает 2 параметра:
* @messageType 'error' | 'success' | 'info'
* @text: текст сообщения
* Пример генерации события:
* let event = {
* type: 'show_message',
* text: 'Текст сообщения',
* messageType: 'info'
* }
* fire(event, 'код компонента')
*/
SHOW_MESSAGE = 'show_message',
Событие для обновлении данных
~~~~~~~~~~~~~~~~~
Создан для компонентов, работающих со внешними ресурсами
.. code-block:: js
* Событие для обновлении данных. Создан для тех компонент которые работают с внешними ресурсами
* Итератор, Преставление реестра, Список работ, Список файлов
* Пример генерации события:
*
* let event = {
* type: 'reload_data',
* }
* fire(event, 'my_reloadable_component');
*/
RELOAD_DATA = 'reload_data',
События для компонента "Список работ"
---------
Событие для изменения отображаемого фильтра (централизованного)
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -46,7 +115,7 @@
*/
WORKLIST_FILTER_CODE_CHANGE = 'worklist_filter_code_change',
Изменение периода отображаемых работ в компоненте "Список работ"
Изменение периода отображаемых работ
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -70,18 +139,7 @@
* fire(event, 'код компонента "Список работ"')
*/
WORKLIST_PERIOD_CHANGE = 'worklist_period_change',
Событие загрузки страницы
~~~~~~~~~~~~~~~~~
.. code-block:: js
* Событие загрузки страницы.
* Пример подписки на событие:
* addListener('page_load', 'any_comp_code', (e) => { // ...Your Code })
*/
PAGE_LOAD = 'page_load',
Событие изменения сортировки списка работ
~~~~~~~~~~~~~~~~~
......@@ -106,7 +164,7 @@
WORKLIST_TABLE_SORT = 'worklist_table_sort',
Событие отображения удаленных работ в списке работ
Событие отображения удаленных работ
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -121,7 +179,7 @@
*/
WORKLIST_SHOW_DELETED_CHANGE = 'worklist_ext_show_deleted_change',
Событие отображения завершенных работ в списке работ
Событие отображения завершенных работ
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -136,7 +194,7 @@
*/
WORKLIST_SHOW_COMPLETED_CHANGE = 'worklist_ext_show_completed_change',
Событие клика на конкретную работу в списке работ
Событие клика на конкретную работу
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -146,8 +204,19 @@
* addListener('worklist_item_click', 'my_work_list_comp', (e) => { console.log(e) })
*/
WORKLIST_ITEM_CLICK = 'worklist_item_click',
Событие изменения количества отображаемых работ на странице списка работ
Событие двойного клика по работе
~~~~~~~~~~~~~~~~~
.. code-block:: js
* Событие клика на конкретную работу в списке работ
* Пример подписки на событие:
addListener('worklist_item_dbl_click', 'workList-1', (e) => {
console.log('dblclick', e)
})
Событие изменения количества отображаемых работ
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -180,6 +249,10 @@
// TODO пока еще нет такого кейса
WORKLIST_COLOR_FILLING = 'worklist_color_filling',
События для компонента "Представление реестра"
--------
Событие для изменения отображаемого реестра по коду
~~~~~~~~~~~~~~~~~
......@@ -195,7 +268,7 @@
*/
REGISTRY_CODE_CHANGE = 'registry_code_change',
Событие клика на конкретную запись в представлении реестра
Событие клика на конкретную запись
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -208,7 +281,7 @@
*/
REGISTRY_ITEM_CLICK = 'registry_item_click',
Событие успешной загрузки записей реестра в представлении реестра
Событие успешной загрузки записей реестра
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -219,7 +292,7 @@
*/
REGISTRY_DATA_LOADED = 'registry_data_loaded',
Событие для перехода на указанную страницу в представлении реестра
Событие для перехода на указанную страницу
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -234,7 +307,7 @@
*/
REGISTRY_PAGE_CHANGE = 'registry_page_change',
Событие для перехода на следущую страницу в представлении реестра
Событие для перехода на следущую страницу
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -248,7 +321,7 @@
*/
REGISTRY_PAGE_NEXT = 'registry_page_next',
Событие для перехода на предыдущую страницу в представлении реестра
Событие для перехода на предыдущую страницу
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -262,7 +335,7 @@
*/
REGISTRY_PAGE_BACK = 'registry_page_back',
Событие для изменения количества отображаемых записей на одной странице в представлении реестра
Событие для изменения количества отображаемых записей
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -292,7 +365,7 @@
// TODO пока еще нет такого кейса
REGISTRY_COLOR_FILLING = 'registry_color_filling',
Событие изменения отображаемого кода фильтра реестра в представлении реестра
Событие изменения отображаемого кода фильтра реестра
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -307,7 +380,7 @@
*/
REGISTRY_FILTER_CHANGE = 'registry_filter_change',
Событие, генерируемое при наличии предыдущей страницы в представлении реестра
Событие, генерируемое при наличии предыдущей страницы
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -318,7 +391,7 @@
*/
HAS_PREVIOUS_PAGE = 'has_previous_page',
Событие, генерируемое при отсутствии предыдущей страницы в представлении реестра
Событие, генерируемое при отсутствии предыдущей страницы
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -329,7 +402,7 @@
*/
NO_PREVIOUS_PAGE = 'no_previous_page',
Событие, генерируемое при наличии следующей страницы в представлении реестра
Событие, генерируемое при наличии следующей страницы
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -340,7 +413,7 @@
*/
HAS_NEXT_PAGE = 'has_next_page',
Событие, генерируемое при отсутствии следующей страницы в представлении реестра
Событие, генерируемое при отсутствии следующей страницы
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -351,7 +424,21 @@
*/
NO_NEXT_PAGE = 'no_next_page',
Событие для перехода на другую страницу приложения с передачей ей параметров
События для страницы
--------
Событие загрузки страницы
~~~~~~~~~~~~~~~~~
.. code-block:: js
* Событие загрузки страницы.
* Пример подписки на событие:
* addListener('page_load', 'any_comp_code', (e) => { // ...Your Code })
*/
PAGE_LOAD = 'page_load',
Событие для перехода на другую страницу приложения
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -377,7 +464,7 @@
*/
GOTO_PAGE = 'goto_page',
Событие для перехода на страницу авторизации с передачей ей целевой страницы
Событие для перехода на страницу авторизации
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -392,6 +479,20 @@
*/
GOTO_LOGIN_PAGE = 'goto_login_page',
Служебное событие заполнения параметров страницы
~~~~~~~~~~~~~~~~~
Не рекомендуется подписываться на это событие.
.. code-block:: js
* Служебное событие заполнения параметров страницы, не рекомендуется подписываться на него.
*/
FILL_PARAM_DATA = 'fill_param_data',
События для компонентов "Надпись" и "Кнопка"
-------
Событие для изменения текста, отображаемого в компоненте "Надпись"
~~~~~~~~~~~~~~~~~
......@@ -421,21 +522,6 @@
*/
LABEL_CLICK = 'label_click',
Событие блокировки компонента
~~~~~~~~~~~~~~~~~
.. code-block:: js
* Событие блокировки компонента, может быть использовано для "Поле для ввода" (input) и "Кнопка" (button)
* Пример генерации события:
* let event = {
* type: 'set_disabled',
* disabled: false
* }
* fire(event, 'код компонента, который хотим скрыть')
*/
SET_DISABLED = 'set_disabled',
Событие для имитации клика на компонент "Кнопка"
~~~~~~~~~~~~~~~~~
......@@ -505,25 +591,10 @@
// TODO пока еще нет такого кейса
BUTTON_CHANGE_URL = 'button_change_url',
Событие для отображения сообщения
~~~~~~~~~~~~~~~~~
.. code-block:: js
События для компонента "Проигрыватель форм"
---------
* Событие для отображения сообщения. Принимает 2 параметра:
* @messageType 'error' | 'success' | 'info'
* @text: текст сообщения
* Пример генерации события:
* let event = {
* type: 'show_message',
* text: 'Текст сообщения',
* messageType: 'info'
* }
* fire(event, 'код компонента')
*/
SHOW_MESSAGE = 'show_message',
Событие для отображения указанной записи по ее идентификатору в проигрывателе форм
Событие для отображения указанной записи по ее идентификатору
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -538,7 +609,7 @@
*/
SHOW_FORM_DATA = 'show_form_data',
Событие для отображения указанной формы по ее коду в проигрывателе форм
Событие для отображения указанной формы по ее коду
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -553,7 +624,7 @@
*/
SHOW_FORM = 'show_form',
Событие для отображения указанного представления текущей формы в проигрывателе форм
Событие для отображения указанного представления текущей формы
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -568,7 +639,7 @@
*/
SHOW_FORM_VIEW = 'show_form_view',
Событие для изменения режима отображения формы в проигрывателе форм
Событие для изменения режима отображения формы
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -583,7 +654,7 @@
*/
SET_FORM_EDITABLE = 'set_form_editable',
Событие изменения записи по форме в проигрывателе форм
Событие изменения записи по форме
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -594,7 +665,7 @@
*/
CHANGED_FORM_DATA = 'changed_form_data',
Событие успешной загрузки данных в проигрывателе форм
Событие успешной загрузки данных
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -605,17 +676,6 @@
*/
LOADED_FORM_DATA = 'loaded_form_data',
Событие рендера кастомного компонента
~~~~~~~~~~~~~~~~~
.. code-block:: js
* Событие рендера кастомного компонента
* Пример подписки на событие:
* addListener('render_custom_comp', 'my_form_code', (e) => { // ...Your Code })
*/
RENDER_CUSTOM_COMP = 'render_custom_comp',
Событие для сохранения данных по форме
~~~~~~~~~~~~~~~~~
......@@ -635,7 +695,7 @@
*/
SAVE_FORM_DATA = 'save_form_data',
Событие для создания новой записи по форме
Событие для создания новой записи
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -658,7 +718,7 @@
*/
CREATE_FORM_DATA = 'create_form_data',
Событие для проверки валидности данных формы
Событие для проверки валидности данных
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -675,7 +735,7 @@
*/
VALIDATE_FORM_DATA = 'validate_form_data',
Событие успешного сохранения существующей записи по форме
Событие успешного сохранения существующей записи
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -686,7 +746,7 @@
*/
SAVED_FORM_DATA = 'saved_form_data',
Событие неуспешного сохранения существующей записи по форме
Событие неуспешного сохранения существующей записи
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -697,7 +757,7 @@
*/
NOT_SAVED_FORM_DATA = 'not_saved_form_data',
Событие успешного создания новой записи по форме
Событие успешного создания новой записи
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -708,7 +768,7 @@
*/
CREATED_FORM_DATA = 'created_form_data',
Событие неуспешного создания новой записи по форме
Событие неуспешного создания новой записи
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -719,7 +779,7 @@
*/
NOT_CREATED_FORM_DATA = 'not_created_form_data',
Событие валидности данных в проигрывателе форм
Событие валидности данных
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -730,7 +790,7 @@
*/
VALID_FORM_DATA = 'valid_form_data',
Событие невалидности данных в проигрывателе форм
Событие невалидности данных
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -741,6 +801,9 @@
*/
NOT_VALID_FORM_DATA = 'not_valid_form_data',
События для компонента "Поле ввода"
---------
Событие установки фокуса на компонент "Поле ввода"
~~~~~~~~~~~~~~~~~
......@@ -774,7 +837,7 @@
*/
NOT_FILLED_INPUT = 'not_filled_input',
Событие изменения содержинмого в компоненте "Поле ввода"
Событие изменения содержимого
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -785,7 +848,7 @@
*/
VALUE_CHANGED_INPUT = 'value_changed_input',
Событие валидности данных в компоненте "Поле ввода"
Событие валидности данных
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -796,7 +859,7 @@
*/
VALID_INPUT = 'valid_input',
Событие невалидности данных в компоненте "Поле ввода"
Событие невалидности данных
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -818,7 +881,7 @@
*/
TEXT_INPUT_KEY_DOWN_ENTER = 'text_input_key_down_enter',
Событие для изменения заголовка компонента "Поле ввода"
Событие для изменения заголовка компонента
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -837,7 +900,7 @@
// TODO пока еще нет такого кейса
INPUT_ICON_CHANGE = 'input_icon_change',
Событие для изменения плейсхолдера в компоненте "Поле ввода"
Событие для изменения плейсхолдера
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -853,7 +916,7 @@
*/
INPUT_PLACEHOLDER_CHANGE = 'input_placeholder_change',
Событие для изменения содержимого по умолчанию в компоненте "Поле ввода"
Событие для изменения содержимого по умолчанию
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -917,7 +980,10 @@
*/
INPUT_HIGHLIGHT = 'input_highlight',
Событие для изменения отображаемой папки в компоненте "Список файлов"
События для компонента "Список файлов"
-------
Событие для изменения отображаемой папки
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -933,7 +999,7 @@
*/
FILE_LIST_CHANGE_UUID = 'file_list_change_uuid',
Событие для включения/отключения отображения иконок в компоненте "Список файлов"
Событие для включения/отключения отображения иконок
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -949,7 +1015,7 @@
*/
FILE_LIST_CHANGE_SHOW_ICON = 'file_list_change_show_icon',
Событие для включения/отключения отображения названий файлов в компоненте "Список файлов"
Событие для включения/отключения отображения названий файлов
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -965,7 +1031,7 @@
*/
FILE_LIST_CHANGE_SHOW_NAME = 'file_list_change_show_name',
Событие для включения/отключения отображения авторов файлов в компоненте "Список файлов"
Событие для включения/отключения отображения авторов файлов
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -1062,6 +1128,9 @@
// TODO пока еще нет такого кейса
FILE_LIST_COLOR_FILLING = 'file_list_color_filling',
События при авторизации пользователя
--------
Событие успешной авторизации пользователя в приложении
~~~~~~~~~~~~~~~~~
......@@ -1084,7 +1153,10 @@
*/
AUTH_FAILURE = 'auth_failure',
Событие для изменения ссылки на изображение, отображаемое в компоненте "Изображение"
События для компонента "Изображение"
-------
Событие для изменения ссылки на изображение
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -1100,7 +1172,7 @@
*/
IMAGE_CHANGE_URL = 'image_change_url',
Событие для изменения идентификатора записи по форме, в которой расположено изображение, отображаемое в компоненте "Изображение"
Событие для изменения идентификатора записи по форме
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -1116,7 +1188,7 @@
*/
IMAGE_CHANGE_FORM_UUID = 'image_change_form_uuid',
Событие для изменения кода компонента формы, в котором расположено изображение, отображаемое в компоненте "Изображение"
Событие для изменения кода компонента формы
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -1132,7 +1204,7 @@
*/
IMAGE_CHANGE_FORM_DATA_ID = 'image_change_form_data_id',
Событие для изменения идентификатора файла изображения, отображаемого в компоненте "Изображение"
Событие для изменения идентификатора файла изображения
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -1159,6 +1231,9 @@
*/
IMAGE_EVENT_CLICK = 'image_event_on_click',
События для модальной панели и итератора
--------
Событие клика вне модальной панели
~~~~~~~~~~~~~~~~~
......@@ -1170,16 +1245,8 @@
*/
OUT_CLICK = 'out_click',
Служебное событие заполнения параметров страницы, не рекомендуется подписываться на него.
~~~~~~~~~~~~~~~~~
.. code-block:: js
* Служебное событие заполнения параметров страницы, не рекомендуется подписываться на него.
*/
FILL_PARAM_DATA = 'fill_param_data',
Событие для изменения кода реестра, являющегося источником данных для компонента "Итератор"
Событие для изменения кода реестра
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -1195,7 +1262,7 @@
*/
CHANGE_REPEATER_REGISTRY_CODE = 'change_repeater_registry_code',
Событие для изменения кода фильтра реестра, являющегося источником данных для компонента "Итератор"
Событие для изменения кода фильтра реестра
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -1211,7 +1278,7 @@
*/
CHANGE_REPEATER_FILTER_CODE = 'change_repeater_filter_code',
Событие для изменения кода компонента - динамической таблицы, являющейся источником данных для компонента "Итератор"
Событие для изменения кода компонента - динамической таблицы
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -1227,7 +1294,7 @@
*/
CHANGE_REPEATER_TABLE_ID = 'change_repeater_table_id',
Событие для изменения идентификатора записи по форме, динамическая таблица в которой является источником данных для компонента "Итератор"
Событие для изменения идентификатора записи по форме
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -1243,7 +1310,7 @@
*/
CHANGE_REPEATER_DATA_ID = 'change_repeater_data_id',
Событие для изменения внешней ссылки на источник данных для компонента "Итератор"
Событие для изменения внешней ссылки на источник данных
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -1259,7 +1326,7 @@
*/
CHANGE_REPEATER_URL = 'change_repeater_url',
Событие для изменения параметров поиска элементов, отображаемых в компоненте "Итератор"
Событие для изменения параметров поиска элементов
~~~~~~~~~~~~~~~~~
.. code-block:: js
......@@ -1274,19 +1341,3 @@
* fire(event, 'my_repeater_code');
*/
CHANGE_REPEATER_SEARCH_PARAMS = 'change_repeater_search_params',
Событие для обновлении данных. Создан для тех компонент которые работают с внешними ресурсами
~~~~~~~~~~~~~~~~~
.. code-block:: js
* Событие для обновлении данных. Создан для тех компонент которые работают с внешними ресурсами
* Итератор, Преставление реестра, Список работ, Список файлов
* Пример генерации события:
*
* let event = {
* type: 'reload_data',
* }
* fire(event, 'my_reloadable_component');
*/
RELOAD_DATA = 'reload_data',
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment