Skip to content

S
sd-doc
Commit c644be7b authored by Valentin Skripnikov's avatar Valentin Skripnikov
Browse files
Options

-

parent de041d7a
Hide whitespace changes
Inline Side-by-side
Showing with 192 additions and 192 deletions
docs/form_scripting.rst
View file @ c644be7b
......@@ -121,201 +121,13 @@
.. warning:: Если код скрипта содержит конструкции, не соответствующие стандарту ES5, то они не будут выполняться. Это не является ошибкой Synergy.
Проигрыватель
~~~~~~~~~~~~~
Для того, чтобы создать экземпляр проигрывателя, необходимо вызвать
метод ``AS.FORMS.createPlayer()``.
.. code-block:: js
var player = AS.FORMS.createPlayer();
Методы проигрывателя
""""""""""""""""""""
.. js:function:: showFormByCode(formCode[,version])
Отображает форму по ее коду, без создания соответствующего экземпляра asfData
:param string formCode: Код формы.
:param number version: Версия формы.
.. js:function:: showFormData(formUUID[, version[, dataUUID[, dataVersion]]])
Отображает форму
:param string formUUID: Идентификатор формы.
:param number version: Номер версии формы.
:param string dataUUID: Идентификатор данных формы.
:param number dataVersion: Номер версии данных формы.
.. js:function:: saveFormData(callback)
Сохраняет данные формы
:param callback: Функция, которая будет вызвана после сохранения данных с параметром asfDataUUID.
.. js:function:: dataLoaded(definition[,data])
Построение формы согласно definition и заполнение asfData значением параметра data.
Вспомогательный метод, вызывающийся при выполнении методов :js:func:`showFormData` и :js:func:`showFormByCode`.
:param string definition: Описание формы в формате JSON.
:param string data: Данные формы в форме JSON.
.. js:function:: destroy()
Удаляет экземпляр проигрывателя
Модели и отображения
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Базовая модель
"""""""""""""""
--------------------------------------------------------------------------------
**Поля базовой модели**
.. js:data:: asfProperty
Определение компонента из описания формы
.. js:data:: playerModel
Модель проигрывателя
--------------------------------------------------------------------------------
**Методы базовой модели**
.. js:function:: fireChangeEvents()
Вызов событий изменения значения формы
.. js:function:: isEmpty()
Пустое ли значение
.. js:function:: doSetValue(newValue)
Вставить новое значение и отправить уведомление всем подписанным объектам, в т.ч. отображению
:param string newValue: Значение компонента
.. js:function:: getErrors()
Получение ошибок заполнения поля согласно настройкам ``asfProperty``
:returns: возвращает массив ошибок. Если массив пустой, значит ошибки отсутствуют,
иначе - его элементы имеют поля:
* ``errorCode`` - код ошибки;
* ``id`` - идентификатор компонента.
Возможные коды ошибок:
* ``emptyValue``
* ``wrongValue``
* ``deletedValue``
* ``valueTooHigh``
* ``valueTooSmall``
Для одного и того же компонента может быть как несколько ошибок, так может и не быть ни одной.
.. js:function:: getLocale()
Получение локали, настроенной в компоненте
:returns: *(string)* Локаль пользователя
.. js:function:: getHTMLValue()
:returns: *(string)* HTML-представлениe текстового значения поля со стилями
.. js:function:: getValue()
:returns: *(string)* значение компонента
.. js:function:: getTextValue()
:returns: *(string)* текстовое значение компонента
.. js:function:: getAsfData([blockNumber])
:param number blockNumber: Номер строки динамической таблицы (если это компонент статической таблицы, то передавать эту переменную не нужно)
:returns: *(asfData)* Данные компонента
.. js:function:: setAsfData(asfData)
Вставить значение `asfData`
:param asfData asfData: Данные компонента в формате JSON.
Базовое отображение
"""""""""""""""""""
**Поля базового отображения**
.. js:data:: model
Модель. Наследует AS.FORMS.Model
.. js:data:: container
Контейнер, в котором будет отрисовываться отображение
.. js:data:: input
Поле ввода для некоторых компонентов:
* текстовое поле
* числовое поле
* многострочный текст
.. js:data:: playerView
Отображение проигрывателя
--------------------------------------------------------------------------------
**Базовые методы отображения**
.. js:function:: unmarkInvalid()
Убрать пометку неправильно заполненного поля
.. js:function:: markInvalid()
Пометить поле как неправильно заполненное
.. js:function:: checkValid()
Проверить корректность текущего значения (если поле заполнено неверно, то вызовется метод markInvalid)
.. js:function:: setEnabled(enabled)
Сделать доступным или недоступным для редактирования
:param boolean enabled: true/false
.. js:function:: setVisible(visible)
Сделать видимым или невидимым
:param boolean visible: true/false
.. js:function:: updateValueFromModel()
Обновить отображение согласно значению модели
.. note:: Если скрывается последний компонент в строке, то вся строка принимает минимальную высоту 18 px.
Компоненты
""""""""""
Документация API
~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 2
:numbered:
forms/player
forms/cmp/base
forms/cmp/table
docs/forms/cmp/base.rst 0 → 100644
View file @ c644be7b
Базовые
-------
Базовая модель
"""""""""""""""
--------------------------------------------------------------------------------
**Поля базовой модели**
.. js:data:: asfProperty
Определение компонента из описания формы
.. js:data:: playerModel
Модель проигрывателя
--------------------------------------------------------------------------------
**Методы базовой модели**
.. js:function:: fireChangeEvents()
Вызов событий изменения значения формы
.. js:function:: isEmpty()
Пустое ли значение
.. js:function:: doSetValue(newValue)
Вставить новое значение и отправить уведомление всем подписанным объектам, в т.ч. отображению
:param string newValue: Значение компонента
.. js:function:: getErrors()
Получение ошибок заполнения поля согласно настройкам ``asfProperty``
:returns: возвращает массив ошибок. Если массив пустой, значит ошибки отсутствуют,
иначе - его элементы имеют поля:
* ``errorCode`` - код ошибки;
* ``id`` - идентификатор компонента.
Возможные коды ошибок:
* ``emptyValue``
* ``wrongValue``
* ``deletedValue``
* ``valueTooHigh``
* ``valueTooSmall``
Для одного и того же компонента может быть как несколько ошибок, так может и не быть ни одной.
.. js:function:: getLocale()
Получение локали, настроенной в компоненте
:returns: *(string)* Локаль пользователя
.. js:function:: getHTMLValue()
:returns: *(string)* HTML-представлениe текстового значения поля со стилями
.. js:function:: getValue()
:returns: *(string)* значение компонента
.. js:function:: getTextValue()
:returns: *(string)* текстовое значение компонента
.. js:function:: getAsfData([blockNumber])
:param number blockNumber: Номер строки динамической таблицы (если это компонент статической таблицы, то передавать эту переменную не нужно)
:returns: *(asfData)* Данные компонента
.. js:function:: setAsfData(asfData)
Вставить значение `asfData`
:param asfData asfData: Данные компонента в формате JSON.
Базовое отображение
"""""""""""""""""""
**Поля базового отображения**
.. js:data:: model
Модель. Наследует AS.FORMS.Model
.. js:data:: container
Контейнер, в котором будет отрисовываться отображение
.. js:data:: input
Поле ввода для некоторых компонентов:
* текстовое поле
* числовое поле
* многострочный текст
.. js:data:: playerView
Отображение проигрывателя
--------------------------------------------------------------------------------
**Базовые методы отображения**
.. js:function:: unmarkInvalid()
Убрать пометку неправильно заполненного поля
.. js:function:: markInvalid()
Пометить поле как неправильно заполненное
.. js:function:: checkValid()
Проверить корректность текущего значения (если поле заполнено неверно, то вызовется метод markInvalid)
.. js:function:: setEnabled(enabled)
Сделать доступным или недоступным для редактирования
:param boolean enabled: true/false
.. js:function:: setVisible(visible)
Сделать видимым или невидимым
:param boolean visible: true/false
.. js:function:: updateValueFromModel()
Обновить отображение согласно значению модели
.. note:: Если скрывается последний компонент в строке, то вся строка принимает минимальную высоту 18 px.
docs/forms/player.rst 0 → 100644
View file @ c644be7b
Проигрыватель
~~~~~~~~~~~~~
Для того, чтобы создать экземпляр проигрывателя, необходимо вызвать
метод ``AS.FORMS.createPlayer()``.
.. code-block:: js
var player = AS.FORMS.createPlayer();
Методы проигрывателя
""""""""""""""""""""
.. js:function:: showFormByCode(formCode[,version])
Отображает форму по ее коду, без создания соответствующего экземпляра asfData
:param string formCode: Код формы.
:param number version: Версия формы.
.. js:function:: showFormData(formUUID[, version[, dataUUID[, dataVersion]]])
Отображает форму
:param string formUUID: Идентификатор формы.
:param number version: Номер версии формы.
:param string dataUUID: Идентификатор данных формы.
:param number dataVersion: Номер версии данных формы.
.. js:function:: saveFormData(callback)
Сохраняет данные формы
:param callback: Функция, которая будет вызвана после сохранения данных с параметром asfDataUUID.
.. js:function:: dataLoaded(definition[,data])
Построение формы согласно definition и заполнение asfData значением параметра data.
Вспомогательный метод, вызывающийся при выполнении методов :js:func:`showFormData` и :js:func:`showFormByCode`.
:param string definition: Описание формы в формате JSON.
:param string data: Данные формы в форме JSON.
.. js:function:: destroy()
Удаляет экземпляр проигрывателя
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