Копировать ссылку на страницу

Унаследован от BaseObject

Расширен с помощью примеси pluginMixin

Свойства:

Имя

Тип

Описание

displayErrors

string

["tip","inline", "none"] – режим отображения ошибок, возникающих при проверке корректности заполнения формы

Исключения:

ERR_NOT_ALL_REQUIRED_ARGUMENTS_HAVE_BEEN_SUPLIED – заданы не все обязательные параметры.

Свернуть/развернуть пример Пример:

var form = new WebAccess.components.forms.FormBuilder("uniq_id");
var form_html = form.addInput("ERR_ELEMENT_DOES_NOT_EXIST")
.addInput("NOT_CREATED_SESSION_MANAGER")
.addInput("EDOCUMENT_SIGN")
.addText("NO_RIGHTS_FOR_SIGN_EDOC_DUE_EDIT")
.addTextarea("REPORT_ASKABLE_PARAMS")
.addInput("NOT_CREATED_SESSION_MANAGER")
.render();
WebAccess.current.sideBar.tabs.FldTree.setHtml(form_html);

var CP = WA.components;
var form = new CP.forms.FormBuilder("filter_save_modal");
form.addPick("FILTER_NAME", {"key": "value", "key2": "value2"}, null, null, true, {"isRequired": true});
var dialog = new CP.dialogs.BaseDialog();
dialog.title = L("SAVE_NEW_FILTER");
dialog.html = form.render();
dialog.height = form.getHeigth();
dialog.isShowCancelButton = true;
dialog.ok = function() {
if (form.isValid() === false) return false;
var filterName = form.getValue("FILTER_NAME");
var displayValue = form.getDisplayValue("FILTER_NAME");
if (filterName === "") {
CallService("/Service.asmx/CreateNewFilter", {"ReferenceCode": WA.current.getReferenceCode() ,"Name": displayValue} , function(response) {
});
}};
dialog.show();

Свернуть/развернуть Конструктор

Синтаксис:

 

new WebAccess.components.forms.FormBuilder();

Параметры:

Имя

Тип

Описание

id

string

Уникальный идентификатор формы. Параметр является обязательным

Свернуть/развернуть Методы часть 1

Свернуть/развернуть Public method setOrientation – Изменить ориентацию содержимого формы

Синтаксис:

 

setOrientation(orientation)

Параметры:

Имя

Тип

Описание

orientation

string

Ориентация HTML-разметки. Возможные значения: "vertical" – поля располагаются под названием поля; "horizontal" – поле и его название располагаются в одной строке. Значение по умолчанию - "horizontal"

Описание:

Поддерживается вертикальная и горизонтальная ориентация.

Метод используется до вызова одной из функций добавления поля, например addText или addReferenceSelect, сразу после вызова конструктора либо после вызова метода render.

Возвращаемое значение:

Oбъект класса FormBuilder.

Свернуть/развернуть Public method getValue – Получить значение поля

Синтаксис:

 

getValue(name, opt_byId)

Параметры:

Имя

Тип

Описание

name

string

Строка локализации равная идентификатору этого поля

opt_byId

boolean

Признак, отключено ли внутреннее преобразование идентификатора. Если отключено, указанный идентификатор используется в неизменном виде

Возвращаемое значение:

Значение поля.

Свернуть/развернуть Public method setValue – Устанавливает значение указанного поля

Синтаксис:

 

setValue(name, value, displayValue, opt_byId)

Параметры:

Имя

Тип

Описание

name

string

Строка локализации равная идентификатору этого поля

value

string

Значение поля

displayValue

string

Отображаемое значение поля

opt_byId

boolean

Отключить внутренние преобразования идентификатора, и использовать указанный.

Описание:

Метод можно использовать, только когда поле уже отображаетсяна странице.

Например, если форма используется в модальном окне, то метод необходимо использовать только после события open модального окна:

 

dialog.bind('open', function() {
form.setValue(.....)
...
})

 

Возвращаемое значение:

Объект типа FormBuilder.

Свернуть/развернуть Public method getDisplayValue – Получить отображаемое значение поля

Синтаксис:

 

getDisplayValue(name)

Параметры:

Имя

Тип

Описание

name

string

Имя поля

Возвращаемое значение:

Отображаемое значение поля.

Свернуть/развернуть Public method setValue – Устанавливает значение указанного поля

Синтаксис:

 

setValue(name, value, displayValue, opt_byId)

Параметры:

Имя

Тип

Описание

name

string

Строка локализации равная идентификатору этого поля

value

string

Значение поля

displayValue

string

Отображаемое значение поля

opt_byId

boolean

Отключить внутренние преобразования идентификатора, и использовать указанный.

Описание:

Метод можно использовать, только когда поле уже отображаетсяна странице.

Например, если форма используется в модальном окне, то метод необходимо использовать только после события open модального окна:

 

dialog.bind('open', function() {
form.setValue(.....)
...
})

 

Возвращаемое значение:

Объект типа FormBuilder.

Свернуть/развернуть Public method getDisplayValue – Получить отображаемое значение поля

Синтаксис:

 

getDisplayValue(name)

Параметры:

Имя

Тип

Описание

name

string

Имя поля

Возвращаемое значение:

Отображаемое значение поля.

Свернуть/развернуть Public method getHeight – Получить высоту формы

Синтаксис:

 

getHeight()

Описание:

Устаревший метод, оставлен для совместимости с предыдущими версиями. Не рекомендуется его использовать.

Возвращаемое значение:

Высота формы.

Свернуть/развернуть Public method getHeigth – Получить высоту формы

Синтаксис:

 

getHeigth()

Свернуть/развернуть Public method addText – Добавить текст на форму

Синтаксис:

 

addText(name)

Параметры:

Имя

Тип

Описание

name

string

Строка локализации равная идентификатору этого поля

Возвращаемое значение:

Oбъект класса FormBuilder.

Свернуть/развернуть Public method addText – Добавить текст на форму

Синтаксис:

 

addText(name)

Параметры:

Имя

Тип

Описание

name

string

Строка локализации равная идентификатору этого поля

Возвращаемое значение:

Oбъект класса FormBuilder.

Свернуть/развернуть Public method addInput – Добавить поле типа «Текст»

Синтаксис:

 

addInput(name, opt_maxlength, opt_validateRules)

Параметры:

Имя

Тип

Описание

name

string

Строка локализации равная идентификатору этого поля

opt_maxlength

number

Допустимое количество символов в поле

opt_validateRules

WebAccess.components.forms.FormBuilder.validatorRules

Правила корректности заполнения формы

Возвращаемое значение:

Oбъект класса FormBuilder.

Свернуть/развернуть Public method addFileField – Добавить поле типа «File»

Синтаксис:

 

addFileField(name, opt_validateRules)

Параметры:

Имя

Тип

Описание

name

string

Строка локализации равная идентификатору поля

opt_validateRules

WebAccess.components.forms.FormBuilder.validatorRules

Правила корректности заполнения формы

Возвращаемое значение:

Oбъект класса FormBuilder.

Свернуть/развернуть Public method addHiddenField – Добавить скрытое поле

Синтаксис:

 

addHiddenField(name, value)

Параметры:

Имя

Тип

Описание

name

string

Строка локализации равная идентификатору поля

value

string

Значение поля

Возвращаемое значение:

Oбъект класса FormBuilder.

Свернуть/развернуть Public method addDate – Добавить поле для выбора даты

Синтаксис:

 

addDate(name, opt_validateRules)

Параметры:

Имя

Тип

Описание

name

string

Строка локализации равная идентификатору поля

opt_validateRules

WebAccess.components.forms.FormBuilder.validatorRules

Правила корректности заполнения формы

Возвращаемое значение:

Oбъект класса FormBuilder.

Свернуть/развернуть Public method addTextarea – Добавить многострочное поле

Синтаксис:

 

addTextarea(name, opt_defaultvalue, opt_validateRules)

Параметры:

Имя

Тип

Описание

name

string

Строка локализации равная идентификатору этого поля

opt_defaultvalue

string

Значение по умолчанию

opt_validateRules

WebAccess.components.forms.FormBuilder.validatorRules

Правила корректности заполнения формы

Возвращаемое значение:

Oбъект класса FormBuilder.

Свернуть/развернуть Public method addTextFrame – Добавить многострочное поле фиксированной высоты

Синтаксис:

 

addTextFrame(name, defaultvalue, opt_maxHeigth, opt_validateRules)

Параметры:

Имя

Тип

Описание

name

string

Строка локализации равная идентификатору поля

defaultvalue

string

Значение по умолчанию

opt_maxHeigth

integer

Высота, в рамках которой ограничивается поле

opt_validateRules

WebAccess.components.forms.FormBuilder.validatorRules

Правила коррктности заполнения формы

Возвращаемое значение:

Объект класса FormBuilder.

Свернуть/развернуть Public method addTextarea – Добавить многострочное поле

Синтаксис:

 

addTextarea()

Свернуть/развернуть Public method addSelect – Добавить поле выбора из списка

Синтаксис:

 

addSelect(name, options, opt_validateRules)

Параметры:

Имя

Тип

Описание

name

string

Строка локализации равная идентификатору этого поля

options

dictionary

Список элементов выбора

opt_validateRules

WebAccess.components.forms.FormBuilder.validatorRules

Правила корректности заполнения формы

Возвращаемое значение:

Oбъект класса FormBuilder.

Свернуть/развернуть Public method addRadioButtons – Добавить группу переключателей

Синтаксис:

 

addRadioButtons(name, options, opt_validateRules)

Параметры:

Имя

Тип

Описание

name

string

Строка локализации, равная идентификатору этого поля

options

dictionary

Список элементов выбора

opt_validateRules

WebAccess.components.forms.FormBuilder.validatorRules

Правила корректности заполнения формы

Возвращаемое значение:

Oбъект класса FormBuilder.

Свернуть/развернуть Public method addReferenceSelect – Добавить поле типа «Справочник»

Синтаксис:

 

addReferenceSelect(name, referenceCode, opt_toolTip, opt_searchReqName, opt_filter, opt_validateRules)

Параметры:

Имя

Тип

Описание

name

string

Строка локализации равная идентификатору этого поля

referenceCode

string

Код справочника

opt_toolTip

string

Текст всплывающей подсказки для кнопки выбора из справочника

opt_searchReqName

string

Отображаемый реквизит. По умолчанию реквизит «Наименование»

opt_filter

string

Выражение фильтрации. Для выбора будут доступны только отфильтрованные записи указанного справочника

opt_validateRules

WebAccess.components.forms.FormBuilder.validatorRules

Правила корректности заполнения формы

Возвращаемое значение:

Oбъект класса FormBuilder.

Свернуть/развернуть Public method addObjectList – Добавить поле типа «Список объектов»

Синтаксис:

 

addObjectList(name, type, opt_liks, opt_isList, referenceCode, opt_validateRules)

Параметры:

Имя

Тип

Описание

name

string

Строка локализации равная идентификатору этого поля.

type

string

Возможные значения: EDOCUMENT, JOB, FOLDER, TASK, REFERENCE_RECORD, ANY

opt_liks

WebAccess.components.forms.FormBuilder.objectLink

Ссылки объектов по умолчанию. Подробнее см. WebAccess.components.forms.FormBuilder.objectLink

opt_isList

boolean

Значение True, если можно вставить несколько объектов в поле, иначе False

referenceCode

string

Код справочника.

opt_validateRules

WebAccess.components.forms.FormBuilder.validatorRules

Правила корректности заполнения формы

Возвращаемое значение:

Oбъект класса FormBuilder.

 

Свернуть/развернуть пример Пример

var form = new WA.CMP.forms.FormBuilder("1")
form.addObjectList("YEsdscSd", OBJECT_TYPE.REFERENCE_RECORD,[{"id": "103619", "type": OBJECT_TYPE.REFERENCE_RECORD, "referenceCode": "ПРС"}], true,'ПРС')

 

var dialog = new WA.CMP.dialogs.BaseDialog("as")
dialog.setHtml(form.render())
dialog.width = 700
dialog.show()

Свернуть/развернуть Public method addMultiSelect – Добавить поле множественного выбора из справочника

Синтаксис:

 

addMultiSelect(name, referenceNames, opt_toolTip, opt_searchReqName, opt_filter, opt_isMultiSelect, opt_validateRules)

Параметры:

Имя

Тип

Описание

name

string

Строка локализации равная идентификатору этого поля

referenceNames

string

Коды справочников, разделенные ";"

opt_toolTip

string

Текст всплывающей подсказки

opt_searchReqName

string

Отображаемый реквизит

opt_filter

string

Выражение фильрации. В поле будут доступны только отфильтрованные записи выбранного справочника

opt_isMultiSelect

boolean

Признак множественного выбора

opt_validateRules

WebAccess.components.forms.FormBuilder.validatorRules

Правила корректности заполнения формы

Возвращаемое значение:

Oбъект класса FormBuilder.

Свернуть/развернуть Public method addPick – Добавить поле типа «Признак»

Синтаксис:

 

addPick(name, values, opt_displayValues, opt_disabledValues, opt_editable, opt_validateRules)

Параметры:

Имя

Тип

Описание

name

string

Строка локализации равная идентификатору этого поля

values

dict

Ассоциативный массив, содержащий пары: ИД пункта выпадающего списка – отображаемое значение пункта

opt_displayValues

dict

Отображаемые значения для выпадающего списка

opt_disabledValues

array

Пункты недоступные для выбора

opt_editable

boolean

Если значение true, то поле ввода становится доступным для изменения. В случае, если значение было введено вручную, метод getValue вернет пустую строку. Такое значение необходимо получать методом getDisplayValue

opt_validateRules

WebAccess.components.forms.FormBuilder.validatorRules

Правила корректности заполнения формы

Возвращаемое значение:

Текущий конструктор форм.

Свернуть/развернуть Public method addCustomField – Добавить поле с произвольным содержимым

Синтаксис:

 

addCustomField(name, html, opt_validateRules)

Параметры:

Имя

Тип

Описание

name

string

Строка локализации равная идентификатору этого поля

html

string

HTML-разметка. Должна содержать указанный параметр name

opt_validateRules

WebAccess.components.forms.FormBuilder.validatorRules

Правила корректности заполнения формы

Возвращаемое значение:

Oбъект класса FormBuilder.

Свернуть/развернуть Public method addCheckbox – Добавить переключатель

Синтаксис:

 

addCheckbox(name, opt_isChecked, opt_validateRules)

Параметры:

Имя

Тип

Описание

name

string

Строка локализации равная идентификатору этого поля

opt_isChecked

bool

Проверяет, установлен переключатель или нет

opt_validateRules

WebAccess.components.forms.FormBuilder.validatorRules

Правила корректности заполнения формы

Возвращаемое значение:

Oбъект класса FormBuilder.

Свернуть/развернуть Public method addValidationRule – Добавить правила корректности ввода данных

Синтаксис:

 

addValidationRule(name, handler, opt_error_message)

Параметры:

Имя

Тип

Описание

name

string

Название правила

handler

function

Функция проверки правила

opt_error_message

string

Сообщение об ошибке, возникающей при невыполнении правила

Свернуть/развернуть пример Пример

// К правилам корректности ввода данных добавляется новое «MoreThanTen».
// Правило означает, что форма заполнена правильно, если значение поля больше 10.
var form = new WA.CMP.forms.FormBuilder('buldy');
form.addValidationRule('moreThanTen', function(value, display) {
console.log(arguments);
if (value < 10) return false;
return true;
}, L('ERROR'));
 
var dialog = new WA.CMP.dialogs.BaseDialog();
 
//Применяем правило к полю «YES».
form.addInput("YES", 100, {'isRequired': true, 'moreThanTen': true});
dialog.setHtml(form.render());
dialog.show();
dialog.ok = function() {
if (form.isValid() !== true) return false;
 
}

Свернуть/развернуть Public method isValid – Проверить корректность значений

Синтаксис:

 

isValid()

Возвращаемое значение:

True, если значения полей формы корректны, иначе False.

Свернуть/развернуть Public method setAction – Установить адрес для отправки формы

Синтаксис:

 

setAction(url)

Параметры:

Имя

Тип

Описание

url

string

Адрес для отправки формы

Возвращаемое значение:

Текущий конструктор форм.

Свернуть/развернуть Public method setMethod – Метод для отправки формы

Синтаксис:

 

setMethod(form_method)

Параметры:

Имя

Тип

Описание

form_method

FORM_METHOD

Метод для отправки формы

Возвращаемое значение:

Текущий конструктор форм.

Свернуть/развернуть Методы часть 2

Свернуть/развернуть Public method setEnctype – Установить тип содержимого формы

Синтаксис:

 

setEnctype(enctype)

Параметры:

Имя

Тип

Описание

enctype

ENCTYPE

Тип содержимого формы

Возвращаемое значение:

Текущий конструктор форм.

Свернуть/развернуть Public method submit – Отправить форму

Синтаксис:

 

submit()

Возвращаемое значение:

Текущий конструктор форм.

Свернуть/развернуть Public method render – Гененерировать форму

Синтаксис:

 

render()

Возвращаемое значение:

Сгенерированная HTML-разметка.

Свернуть/развернуть Public method renderAsync – Генерировать форму с помощью асинхронного вызова

Синтаксис:

 

renderAsync()

Возвращаемое значение:

Специальный deferred-объект.

Свернуть/развернуть Public method clean – Очистить форму

Синтаксис:

 

clean()

Возвращаемое значение:

Oбъект класса FormBuilder.

Свернуть/развернуть Public method serialize – Сериализация формы

Синтаксис:

 

serialize()

Возвращаемое значение:

Сериализация формы

Свернуть/развернуть Public method deserialize – Десериализация формы

Синтаксис:

 

deserialize()

Возвращаемое значение:

Десериализация формы

Свернуть/развернуть Public method bind – Привязать функцию к событию

Унаследован от BaseObject

Синтаксис:

 

bind(name, callback, opt_context)

Параметры:

Имя

Тип

Описание

name

string

Имя события

callback

function

Функция, срабатывающая при событии

opt_context

object

Контекст исполнения

Возвращаемое значение:

Объект типа BaseObject.

Свернуть/развернуть Public method unbind – Удалить функцию, привязанную к событию

Унаследован от BaseObject

Синтаксис:

 

unbind(name)

Параметры:

Имя

Тип

Описание

name

string

Имя события

Возвращаемое значение:

Объект типа BaseObject

Свернуть/развернуть Public method fire – Вызвать событие.

Унаследован от BaseObject

Синтаксис:

 

fire(Имя)

Параметры:

Имя

Тип

Описание

Имя

string

события

Возвращаемое значение:

Метод вернет False, если хотя бы один из обработчиков метода bind вернул False. При этом условии другие обработчики событий вызваны не будут.

Свернуть/развернуть fireAll – Последовательно вызвать события BeforeEvent, Event, AfterEvent

Унаследован от BaseObject

Синтаксис:

 

fireAll(eventName, mainFunc)

Параметры:

Имя

Тип

Описание

eventName

string

Имя события, переданное методу

mainFunc

string

Функция, срабатывающая при событии

Свернуть/развернуть Public method asString – Получить строковое представление объекта.

Унаследован от BaseObject

Синтаксис:

 

asString()

Возвращаемое значение:

Строковое представление объекта.

Свернуть/развернуть Типы данных

Свернуть/развернуть Public method validatorRules – Правила корректности заполнения формы

Свойства:

Имя

Тип

Описание

isRequired

boolean

Признак обязательного поля

isDate

boolean

Признак того, что поле имеет тип «Дата»: 01/01/2000, 01.01.2000, а не 01/01.2000 или «фдлврф»

isDigit

boolean

Признак того, что поле имеет тип «Число»

min

boolean

Допустимое минимальное числовое значение

max

boolean

Допустимое максимальное числовое значение

isEmail

boolean

Значение поля – адрес электронной почты

Свернуть/развернуть пример Пример

form.addCustomField("TO_ARCHIVE_DATE", toArchiveDateHtml, { "isRequired": true, "isDate": true });

Свернуть/развернуть Public method objectLink – Ссылка на объект

Свойства:

Имя

Тип

Описание

id

integer

ИД объекта

type

OBJECT_TYPE

Тип объекта

referenceCode

boolean

Код справочника

Свернуть/развернуть Public method validatorRules – Правила корректности заполнения формы

Свойства:

Имя

Тип

Описание

isRequired

boolean

Признак обязательного поля

isDate

boolean

Признак того, что поле имеет тип «Дата»: 01/01/2000, 01.01.2000, а не 01/01.2000 или «фдлврф»

isDigit

boolean

Признак того, что поле имеет тип «Число»

min

boolean

Допустимое минимальное числовое значение

max

boolean

Допустимое максимальное числовое значение

isEmail

boolean

Значение поля – адрес электронной почты

Свернуть/развернуть пример Пример

form.addCustomField("TO_ARCHIVE_DATE", toArchiveDateHtml, { "isRequired": true, "isDate": true });

Свернуть/развернуть Public method objectLink – Ссылка на объект

Свойства:

Имя

Тип

Описание

id

integer

ИД объекта

type

OBJECT_TYPE

Тип объекта

referenceCode

boolean

Код справочника

См. также

 

© 2016 Компания DIRECTUM Сообщество пользователей DIRECTUM