Commit c77fb1c1 authored by Valentin Skripnikov's avatar Valentin Skripnikov

-

parent c644be7b
...@@ -121,7 +121,7 @@ ...@@ -121,7 +121,7 @@
.. warning:: Если код скрипта содержит конструкции, не соответствующие стандарту ES5, то они не будут выполняться. Это не является ошибкой Synergy. .. warning:: Если код скрипта содержит конструкции, не соответствующие стандарту ES5, то они не будут выполняться. Это не является ошибкой Synergy.
Документация API Справочник API
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
.. toctree:: .. toctree::
......
Базовые Базовые
------- -------
Базовая модель .. js:class:: AS.FORMS.View
"""""""""""""""
-------------------------------------------------------------------------------- Базовое отображение. Наследуют все компоненты.
**Поля базовой модели** .. js:data:: model
.. js:data:: asfProperty Модель. Наследует AS.FORMS.Model
Определение компонента из описания формы .. js:data:: container
.. js:data:: playerModel Контейнер, в котором будет отрисовываться отображение
Модель проигрывателя .. 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.
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
**Методы базовой модели** .. js:class:: AS.FORMS.Model
.. js:data:: asfProperty
.. js:function:: fireChangeEvents() Определение компонента из описания формы
.. js:data:: playerModel
Модель проигрывателя
.. js:function:: fireChangeEvents()
Вызов событий изменения значения формы Вызов событий изменения значения формы
.. js:function:: isEmpty() .. js:function:: isEmpty()
Пустое ли значение Пустое ли значение
.. js:function:: doSetValue(newValue) .. js:function:: doSetValue(newValue)
Вставить новое значение и отправить уведомление всем подписанным объектам, в т.ч. отображению Вставить новое значение и отправить уведомление всем подписанным объектам, в т.ч. отображению
:param string newValue: Значение компонента :param string newValue: Значение компонента
.. js:function:: getErrors() .. js:function:: getErrors()
Получение ошибок заполнения поля согласно настройкам ``asfProperty`` Получение ошибок заполнения поля согласно настройкам ``asfProperty``
...@@ -54,89 +100,31 @@ ...@@ -54,89 +100,31 @@
Для одного и того же компонента может быть как несколько ошибок, так может и не быть ни одной. Для одного и того же компонента может быть как несколько ошибок, так может и не быть ни одной.
.. js:function:: getLocale() .. js:function:: getLocale()
Получение локали, настроенной в компоненте Получение локали, настроенной в компоненте
:returns: *(string)* Локаль пользователя :returns: *(string)* Локаль пользователя
.. js:function:: getHTMLValue() .. js:function:: getHTMLValue()
:returns: *(string)* HTML-представлениe текстового значения поля со стилями :returns: *(string)* HTML-представлениe текстового значения поля со стилями
.. js:function:: getValue() .. js:function:: getValue()
:returns: *(string)* значение компонента :returns: *(string)* значение компонента
.. js:function:: getTextValue() .. js:function:: getTextValue()
:returns: *(string)* текстовое значение компонента :returns: *(string)* текстовое значение компонента
.. js:function:: getAsfData([blockNumber]) .. js:function:: getAsfData([blockNumber])
:param number blockNumber: Номер строки динамической таблицы (если это компонент статической таблицы, то передавать эту переменную не нужно) :param number blockNumber: Номер строки динамической таблицы (если это компонент статической таблицы, то передавать эту переменную не нужно)
:returns: *(asfData)* Данные компонента :returns: *(asfData)* Данные компонента
.. js:function:: setAsfData(asfData) .. js:function:: setAsfData(asfData)
Вставить значение `asfData` Вставить значение `asfData`
:param asfData asfData: Данные компонента в формате JSON. :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.
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