public class DialogSelectElement extends Object implements DialogElement
Use the select element for multiple choice selections allowing users to pick a
single item from a list. True to web roots, this selection is displayed as a dropdown
menu.
| Modifier and Type | Class and Description |
|---|---|
static class |
DialogSelectElement.DialogSelectElementBuilder |
| Constructor and Description |
|---|
DialogSelectElement() |
DialogSelectElement(String label,
String name,
String value,
String placeholder,
boolean optional,
List<DialogOption> options,
List<DialogOption> selectedOptions,
List<DialogOptionGroup> optionGroups,
Integer minQueryLength,
DialogDataSourceType dataSource) |
| Modifier and Type | Method and Description |
|---|---|
static DialogSelectElement.DialogSelectElementBuilder |
builder() |
protected boolean |
canEqual(Object other) |
boolean |
equals(Object o) |
DialogDataSourceType |
getDataSource()
Provide the data source type for the Element.
|
String |
getLabel()
Label displayed to user.
|
Integer |
getMinQueryLength()
Provide the number of characters that must be typed by a user.
|
String |
getName()
Name of form element.
|
List<DialogOptionGroup> |
getOptionGroups()
Provide up to 100 option group element attributes.
|
List<DialogOption> |
getOptions()
Provide up to 100 option element attributes.
|
String |
getPlaceholder()
A string displayed as needed to help guide users in completing the element.
|
List<DialogOption> |
getSelectedOptions()
Provide a default selected value for dynamic select menus with a data_source of type external.
|
String |
getType()
Type of element.
|
String |
getValue()
A default value for this field.
|
int |
hashCode() |
boolean |
isOptional()
Provide true when the form element is not required.
|
void |
setDataSource(DialogDataSourceType dataSource)
Provide the data source type for the Element.
|
void |
setLabel(String label)
Label displayed to user.
|
void |
setMinQueryLength(Integer minQueryLength)
Provide the number of characters that must be typed by a user.
|
void |
setName(String name)
Name of form element.
|
void |
setOptional(boolean optional)
Provide true when the form element is not required.
|
void |
setOptionGroups(List<DialogOptionGroup> optionGroups)
Provide up to 100 option group element attributes.
|
void |
setOptions(List<DialogOption> options)
Provide up to 100 option element attributes.
|
void |
setPlaceholder(String placeholder)
A string displayed as needed to help guide users in completing the element.
|
void |
setSelectedOptions(List<DialogOption> selectedOptions)
Provide a default selected value for dynamic select menus with a data_source of type external.
|
void |
setValue(String value)
A default value for this field.
|
String |
toString() |
public DialogSelectElement()
public DialogSelectElement(String label, String name, String value, String placeholder, boolean optional, List<DialogOption> options, List<DialogOption> selectedOptions, List<DialogOptionGroup> optionGroups, Integer minQueryLength, DialogDataSourceType dataSource)
public static DialogSelectElement.DialogSelectElementBuilder builder()
public String getLabel()
getLabel in interface DialogElementpublic String getName()
getName in interface DialogElementpublic String getType()
select . It's required.getType in interface DialogElementpublic String getValue()
DialogOptions.getValue in interface DialogElementpublic String getPlaceholder()
getPlaceholder in interface DialogElementpublic boolean isOptional()
isOptional in interface DialogElementpublic List<DialogOption> getOptions()
public List<DialogOption> getSelectedOptions()
public List<DialogOptionGroup> getOptionGroups()
public Integer getMinQueryLength()
public DialogDataSourceType getDataSource()
public void setLabel(String label)
setLabel in interface DialogElementpublic void setName(String name)
setName in interface DialogElementpublic void setValue(String value)
DialogOptions.setValue in interface DialogElementpublic void setPlaceholder(String placeholder)
setPlaceholder in interface DialogElementpublic void setOptional(boolean optional)
setOptional in interface DialogElementpublic void setOptions(List<DialogOption> options)
public void setSelectedOptions(List<DialogOption> selectedOptions)
public void setOptionGroups(List<DialogOptionGroup> optionGroups)
public void setMinQueryLength(Integer minQueryLength)
public void setDataSource(DialogDataSourceType dataSource)
protected boolean canEqual(Object other)
Copyright © 2020. All rights reserved.