Class SelectionInput

ВыборВвод

Поле ввода, которое позволяет выбирать между набором предопределенных опций.

var checkboxGroup = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.CHECK_BOX)
    .setTitle("A group of checkboxes. Multiple selections are allowed.")
    .setFieldName("checkbox_field")
    .addItem("checkbox one title", "checkbox_one_value", false)
    .addItem("checkbox two title", "checkbox_two_value", true)
    .addItem("checkbox three title", "checkbox_three_value", true)
    .setOnChangeAction(CardService.newAction()
        .setFunctionName("handleCheckboxChange"));

var radioGroup = CardService.newSelectionInput()
    .setType(CardService.SelectionInputType.RADIO_BUTTON)
    .setTitle("A group of radio buttons. Only a single selection is allowed.")
    .setFieldName("checkbox_field")
    .addItem("radio button one title", "radio_one_value", true)
    .addItem("radio button two title", "radio_two_value", false)
    .addItem("radio button three title", "radio_three_value", false);

Методы

Метод Тип возврата Краткое описание
addItem(text, value, selected) SelectionInput Добавляет новый элемент, который можно выбрать.
setFieldName(fieldName) SelectionInput Задает ключ, который идентифицирует этот ввод выбора в объекте события, который генерируется при взаимодействии с пользовательским интерфейсом.
setOnChangeAction(action) SelectionInput Устанавливает Action , которое будет выполняться при каждом изменении ввода выбора.
setTitle(title) SelectionInput Устанавливает заголовок, который будет отображаться перед полем ввода.
setType(type) SelectionInput Устанавливает тип этого входа.

Подробная документация

addItem(text, value, selected)

Добавляет новый элемент, который можно выбрать.

Параметры

Имя Тип Описание
text Object Текст, который будет отображаться для этого элемента. Нестроковые примитивные аргументы автоматически преобразуются в строки.
value Object Входное значение формы, которое отправляется через обратный вызов. Нестроковые примитивные аргументы автоматически преобразуются в строки.
selected Boolean Должен ли элемент начинаться как выбранный или невыбранный.

Возвращаться

SelectionInput — этот объект для цепочки.

setFieldName(fieldName)

Задает ключ, который идентифицирует этот ввод выбора в объекте события, который генерируется при взаимодействии с пользовательским интерфейсом. Не виден пользователю. Обязательное, должно быть уникальным.

Параметры

Имя Тип Описание
fieldName String Имя для назначения этому входу.

Возвращаться

SelectionInput — этот объект для цепочки.

setOnChangeAction(action)

Устанавливает Action , которое будет выполняться при каждом изменении ввода выбора.

Параметры

Имя Тип Описание
action Action Действие, которое нужно предпринять.

Возвращаться

SelectionInput — этот объект для цепочки.

setTitle(title)

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

Параметры

Имя Тип Описание
title String Заголовок поля ввода.

Возвращаться

SelectionInput — этот объект для цепочки.

setType(type)

Устанавливает тип этого входа. По умолчанию CHECKBOX .

Параметры

Имя Тип Описание
type SelectionInputType Тип выбора.

Возвращаться

SelectionInput — этот объект для цепочки.