Class SelectionInput

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.
Seleção de entrada

Um campo de entrada que permite escolher entre um conjunto de opções 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 retornoBreve descrição
addItem(text, value, selected)SelectionInputAdiciona um novo item que pode ser selecionado.
setFieldName(fieldName)SelectionInputDefine a chave que identifica essa entrada de seleção no objeto de evento que é gerado quando há uma interação com a IU.
setOnChangeAction(action)SelectionInputDefine um Action a ser executado sempre que a entrada de seleção mudar.
setTitle(title)SelectionInputDefine o título a ser exibido antes do campo de entrada.
setType(type)SelectionInputDefine o tipo de entrada.

Documentação detalhada

addItem(text, value, selected)

Adiciona um novo item que pode ser selecionado.

Parâmetros

NomeTipoDescrição
textObjectO texto a ser exibido para este item. Argumentos primitivos que não são strings são convertidos em strings automaticamente.
valueObjectO valor de entrada do formulário que é enviado pelo callback. Argumentos primitivos que não são strings são convertidos automaticamente em strings.
selectedBooleanIndica se o item deve começar como selecionado ou não selecionado.

Retornar

SelectionInput: este objeto, para encadeamento.


setFieldName(fieldName)

Define a chave que identifica essa entrada de seleção no objeto de evento que é gerado quando há uma interação com a IU. Não visível para o usuário. Obrigatório, deve ser único.

Parâmetros

NomeTipoDescrição
fieldNameStringO nome a ser atribuído a essa entrada.

Retornar

SelectionInput: este objeto, para encadeamento.


setOnChangeAction(action)

Define um Action a ser executado sempre que a entrada de seleção mudar.

Parâmetros

NomeTipoDescrição
actionActionA ação a ser tomada.

Retornar

SelectionInput: este objeto, para encadeamento.


setTitle(title)

Define o título a ser exibido antes do campo de entrada.

Parâmetros

NomeTipoDescrição
titleStringO título do campo de entrada.

Retornar

SelectionInput: este objeto, para encadeamento.


setType(type)

Define o tipo de entrada. O valor padrão é CHECKBOX.

Parâmetros

NomeTipoDescrição
typeSelectionInputTypeO tipo de seleção.

Retornar

SelectionInput: este objeto, para encadeamento.