Ein Eingabefeld, über das Sie zwischen einer Reihe vordefinierter Optionen wählen können.
Um eine Enum aufzurufen, rufen Sie ihre übergeordnete Klasse, ihren Namen und ihre Eigenschaft auf. Beispiel:
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);
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addItem(text, value, selected) | SelectionInput | Fügt ein neues Element hinzu, das ausgewählt werden kann. |
setFieldName(fieldName) | SelectionInput | Legt den Schlüssel fest, der diese Auswahl im Ereignisobjekt identifiziert, das bei einer UI-Interaktion generiert wird. |
setOnChangeAction(action) | SelectionInput | Legt einen Action fest, der ausgeführt werden soll, wenn sich die Auswahleingabe ändert. |
setTitle(title) | SelectionInput | Legt den Titel fest, der vor dem Eingabefeld angezeigt werden soll. |
setType(type) | SelectionInput | Legt den Typ dieser Eingabe fest. |
Detaillierte Dokumentation
addItem(text, value, selected)
Fügt ein neues Element hinzu, das ausgewählt werden kann.
Parameter
Name | Typ | Beschreibung |
---|---|---|
text | Object | Der Text, der für dieses Element angezeigt werden soll. Einfache Argumente, die keine Strings sind, werden automatisch in Strings umgewandelt. |
value | Object | Der Eingabewert des Formulars, der über den Callback gesendet wird. Einfache Argumente, die keine Strings sind, werden automatisch in Strings umgewandelt. |
selected | Boolean | Gibt an, ob das Element standardmäßig ausgewählt ist. Wenn für die Auswahl nur ein Wert akzeptiert wird (z. B. für Optionsfelder oder ein Drop-down-Menü), legen Sie dieses Feld nur für ein Element fest. |
Return
SelectionInput
: Dieses Objekt für Verkettungen.
setFieldName(fieldName)
Legt den Schlüssel fest, der diese Auswahl im Ereignisobjekt identifiziert, das bei einer UI-Interaktion generiert wird. Für den Nutzer nicht sichtbar. Erforderlich, muss eindeutig sein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
fieldName | String | Der Name, der diesem Eingang zugewiesen werden soll. |
Return
SelectionInput
: Dieses Objekt für Verkettungen.
setOnChangeAction(action)
Legt einen Action
fest, der ausgeführt werden soll, wenn sich die Auswahleingabe ändert.
Parameter
Name | Typ | Beschreibung |
---|---|---|
action | Action | Die erforderliche Aktion. |
Return
SelectionInput
: Dieses Objekt für Verkettungen.
setTitle(title)
Legt den Titel fest, der vor dem Eingabefeld angezeigt werden soll.
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | Der Titel des Eingabefelds. |
Return
SelectionInput
: Dieses Objekt für Verkettungen.
setType(type)
Legt den Typ dieser Eingabe fest. Die Standardeinstellung ist CHECKBOX
.
Parameter
Name | Typ | Beschreibung |
---|---|---|
type | SelectionInputType | Der Auswahltyp. |
Return
SelectionInput
: Dieses Objekt für Verkettungen.