ComboBox (Vaadin Platform (vaadin-core) 12.0.0.alpha5 API)

java.lang.Object
- com.vaadin.flow.component.Component
- - com.vaadin.flow.component.AbstractField<C,T>
  - - com.vaadin.flow.component.AbstractSinglePropertyField<R,T>
    - - com.vaadin.flow.component.combobox.GeneratedVaadinComboBox<ComboBox<T>,T>
      - com.vaadin.flow.component.combobox.ComboBox<T>

Type Parameters:

T - the type of the items to be inserted in the combo box

All Implemented Interfaces:

AttachNotifier, BlurNotifier<ComboBox<T>>, DetachNotifier, Focusable<ComboBox<T>>, FocusNotifier<ComboBox<T>>, HasElement, HasEnabled, HasSize, HasStyle, HasValidation, HasValue<AbstractField.ComponentValueChangeEvent<ComboBox<T>,T>,T>, HasValueAndElement<AbstractField.ComponentValueChangeEvent<ComboBox<T>,T>,T>, HasFilterableDataProvider<T,String>, HasItems<T>, Serializable
```
@HtmlImport(value="frontend://flow-component-renderer.html")
 @JavaScript(value="frontend://comboBoxConnector.js")
public class ComboBox<T>
extends GeneratedVaadinComboBox<ComboBox<T>,T>
implements HasSize, HasValidation, HasFilterableDataProvider<T,String>
```
Server-side component for the vaadin-combo-box webcomponent. It contains the same features of the webcomponent, such as item filtering, object selection and item templating.
ComboBox supports lazy loading. This means that when using large data sets, items are requested from the server one "page" at a time when the user scrolls down the overlay. The number of items in one page is by default 50, and can be changed with setPageSize(int).
ComboBox can do filtering either in the browser or in the server. When ComboBox has only a relatively small set of items, the filtering will happen in the browser, allowing smooth user-experience. When the size of the data set is larger than the pageSize, the webcomponent doesn't necessarily have all the data available and it will make requests to the server to handle the filtering. Also, if you have defined custom filtering logic, with eg. setItems(ItemFilter, Collection), filtering will happen in the server. To enable client-side filtering with larger data sets, you can override the pageSize to be bigger than the size of your data set. However, then the full data set will be sent to the client immediately and you will lose the benefits of lazy loading.

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ComboBox.FetchItemsCallback<T>` A callback method for fetching items.
`static interface`	`ComboBox.ItemFilter<T>` Predicate to check `ComboBox` items against user typed strings.

Nested classes/interfaces inherited from class com.vaadin.flow.component.combobox.GeneratedVaadinComboBox
GeneratedVaadinComboBox.CustomValueSetEvent<R extends GeneratedVaadinComboBox<R,?>>, GeneratedVaadinComboBox.FilterChangeEvent<R extends GeneratedVaadinComboBox<R,?>>, GeneratedVaadinComboBox.InvalidChangeEvent<R extends GeneratedVaadinComboBox<R,?>>, GeneratedVaadinComboBox.OpenedChangeEvent<R extends GeneratedVaadinComboBox<R,?>>, GeneratedVaadinComboBox.SelectedItemChangeEvent<R extends GeneratedVaadinComboBox<R,?>>

Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField
AbstractField.ComponentValueChangeEvent<C extends Component,V>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier
BlurNotifier.BlurEvent<C extends Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier
FocusNotifier.FocusEvent<C extends Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue
HasValue.ValueChangeEvent<V>, HasValue.ValueChangeListener<E extends HasValue.ValueChangeEvent<?>>

Constructor Summary

Constructors
Constructor and Description
`ComboBox()` Default constructor.
`ComboBox(int pageSize)` Creates an empty combo box with the defined page size for lazy loading.
`ComboBox(String label)` Creates an empty combo box with the defined label.
`ComboBox(String label, Collection<T> items)` Creates a combo box with the defined label and populated with the items in the collection.
`ComboBox(String label, T... items)` Creates a combo box with the defined label and populated with the items in the array.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Registration`	`addCustomValueSetListener(ComponentEventListener<GeneratedVaadinComboBox.CustomValueSetEvent<ComboBox<T>>> listener)` Adds a listener for CustomValueSetEvent which is fired when user types in a value that don't already exist in the ComboBox.
`DataProvider<T,?>`	`getDataProvider()` Gets the data provider used by this ComboBox.
`T`	`getEmptyValue()` Returns the value that represents an empty value.
`String`	`getErrorMessage()` Gets the current error message from the combobox.
`ItemLabelGenerator<T>`	`getItemLabelGenerator()` Gets the item label generator that is used to produce the strings shown in the combo box for each item.
`String`	`getLabel()` Gets the label of the combobox.
`int`	`getPageSize()` Gets the page size, which is the number of items fetched at a time from the data provider.
`String`	`getPattern()` Gets the valid input pattern
`String`	`getPlaceholder()` Gets the placeholder of the combobox.
`boolean`	`isAllowCustomValue()` If `true`, the user can input a value that is not present in the items list.
`boolean`	`isAutofocus()` Get the state for the auto-focus property of the combobox.
`boolean`	`isInvalid()` Gets the validity of the combobox output.
`boolean`	`isOpened()` Gets the states of the drop-down.
`boolean`	`isPreventInvalidInput()` Determines whether preventing the user from inputing invalid value.
`boolean`	`isRequired()` Determines whether the combobox is marked as input required.
`void`	`setAllowCustomValue(boolean allowCustomValue)` Description copied from corresponding location in WebComponent:
`void`	`setAutofocus(boolean autofocus)` Set the combobox to be input focused when the page loads.
`void`	`setDataProvider(ComboBox.FetchItemsCallback<T> fetchItems, SerializableFunction<String,Integer> sizeCallback)` Sets a CallbackDataProvider using the given fetch items callback and a size callback.
`void`	`setDataProvider(ComboBox.ItemFilter<T> itemFilter, ListDataProvider<T> listDataProvider)` Sets a list data provider with an item filter as the data provider of this combo box.
`<C> void`	`setDataProvider(DataProvider<T,C> dataProvider, SerializableFunction<String,C> filterConverter)` Sets the data provider and filter converter for this listing.
`void`	`setDataProvider(DataProvider<T,String> dataProvider)` Sets the data provider for this listing.
`void`	`setDataProvider(ListDataProvider<T> listDataProvider)` Sets a list data provider as the data provider of this combo box.
`void`	`setErrorMessage(String errorMessage)` Description copied from corresponding location in WebComponent:
`void`	`setInvalid(boolean invalid)` Description copied from corresponding location in WebComponent:
`void`	`setItemLabelGenerator(ItemLabelGenerator<T> itemLabelGenerator)` Sets the item label generator that is used to produce the strings shown in the combo box for each item.
`void`	`setItems(Collection<T> items)` Sets the data items of this component provided as a collection.
`void`	`setItems(ComboBox.ItemFilter<T> itemFilter, Collection<T> items)` Sets the data items of this combo box and a filtering function for defining which items are displayed when user types into the combo box.
`void`	`setItems(ComboBox.ItemFilter<T> itemFilter, T... items)` Sets the data items of this combo box and a filtering function for defining which items are displayed when user types into the combo box.
`void`	`setLabel(String label)` Description copied from corresponding location in WebComponent:
`void`	`setOpened(boolean opened)` Description copied from corresponding location in WebComponent:
`void`	`setPageSize(int pageSize)` Sets the page size, which is the number of items fetched at a time from the data provider.
`void`	`setPattern(String pattern)` Description copied from corresponding location in WebComponent:
`void`	`setPlaceholder(String placeholder)` Description copied from corresponding location in WebComponent:
`void`	`setPreventInvalidInput(boolean preventInvalidInput)` Description copied from corresponding location in WebComponent:
`void`	`setRenderer(Renderer<T> renderer)` Sets the TemplateRenderer responsible to render the individual items in the list of possible choices of the ComboBox.
`void`	`setRequired(boolean required)` Description copied from corresponding location in WebComponent:
`void`	`setValue(T value)` Sets the value of this object.

Methods inherited from class com.vaadin.flow.component.combobox.GeneratedVaadinComboBox
addFilterChangeListener, addInvalidChangeListener, addOpenedChangeListener, addSelectedItemChangeListener, addToPrefix, cancel, checkValidity, clearCache, close, getErrorMessageString, getFilteredItemsJsonArray, getFilterString, getItemIdPathString, getItemLabelPathString, getItemsJsonArray, getItemValuePathString, getLabelString, getNameString, getPageSizeDouble, getPatternString, getPlaceholderString, getSelectedItemJsonObject, getSizeDouble, isAllowCustomValueBoolean, isAutofocusBoolean, isDisabledBoolean, isInvalidBoolean, isLoadingBoolean, isOpenedBoolean, isPreventInvalidInputBoolean, isReadonlyBoolean, isRequiredBoolean, open, remove, removeAll, render, setDisabled, setFilter, setFilteredItems, setItemIdPath, setItemLabelPath, setItems, setItemValuePath, setLoading, setName, setPageSize, setReadonly, setSelectedItem, setSize, validate

Methods inherited from class com.vaadin.flow.component.AbstractSinglePropertyField
hasValidValue, setPresentationValue, setSynchronizedEvent

Methods inherited from class com.vaadin.flow.component.AbstractField
addValueChangeListener, getValue, isEmpty, setModelValue, valueEquals

Methods inherited from class com.vaadin.flow.component.Component
addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getUI, hasListener, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.component.HasSize
getHeight, getWidth, setHeight, setSizeFull, setSizeUndefined, setWidth

Methods inherited from interface com.vaadin.flow.component.HasElement
getElement

Methods inherited from interface com.vaadin.flow.data.binder.HasItems
setItems, setItems

Methods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.component.Focusable
blur, focus, getTabIndex, setTabIndex

Methods inherited from interface com.vaadin.flow.component.BlurNotifier
addBlurListener

Methods inherited from interface com.vaadin.flow.component.FocusNotifier
addFocusListener

Methods inherited from interface com.vaadin.flow.component.HasEnabled
isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasValueAndElement
isReadOnly, isRequiredIndicatorVisible, setReadOnly, setRequiredIndicatorVisible

Methods inherited from interface com.vaadin.flow.component.HasValue
clear, getOptionalValue

Methods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener

- Constructor Detail
  - ComboBox
```
public ComboBox(int pageSize)
```
    Creates an empty combo box with the defined page size for lazy loading.
    The default page size is 50.
    The page size is also the largest number of items that can support client-side filtering. If you provide more items than the page size, the component has to fall back to server-side filtering.
    
    Parameters:
    
    pageSize - the amount of items to request at a time for lazy loading
    
    See Also:
    
    #setPageSize(int)}
  - ComboBox
```
public ComboBox()
```
    Default constructor. Creates an empty combo box.
  - ComboBox
```
public ComboBox(String label)
```
    Creates an empty combo box with the defined label.
    
    Parameters:
    
    label - the label describing the combo box
  - ComboBox
```
public ComboBox(String label,
                Collection<T> items)
```
    Creates a combo box with the defined label and populated with the items in the collection.
    
    Parameters:
    
    label - the label describing the combo box
    
    items - the items to be shown in the list of the combo box
    
    See Also:
    
    setItems(Collection)
  - ComboBox
```
@SafeVarargs
public ComboBox(String label,
                             T... items)
```
    Creates a combo box with the defined label and populated with the items in the array.
    
    Parameters:
    
    label - the label describing the combo box
    
    items - the items to be shown in the list of the combo box
    
    See Also:
    
    HasItems.setItems(Object...)
- Method Detail
  - setValue
```
public void setValue(T value)
```
    Description copied from interface: HasValue
    
    Sets the value of this object. If the new value is not equal to getValue(), fires a value change event. May throw IllegalArgumentException if the value is not acceptable.
    Implementation note: the implementing class should document whether null values are accepted or not, and override HasValue.getEmptyValue() if the empty value is not null.
    
    Specified by:
    
    setValue in interface HasValue<AbstractField.ComponentValueChangeEvent<ComboBox<T>,T>,T>
    
    Overrides:
    
    setValue in class AbstractField<ComboBox<T>,T>
    
    Parameters:
    
    value - the new value
  - setRenderer
```
public void setRenderer(Renderer<T> renderer)
```
    Sets the TemplateRenderer responsible to render the individual items in the list of possible choices of the ComboBox. It doesn't affect how the selected item is rendered - that can be configured by using setItemLabelGenerator(ItemLabelGenerator).
    
    Parameters:
    
    renderer - a renderer for the items in the selection list of the ComboBox, not null
  - setItems
```
public void setItems(Collection<T> items)
```
    Sets the data items of this component provided as a collection.
    The provided collection instance may be used as-is. Subsequent modification of the collection might cause inconsistent data to be shown in the component unless it is explicitly instructed to read the data again.
    Filtering will use a case insensitive match to show all items where the filter text is a substring of the label displayed for that item, which you can configure with setItemLabelGenerator(ItemLabelGenerator).
    Filtering will be handled in the client-side if the size of the data set is less than the page size. To force client-side filtering with a larger data set (at the cost of increased network traffic), you can increase the page size with setPageSize(int).
    
    Specified by:
    
    setItems in interface HasItems<T>
    
    Parameters:
    
    items - the data items to display, not null
  - setItems
```
public void setItems(ComboBox.ItemFilter<T> itemFilter,
                     Collection<T> items)
```
    Sets the data items of this combo box and a filtering function for defining which items are displayed when user types into the combo box.
    Note that defining a custom filter will force the component to make server roundtrips to handle the filtering. Otherwise it can handle filtering in the client-side, if the size of the data set is less than the pageSize.
    
    Parameters:
    
    itemFilter - filter to check if an item is shown when user typed some text into the ComboBox
    
    items - the data items to display
  - setItems
```
public void setItems(ComboBox.ItemFilter<T> itemFilter,
                     T... items)
```
    Sets the data items of this combo box and a filtering function for defining which items are displayed when user types into the combo box.
    Note that defining a custom filter will force the component to make server roundtrips to handle the filtering. Otherwise it can handle filtering in the client-side, if the size of the data set is less than the pageSize.
    
    Parameters:
    
    itemFilter - filter to check if an item is shown when user typed some text into the ComboBox
    
    items - the data items to display
  - setDataProvider
```
public void setDataProvider(DataProvider<T,String> dataProvider)
```
    Sets the data provider for this listing. The data provider is queried for displayed items as needed.
    The filter-type of the given data provider must be String so that it can handle the filters typed into the ComboBox by users. If your data provider uses some other type of filter, you can provide a function which converts the ComboBox's filter-string into that type via setDataProvider(DataProvider, SerializableFunction). Another way to do the same thing is to use this method with your data provider converted with DataProvider.withConvertedFilter(SerializableFunction).
    
    Specified by:
    
    setDataProvider in interface HasFilterableDataProvider<T,String>
    
    Parameters:
    
    dataProvider - the data provider, not null
  - setDataProvider
```
public <C> void setDataProvider(DataProvider<T,C> dataProvider,
                                SerializableFunction<String,C> filterConverter)
```
    Sets the data provider and filter converter for this listing. The data provider is queried for displayed items as needed.
    ComboBox triggers filtering queries based on the strings users type into the field. For this reason you need to provide the second parameter, a function which converts the filter-string typed by the user into filter-type used by your data provider. If your data provider already supports String as the filter-type, it can be used without a converter function via setDataProvider(DataProvider).
    Using this method provides the same result as using a data provider wrapped with DataProvider.withConvertedFilter(SerializableFunction).
    
    Specified by:
    
    setDataProvider in interface HasFilterableDataProvider<T,String>
    
    Type Parameters:
    
    C - the filter type
    
    Parameters:
    
    dataProvider - the data provider, not null
    
    filterConverter - a function that converts filter values produced by this listing into filter values expected by the provided data provider, not null
  - setDataProvider
```
public void setDataProvider(ListDataProvider<T> listDataProvider)
```
    Sets a list data provider as the data provider of this combo box.
    Filtering will use a case insensitive match to show all items where the filter text is a substring of the label displayed for that item, which you can configure with setItemLabelGenerator(ItemLabelGenerator).
    Filtering will be handled in the client-side if the size of the data set is less than the page size. To force client-side filtering with a larger data set (at the cost of increased network traffic), you can increase the page size with setPageSize(int).
    
    Parameters:
    
    listDataProvider - the list data provider to use, not null
  - setDataProvider
```
public void setDataProvider(ComboBox.FetchItemsCallback<T> fetchItems,
                            SerializableFunction<String,Integer> sizeCallback)
```
    Sets a CallbackDataProvider using the given fetch items callback and a size callback.
    This method is a shorthand for making a CallbackDataProvider that handles a partial Query object.
    
    Parameters:
    
    fetchItems - a callback for fetching items
    
    sizeCallback - a callback for getting the count of items
    
    See Also:
    
    CallbackDataProvider, setDataProvider(DataProvider)
  - setDataProvider
```
public void setDataProvider(ComboBox.ItemFilter<T> itemFilter,
                            ListDataProvider<T> listDataProvider)
```
    Sets a list data provider with an item filter as the data provider of this combo box. The item filter is used to compare each item to the filter text entered by the user.
    Note that defining a custom filter will force the component to make server roundtrips to handle the filtering. Otherwise it can handle filtering in the client-side, if the size of the data set is less than the pageSize.
    
    Parameters:
    
    itemFilter - filter to check if an item is shown when user typed some text into the ComboBox
    
    listDataProvider - the list data provider to use, not null
  - getDataProvider
```
public DataProvider<T,?> getDataProvider()
```
    Gets the data provider used by this ComboBox.
    
    Returns:
    
    the data provider used by this ComboBox
  - setItemLabelGenerator
```
public void setItemLabelGenerator(ItemLabelGenerator<T> itemLabelGenerator)
```
    Sets the item label generator that is used to produce the strings shown in the combo box for each item. By default, String.valueOf(Object) is used.
    When the setRenderer(Renderer) is used, the ItemLabelGenerator is only used to show the selected item label.
    
    Parameters:
    
    itemLabelGenerator - the item label provider to use, not null
  - getItemLabelGenerator
```
public ItemLabelGenerator<T> getItemLabelGenerator()
```
    Gets the item label generator that is used to produce the strings shown in the combo box for each item.
    
    Returns:
    
    the item label generator used, not null
  - setPageSize
```
public void setPageSize(int pageSize)
```
    Sets the page size, which is the number of items fetched at a time from the data provider.
    The page size is also the largest number of items that can support client-side filtering. If you provide more items than the page size, the component has to fall back to server-side filtering.
    Setting the page size after the ComboBox has been rendered effectively resets the component, and the current page(s) and sent over again.
    The default page size is 50.
    
    Parameters:
    
    pageSize - the maximum number of items sent per request, should be greater than zero
  - getPageSize
```
public int getPageSize()
```
    Gets the page size, which is the number of items fetched at a time from the data provider.
    The page size is also the largest number of items that can support client-side filtering. If you provide more items than the page size, the component has to fall back to server-side filtering.
    The default page size is 50.
    
    Returns:
    
    the maximum number of items sent per request
    
    See Also:
    
    #setPageSize(int)}
  - setOpened
```
public void setOpened(boolean opened)
```
    Description copied from class: GeneratedVaadinComboBox
    
    Description copied from corresponding location in WebComponent:
    
    True if the dropdown is open, false otherwise.
    
    Overrides:
    
    setOpened in class GeneratedVaadinComboBox<ComboBox<T>,T>
    
    Parameters:
    
    opened - the boolean value to set
  - isOpened
```
public boolean isOpened()
```
    Gets the states of the drop-down.
    
    Returns:
    
    true if the drop-down is opened, false otherwise
  - setInvalid
```
public void setInvalid(boolean invalid)
```
    Description copied from class: GeneratedVaadinComboBox
    
    Description copied from corresponding location in WebComponent:
    
    Set to true if the value is invalid.
    
    Specified by:
    
    setInvalid in interface HasValidation
    
    Overrides:
    
    setInvalid in class GeneratedVaadinComboBox<ComboBox<T>,T>
    
    Parameters:
    
    invalid - the boolean value to set
  - isInvalid
```
public boolean isInvalid()
```
    Gets the validity of the combobox output.
    return true, if the value is invalid.
    
    Specified by:
    
    isInvalid in interface HasValidation
    
    Returns:
    
    the validity property from the component
  - setErrorMessage
```
public void setErrorMessage(String errorMessage)
```
    Description copied from class: GeneratedVaadinComboBox
    
    Description copied from corresponding location in WebComponent:
    
    The error message to display when the input is invalid.
    
    Specified by:
    
    setErrorMessage in interface HasValidation
    
    Overrides:
    
    setErrorMessage in class GeneratedVaadinComboBox<ComboBox<T>,T>
    
    Parameters:
    
    errorMessage - the String value to set
  - getErrorMessage
```
public String getErrorMessage()
```
    Gets the current error message from the combobox.
    
    Specified by:
    
    getErrorMessage in interface HasValidation
    
    Returns:
    
    the current error message
  - setAllowCustomValue
```
public void setAllowCustomValue(boolean allowCustomValue)
```
    Description copied from class: GeneratedVaadinComboBox
    
    Description copied from corresponding location in WebComponent:
    
    If true, the user can input a value that is not present in the items list. value property will be set to the input value in this case. Also, when value is set programmatically, the input value will be set to reflect that value.
    
    Overrides:
    
    setAllowCustomValue in class GeneratedVaadinComboBox<ComboBox<T>,T>
    
    Parameters:
    
    allowCustomValue - the boolean value to set
  - isAllowCustomValue
```
public boolean isAllowCustomValue()
```
    If true, the user can input a value that is not present in the items list. value property will be set to the input value in this case. Also, when value is set programmatically, the input value will be set to reflect that value.
    This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.
    
    Returns:
    
    the allowCustomValue property from the combobox
  - setAutofocus
```
public void setAutofocus(boolean autofocus)
```
    Set the combobox to be input focused when the page loads.
    
    Overrides:
    
    setAutofocus in class GeneratedVaadinComboBox<ComboBox<T>,T>
    
    Parameters:
    
    autofocus - the boolean value to set
  - isAutofocus
```
public boolean isAutofocus()
```
    Get the state for the auto-focus property of the combobox.
    This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.
    
    Returns:
    
    the autofocus property from the combobox
  - setPreventInvalidInput
```
public void setPreventInvalidInput(boolean preventInvalidInput)
```
    Description copied from class: GeneratedVaadinComboBox
    
    Description copied from corresponding location in WebComponent:
    
    Set to true to prevent the user from entering invalid input.
    
    Overrides:
    
    setPreventInvalidInput in class GeneratedVaadinComboBox<ComboBox<T>,T>
    
    Parameters:
    
    preventInvalidInput - the boolean value to set
  - isPreventInvalidInput
```
public boolean isPreventInvalidInput()
```
    Determines whether preventing the user from inputing invalid value.
    This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.
    
    Returns:
    
    the preventInvalidInput property of the combobox
  - setRequired
```
public void setRequired(boolean required)
```
    Description copied from class: GeneratedVaadinComboBox
    
    Description copied from corresponding location in WebComponent:
    
    Set to true to mark the input as required.
    
    Overrides:
    
    setRequired in class GeneratedVaadinComboBox<ComboBox<T>,T>
    
    Parameters:
    
    required - the boolean value to set
  - isRequired
```
public boolean isRequired()
```
    Determines whether the combobox is marked as input required.
    This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.
    
    Returns:
    
    true if the input is required, false otherwise
  - setLabel
```
public void setLabel(String label)
```
    Description copied from class: GeneratedVaadinComboBox
    
    Description copied from corresponding location in WebComponent:
    
    The label for this element.
    
    Overrides:
    
    setLabel in class GeneratedVaadinComboBox<ComboBox<T>,T>
    
    Parameters:
    
    label - the String value to set
  - getLabel
```
public String getLabel()
```
    Gets the label of the combobox.
    
    Returns:
    
    the label property of the combobox
  - setPlaceholder
```
public void setPlaceholder(String placeholder)
```
    Description copied from class: GeneratedVaadinComboBox
    
    Description copied from corresponding location in WebComponent:
    
    A placeholder string in addition to the label.
    
    Overrides:
    
    setPlaceholder in class GeneratedVaadinComboBox<ComboBox<T>,T>
    
    Parameters:
    
    placeholder - the String value to set
  - getPlaceholder
```
public String getPlaceholder()
```
    Gets the placeholder of the combobox.
    
    Returns:
    
    the placeholder property of the combobox
  - setPattern
```
public void setPattern(String pattern)
```
    Description copied from class: GeneratedVaadinComboBox
    
    Description copied from corresponding location in WebComponent:
    
    A pattern to validate the input with.
    
    Overrides:
    
    setPattern in class GeneratedVaadinComboBox<ComboBox<T>,T>
    
    Parameters:
    
    pattern - the String value to set
  - getPattern
```
public String getPattern()
```
    Gets the valid input pattern
    
    Returns:
    
    the pattern property of the combobox
  - getEmptyValue
```
public T getEmptyValue()
```
    Description copied from interface: HasValue
    
    Returns the value that represents an empty value.
    By default HasValue is expected to support null as empty values. Specific implementations might not support this.
    
    Specified by:
    
    getEmptyValue in interface HasValue<AbstractField.ComponentValueChangeEvent<ComboBox<T>,T>,T>
    
    Overrides:
    
    getEmptyValue in class AbstractField<ComboBox<T>,T>
    
    Returns:
    
    empty value
  - addCustomValueSetListener
```
public Registration addCustomValueSetListener(ComponentEventListener<GeneratedVaadinComboBox.CustomValueSetEvent<ComboBox<T>>> listener)
```
    Adds a listener for CustomValueSetEvent which is fired when user types in a value that don't already exist in the ComboBox.
    As a side effect makes the ComboBox allow custom values. If you don't want to allow a user to add new values to the list once the listener is added please disable it explicitly via the setAllowCustomValue(boolean) method.
    
    The custom value becomes disallowed automatically once the last custom value set listener is removed.
    
    Overrides:
    
    addCustomValueSetListener in class GeneratedVaadinComboBox<ComboBox<T>,T>
    
    Parameters:
    
    listener - the listener to be notified when a new value is filled
    
    Returns:
    
    a Registration for removing the event listener
    
    See Also:
    
    setAllowCustomValue(boolean)

Class ComboBox<T>

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.combobox.GeneratedVaadinComboBox

Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField

Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue

Constructor Summary

Method Summary

Methods inherited from class com.vaadin.flow.component.combobox.GeneratedVaadinComboBox

Methods inherited from class com.vaadin.flow.component.AbstractSinglePropertyField

Methods inherited from class com.vaadin.flow.component.AbstractField

Methods inherited from class com.vaadin.flow.component.Component

Methods inherited from class java.lang.Object

Methods inherited from interface com.vaadin.flow.component.HasSize

Methods inherited from interface com.vaadin.flow.component.HasElement

Methods inherited from interface com.vaadin.flow.data.binder.HasItems

Methods inherited from interface com.vaadin.flow.component.HasStyle

Methods inherited from interface com.vaadin.flow.component.Focusable

Methods inherited from interface com.vaadin.flow.component.BlurNotifier

Methods inherited from interface com.vaadin.flow.component.FocusNotifier

Methods inherited from interface com.vaadin.flow.component.HasEnabled

Methods inherited from interface com.vaadin.flow.component.HasValueAndElement

Methods inherited from interface com.vaadin.flow.component.HasValue

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

Constructor Detail

ComboBox

ComboBox

ComboBox

ComboBox

ComboBox

Method Detail

setValue

setRenderer

setItems

setItems

setItems

setDataProvider

setDataProvider

setDataProvider

setDataProvider

setDataProvider

getDataProvider

setItemLabelGenerator

getItemLabelGenerator

setPageSize

getPageSize

setOpened

isOpened

setInvalid

isInvalid

setErrorMessage

getErrorMessage

setAllowCustomValue

isAllowCustomValue

setAutofocus

isAutofocus

setPreventInvalidInput

isPreventInvalidInput

setRequired

isRequired

setLabel

getLabel

setPlaceholder

getPlaceholder

setPattern

getPattern

getEmptyValue

addCustomValueSetListener