Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
S
sd-doc
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Valentin Skripnikov
sd-doc
Commits
c77fb1c1
Commit
c77fb1c1
authored
Sep 26, 2017
by
Valentin Skripnikov
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
-
parent
c644be7b
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
70 additions
and
82 deletions
+70
-82
docs/form_scripting.rst
docs/form_scripting.rst
+1
-1
docs/forms/cmp/base.rst
docs/forms/cmp/base.rst
+69
-81
No files found.
docs/form_scripting.rst
View file @
c77fb1c1
...
...
@@ -121,7 +121,7 @@
.. warning:: Если код скрипта содержит конструкции, не соответствующие стандарту ES5, то они не будут выполняться. Это не является ошибкой Synergy.
Документация
API
Справочник
API
~~~~~~~~~~~~~~~~
.. toctree::
...
...
docs/forms/cmp/base.rst
View file @
c77fb1c1
Базовые
-------
Базовая модель
"""""""""""""""
.. js:class:: AS.FORMS.View
--------------------------------------------------------------------------------
**Поля базовой модели**
.. js:data:: asfProperty
Базовое отображение. Наследуют все компоненты.
Определение компонента из описания формы
.. js:data:: model
.. js:data:: playerModel
Модель проигрывателя
--------------------------------------------------------------------------------
Модель. Наследует AS.FORMS.Model
**Методы базовой модели**
.. js:data:: container
.. js:function:: fireChangeEvents()
Контейнер, в котором будет отрисовываться отображение
Вызов событий изменения значения формы
.. js:data:: input
.. js:function:: isEmpty()
Поле ввода для некоторых компонентов:
* текстовое поле
* числовое поле
* многострочный текст
Пустое ли значение
.. js:data:: playerView
.. js:function:: doSetValue(newValue)
Отображение проигрывателя
Вставить новое значение и отправить уведомление всем подписанным объектам, в т.ч. отображению
.. js:function:: unmarkInvalid()
:param string newValue: Значение компонента
Убрать пометку неправильно заполненного поля
.. js:function:: getErrors
()
.. js:function:: markInvalid
()
Получение ошибок заполнения поля согласно настройкам ``asfProperty``
Пометить поле как неправильно заполненное
:returns: возвращает массив ошибок. Если массив пустой, значит ошибки отсутствуют,
иначе - его элементы имеют поля:
.. js:function:: checkValid()
* ``errorCode`` - код ошибки;
* ``id`` - идентификатор компонента.
Проверить корректность текущего значения (если поле заполнено неверно, то вызовется метод markInvalid)
Возможные коды ошибок:
.. js:function:: setEnabled(enabled)
* ``emptyValue``
* ``wrongValue``
* ``deletedValue``
* ``valueTooHigh``
* ``valueTooSmall``
Сделать доступным или недоступным для редактирования
Для одного и того же компонента может быть как несколько ошибок, так может и не быть ни одной.
:param boolean enabled: true/false
.. js:function:: getLocale(
)
.. js:function:: setVisible(visible
)
Получение локали, настроенной в компоненте
Сделать видимым или невидимым
:returns: *(string)* Локаль пользователя
:param boolean visible: true/false
.. js:function:: getHTMLValue
()
.. js:function:: updateValueFromModel
()
:returns: *(string)* HTML-представлениe текстового значения поля со стилям
и
Обновить отображение согласно значению модел
и
..
js:function:: getValue()
..
note:: Если скрывается последний компонент в строке, то вся строка принимает минимальную высоту 18 px.
:returns: *(string)* значение компонента
--------------------------------------------------------------------------------
.. js:
function:: getTextValue()
.. js:
class:: AS.FORMS.Model
:returns: *(string)* текстовое значение компонента
.. js:data:: asfProperty
.. js:function:: getAsfData([blockNumber])
Определение компонента из описания формы
:param number blockNumber: Номер строки динамической таблицы (если это компонент статической таблицы, то передавать эту переменную не нужно)
:returns: *(asfData)* Данные компонента
.. js:data:: playerModel
.. js:function:: setAsfData(asfData)
Модель проигрывателя
Вставить значение `asfData`
.. js:function:: fireChangeEvents()
:param asfData asfData: Данные компонента в формате JSON.
Вызов событий изменения значения формы
Базовое отображение
"""""""""""""""""""
.. js:function:: isEmpty()
**Поля базового отображения**
Пустое ли значение
.. js:data:: model
.. js:function:: doSetValue(newValue)
Модель. Наследует AS.FORMS.Model
Вставить новое значение и отправить уведомление всем подписанным объектам, в т.ч. отображению
.. js:data:: container
:param string newValue: Значение компонента
Контейнер, в котором будет отрисовываться отображение
.. js:function:: getErrors()
.. js:data:: input
Получение ошибок заполнения поля согласно настройкам ``asfProperty``
Поле ввода для некоторых компонентов:
* текстовое поле
* числовое поле
* многострочный текст
:returns: возвращает массив ошибок. Если массив пустой, значит ошибки отсутствуют,
иначе - его элементы имеют поля:
.. js:data:: playerView
* ``errorCode`` - код ошибки;
* ``id`` - идентификатор компонента.
Отображение проигрывателя
Возможные коды ошибок:
--------------------------------------------------------------------------------
* ``emptyValue``
* ``wrongValue``
* ``deletedValue``
* ``valueTooHigh``
* ``valueTooSmall``
**Базовые методы отображения**
Для одного и того же компонента может быть как несколько ошибок, так может и не быть ни одной.
.. js:function:: unmarkInvalid
()
.. js:function:: getLocale
()
Убрать пометку неправильно заполненного поля
Получение локали, настроенной в компоненте
.. js:function:: markInvalid()
:returns: *(string)* Локаль пользователя
Пометить поле как неправильно заполненное
.. js:function:: getHTMLValue()
.. js:function:: checkValid()
:returns: *(string)* HTML-представлениe текстового значения поля со стилями
Проверить корректность текущего значения (если поле заполнено неверно, то вызовется метод markInvalid
)
.. js:function:: getValue(
)
.. js:function:: setEnabled(enabled)
:returns: *(string)* значение компонента
Сделать доступным или недоступным для редактирования
.. js:function:: getTextValue()
:param boolean enabled: true/false
:returns: *(string)* текстовое значение компонента
.. js:function:: setVisible(visible
)
.. js:function:: getAsfData([blockNumber]
)
Сделать видимым или невидимым
:param number blockNumber: Номер строки динамической таблицы (если это компонент статической таблицы, то передавать эту переменную не нужно)
:returns: *(asfData)* Данные компонента
:param boolean visible: true/false
.. js:function:: setAsfData(asfData)
.. js:function:: updateValueFromModel()
Вставить значение `asfData`
Обновить отображение согласно значению модели
.. note:: Если скрывается последний компонент в строке, то вся строка принимает минимальную высоту 18 px.
:param asfData asfData: Данные компонента в формате JSON.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment