Class SelectionInput

SelectionInput

Un campo de entrada que permite elegir entre un conjunto de opciones predefinidas.

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);

Métodos

MétodoTipo de datos que se muestraDescripción breve
addItem(text, value, selected)SelectionInputAgrega un elemento nuevo que se puede seleccionar.
setFieldName(fieldName)SelectionInputConfigura la clave que identifica esta entrada de selección en el objeto de evento que se genera cuando hay una interacción de la IU.
setOnChangeAction(action)SelectionInputConfigura un Action para que se realice cada vez que cambie la entrada de selección.
setTitle(title)SelectionInputEstablece el título que se mostrará antes del campo de entrada.
setType(type)SelectionInputEstablece el tipo de esta entrada.

Documentación detallada

addItem(text, value, selected)

Agrega un elemento nuevo que se puede seleccionar.

Parámetros

NombreTipoDescripción
textObjectEl texto que se mostrará para este elemento. Los argumentos primitivos que no son strings se convierten en strings de forma automática.
valueObjectEl valor de entrada del formulario que se envía a través de la devolución de llamada. Los argumentos primitivos que no son strings se convierten en strings de forma automática.
selectedBooleanIndica si el elemento debe comenzar según lo seleccionado o no.

Volver

SelectionInput: Este objeto, para encadenar.


setFieldName(fieldName)

Configura la clave que identifica esta entrada de selección en el objeto de evento que se genera cuando hay una interacción de la IU. No es visible para el usuario. Obligatorio, debe ser único.

Parámetros

NombreTipoDescripción
fieldNameStringEl nombre que se asignará a esta entrada.

Volver

SelectionInput: Este objeto, para encadenar.


setOnChangeAction(action)

Configura un Action para que se realice cada vez que cambie la entrada de selección.

Parámetros

NombreTipoDescripción
actionActionLa acción por realizar.

Volver

SelectionInput: Este objeto, para encadenar.


setTitle(title)

Establece el título que se mostrará antes del campo de entrada.

Parámetros

NombreTipoDescripción
titleStringEl título del campo de entrada.

Volver

SelectionInput: Este objeto, para encadenar.


setType(type)

Establece el tipo de esta entrada. La configuración predeterminada es CHECKBOX.

Parámetros

NombreTipoDescripción
typeSelectionInputTypeEl tipo de selección.

Volver

SelectionInput: Este objeto, para encadenar.