Class SelectionInput

SelectionInput

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

Para llamar a una enum, debes llamar a su clase superior, nombre y propiedad. Por ejemplo, CardService.SelectionInput.CHECK_BOX.

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)SelectionInputEstablece la clave que identifica esta entrada de selección en el objeto de evento que se genera cuando hay una interacción de IU.
setOnChangeAction(action)SelectionInputEstablece una Action que se realizará 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 de string se convierten automáticamente en strings.
valueObjectEl valor de entrada del formulario que se envía mediante la devolución de llamada. Los argumentos primitivos que no son de string se convierten automáticamente en strings.
selectedBooleanSi el elemento está seleccionado de forma predeterminada Si la entrada de selección solo acepta un valor (como para los botones de selección o un menú desplegable), configura este campo únicamente para un elemento.

Volver

SelectionInput: Este objeto se usa para encadenar.


setFieldName(fieldName)

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

Parámetros

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

Volver

SelectionInput: Este objeto se usa para encadenar.


setOnChangeAction(action)

Establece una Action que se realizará cada vez que cambie la entrada de selección.

Parámetros

NombreTipoDescripción
actionActionLa acción por realizar.

Volver

SelectionInput: Este objeto se usa para encadenar.


setTitle(title)

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

Parámetros

NombreTipoDescripción
titleStringEs el título del campo de entrada.

Volver

SelectionInput: Este objeto se usa para encadenar.


setType(type)

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

Parámetros

NombreTipoDescripción
typeSelectionInputTypeEs el tipo de selección.

Volver

SelectionInput: Este objeto se usa para encadenar.