rpa.fieldscontroller

Расширение для работы со списком пользовательских полей.

BX.Rpa.FieldsController

Методы

Метод	Описание	С версии
`constructor(params: {})`	Конструктор. Список `params` имеет следующую структуру: `fields: ?Object` - массив с данными о настройках пользовательских полей, которые должны быть отрисованы `hiddenFields: ?Object` - массив с данными о настройках пользовательских полей, которые должны быть показаны в выпадающем списке "Выбрать поле" `factory: ?Factory` - инстанс BX.UI.UserFieldFactory.Factory `fieldSubTitle: ?string` - подзаголовок, который будет отображаться над каждым полем в списке `errorContainer: ?Element` - DOM-нода для отрисовки сообщений об ошибках `settings: ?{}` - список для настроек видимости полей: `inputName: string` - имя для инпута переключателя видимости `values: ?Object` - набор существующих настроек `typeId: number` - идентификатор процесса `languageId: string` - идентификатор языка
`getFields(): Map`	Метод вернет список пользовательских полей BX.UI.UserField, которые должны быть отрисованы в списке.
`addField(userField: UserField): this`	Метод добавит поле `userField` в список отображаемых.
`removeField(userField: UserField): this`	Метод удалит поле `userField` из списка отображаемых.
`addHiddenField(userField: UserField): this`	Метод добавит поле `userField` в список скрытых полей.
`removeHiddenField(userField: UserField): this`	Метод удалит поле `userField` из скрытых полей.
`render(): Element`	Метод отрисует список с кнопками и вернет DOM-элемент.
`renderContainer(): Element`	Метод вернет ноду контейнера. Если он был отрисован, то он будет перезаписан.
`getContainer(): ?Element`	Метод вернет ноду контейнера, если он был отрисован.
`getFieldRow(userField: UserField): ?Element`	Вернет ноду, в которой отрисовано пользовательское поле.
`renderField(userField: UserField): Element`	Отрисует пользовательское поле `userField`.
`static getSwitcherId(inputName: string, fieldName: string): string`	Метод вернет идентификатор переключателя `BX.UI.Switcher`.
`renderSwitcher(userField: UserField): Element`	Отрисует переключатель `BX.UI.Switcher` и вернет ноду.
`renderFooter(): Element`	Отрисует нижнюю часть с кнопками, если оно ещё не было отрисовано.
`updateSelectButtonAppearance(): this`	Показывает / скрывает кнопку "Выбрать поле", в зависимости от наличия скрытых полей.
`getCreateButton(): Element`	Отрисует кнопку "Создать поле", если она не была отрисована.
`handleCreateButtonClick()`	Метод вызывается при клике на кнопку "Создать поле".
`getSelectButton(): Element`	Отрисует кнопку "Выбрать поле", если она не была отрисована.
`handleSelectButtonClick()`	Метод вызывается при клике на кнопку "Выбрать поле".
`handleUserFieldTypeClick(fieldType: string)`	Метод вызывается при клике по типу поля в меню кнопки "Создать поле".
`showFieldConfigurator(userField: UserField)`	Метод покажет форму настройки поля `userField`.
`hideFieldConfigurator(userField: UserField)`	Метод скроет форму настройки поля `userField`.
`handleFieldSave(userField: UserField)`	Метод вызывается при сохранении настроек поля `userField` в форме.
`isProgress()`	Метод вернет `true`, если сейчас производится обработка ajax-запроса.
`startProgress(): this`	Метод обозначает начало обработки ajax-запроса.
`stopProgress(): this`	Метод сбрасывает статус обработки ajax-запроса.
`getLoader()`	Метод возвращает инстанс `BX.Loader`.
`showError(error, errorContainer: ?Element)`	Метод покажет ошибку `error`.
`getSettings(): Object`	Метод вернет актуальный набор настроек.
`getSelectFieldsMenuId(): string`	Вернет идентификатор меню для кнопки "Выбрать поле".
`getSelectFieldsMenuItems(): Array`	Вернет массив с описанием элементов для меню кнопки "Выбрать поле".
`getSelectFieldsMenu(): Menu`	Вернет меню для кнопки "Выбрать поле".
`handleHiddenUserFieldClick(userField: UserField)`	Вызывается при клике на поле в меню кнопки "Выбрать поле".
`getSettingsMenu(button: Element, userField: UserField): Menu`	Возвращает меню для шестеренки `button` поля `userField`.

События

namespace: BX.Rpa.FieldsController.

Событие Описание С версии

Событие	Описание	С версии
`onFieldSave`	Событие срабатывает после сохранения настроек пользовательского поля. В обработчик события приходит объект сохраненного поля `BX.UI.UserField`: `{ "userField": BX.UI.UserField }`

onFieldSave

Событие срабатывает после сохранения настроек пользовательского поля.

В обработчик события приходит объект сохраненного поля BX.UI.UserField:

{
	"userField": BX.UI.UserField
}