Um campo de entrada que permite escolher entre um conjunto de opções predefinidas.
Para chamar um tipo enumerado, chame a classe, o nome e a propriedade pai dele. Por exemplo,
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étodo | Tipo de retorno | Breve descrição |
---|---|---|
addItem(text, value, selected) | SelectionInput | Adiciona um novo item que pode ser selecionado. |
setFieldName(fieldName) | SelectionInput | Define a chave que identifica essa entrada de seleção no objeto de evento gerado quando há uma interação da interface. |
setOnChangeAction(action) | SelectionInput | Define um Action a ser executado sempre que a entrada de seleção mudar. |
setTitle(title) | SelectionInput | Define o título que será exibido antes do campo de entrada. |
setType(type) | SelectionInput | Define o tipo dessa entrada. |
Documentação detalhada
addItem(text, value, selected)
Adiciona um novo item que pode ser selecionado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
text | Object | O texto a ser mostrado para o item. Os argumentos primitivos que não são strings são convertidos em strings automaticamente. |
value | Object | O valor de entrada do formulário que é enviado pelo callback. Argumentos primitivos não string são convertidos em strings automaticamente. |
selected | Boolean | Indica se o item está selecionado por padrão. Se a entrada de seleção aceitar apenas um valor (como para botões de opção ou um menu suspenso), defina esse campo apenas para um item. |
Retorno
SelectionInput
: esse objeto para encadeamento.
setFieldName(fieldName)
Define a chave que identifica essa entrada de seleção no objeto de evento gerado quando há uma interação da interface. Não está visível para o usuário. Obrigatório, precisa ser exclusivo.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
fieldName | String | O nome a atribuir a essa entrada. |
Retorno
SelectionInput
: esse objeto para encadeamento.
setOnChangeAction(action)
Define um Action
a ser executado sempre que a entrada de seleção mudar.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
action | Action | A ação a ser tomada. |
Retorno
SelectionInput
: esse objeto para encadeamento.
setTitle(title)
Define o título que será exibido antes do campo de entrada.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
title | String | O título do campo de entrada. |
Retorno
SelectionInput
: esse objeto para encadeamento.
setType(type)
Define o tipo dessa entrada. O valor padrão é CHECKBOX
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
type | SelectionInputType | O tipo de seleção. |
Retorno
SelectionInput
: esse objeto para encadeamento.