Class Switch

Cambiar

Un elemento de la IU que permite activar o desactivar esta función. Solo puede usarse dentro de un widget DecoratedText.

var switchDecoratedText  = CardService.newDecoratedText()
  .setTopLabel("Switch decorated text widget label")
  .setText("This is a decorated text widget with a switch on the right")
  .setWrapText(true)
  .setSwitchControl(CardService.newSwitch()
      .setFieldName("form_input_switch_key")
      .setValue("form_input_switch_value")
      .setOnChangeAction(CardService.newAction()
          .setFunctionName("handleSwitchChange")));

Métodos

MétodoTipo de datos que se muestraDescripción breve
setControlType(controlType)SwitchEstablece el tipo de control del interruptor.
setFieldName(fieldName)SwitchConfigura la clave que identifica este interruptor en el objeto de evento que se genera cuando se produce una interacción de la IU.
setOnChangeAction(action)SwitchEstablece la acción que se debe realizar cuando se alterna el interruptor.
setSelected(selected)SwitchEstablece si este interruptor debe comenzar según lo seleccionado o no.
setValue(value)SwitchEstablece el valor que se envía como la entrada del formulario cuando se activa este interruptor.

Documentación detallada

setControlType(controlType)

Establece el tipo de control del interruptor. La configuración predeterminada es SWITCH.

Parámetros

NombreTipoDescripción
controlTypeSwitchControlTypeEl tipo de control del interruptor.

Volver

Switch: Este objeto, para encadenar.


setFieldName(fieldName)

Configura la clave que identifica este interruptor en el objeto de evento que se genera cuando se produce una interacción de la IU. No es visible para el usuario. Obligatorio.

A diferencia de otros campos del formulario, este nombre del campo no tiene que ser único. Los valores de entrada de formulario para los interruptores que usan el mismo nombre de campo se muestran como un arreglo. El arreglo consta de los valores de todos los interruptores habilitados con ese nombre de campo.

Parámetros

NombreTipoDescripción
fieldNameStringLa clave que se usa para identificar este interruptor.

Volver

Switch: Este objeto, para encadenar.


setOnChangeAction(action)

Establece la acción que se debe realizar cuando se alterna el interruptor.

Parámetros

NombreTipoDescripción
actionActionLa acción que se debe realizar cuando el interruptor está activado.

Volver

Switch: Este objeto, para encadenar.


setSelected(selected)

Establece si este interruptor debe comenzar según lo seleccionado o no.

Parámetros

NombreTipoDescripción
selectedBooleanLa configuración del estado del interruptor de inicio.

Volver

Switch: Este objeto, para encadenar.


setValue(value)

Establece el valor que se envía como la entrada del formulario cuando se activa este interruptor.

Parámetros

NombreTipoDescripción
valueStringEl valor asociado con el nombre cuando el interruptor está activado. Cuando se envía a la devolución de llamada del formulario, siempre se representa como una string.

Volver

Switch: Este objeto, para encadenar.