Method Details

• getItemRenderer

  public ComponentRenderer<? extends Component,T> getItemRenderer()

  Returns the item component renderer.

  Returns:

  the item renderer or null if none set

  See Also:

  • setRenderer(ComponentRenderer)

• setRenderer

  public void setRenderer(ComponentRenderer<? extends Component,T> renderer)

  Sets the item renderer for this select group. The renderer is applied to each item to create a component which represents the item option in the select's drop down.

  Default is null which means that the item's Object.toString() method is used and set as the text content of the vaadin item element.

  Parameters:

  renderer - the item renderer, or null to clear

• setTextRenderer

  public void setTextRenderer(ItemLabelGenerator<T> itemLabelGenerator)

  Convenience setter for creating a TextRenderer from the given function that converts the item to a string.

  NOTE: even though this accepts an ItemLabelGenerator, this is not the same as setItemLabelGenerator(ItemLabelGenerator) which does a different thing.

  Parameters:

  itemLabelGenerator - the function that creates the text content from the item, not null

• setEmptySelectionAllowed

  public void setEmptySelectionAllowed(boolean emptySelectionAllowed)

  Sets whether the user is allowed to select nothing. When set true a special empty item is shown to the user.

  Default is false. The empty selection item can be customized with setEmptySelectionCaption(String).

  Parameters:

  emptySelectionAllowed - true to allow not selecting anything, false to require selection

  See Also:

  • setEmptySelectionCaption(String)

• isEmptySelectionAllowed

  public boolean isEmptySelectionAllowed()

  Returns whether the user is allowed to select nothing.

  Returns:

  true if empty selection is allowed, false otherwise

• setEmptySelectionCaption

  public void setEmptySelectionCaption(String emptySelectionCaption)

  Sets the empty selection caption when setEmptySelectionAllowed(boolean) has been enabled. The caption is shown for the empty selection item in the drop down.

  When the empty selection item is selected, the select shows the value provided by setItemLabelGenerator(ItemLabelGenerator) for the null item, or the string set with setPlaceholder(String) or an empty string if not placeholder is set.

  Default is an empty string "", which will show the place holder when selected.

  Parameters:

  emptySelectionCaption - the empty selection caption to set, not null

  See Also:

  • setEmptySelectionAllowed(boolean)

• getEmptySelectionCaption

  public String getEmptySelectionCaption()

• getItemEnabledProvider

  public SerializablePredicate<T> getItemEnabledProvider()

  Returns the item enabled predicate.

  Returns:

  the item enabled predicate or null if not set

  See Also:

  • setItemEnabledProvider(com.vaadin.flow.function.SerializablePredicate<T>)

• setItemEnabledProvider

  public void setItemEnabledProvider(SerializablePredicate<T> itemEnabledProvider)

  Sets the item enabled predicate for this select. The predicate is applied to each item to determine whether the item should be enabled (true) or disabled (false). Disabled items are displayed as grayed out and the user cannot select them.

  By default is null and all the items are enabled.

  Parameters:

  itemEnabledProvider - the item enable predicate or null to clear

• getItemLabelGenerator

  public ItemLabelGenerator<T> getItemLabelGenerator()

  Gets the item label generator. It generates the text that is shown in the input part for the item when it has been selected.

  Default is null.

  Returns:

  the item label generator, null if not set

• setItemLabelGenerator

  public void setItemLabelGenerator(ItemLabelGenerator<T> itemLabelGenerator)

  Sets the item label generator. It generates the text that is shown in the input part for the item when it has been selected.

  Default is null and the text content generated for the item with setRenderer(ComponentRenderer) is used instead.

  Parameters:

  itemLabelGenerator - the item label generator to set, or null to clear

• getPlaceholder

  public String getPlaceholder()

  Gets the placeholder hint set for the user.

  Returns:

  the placeholder or null if none set

• setPlaceholder

  public void setPlaceholder(String placeholder)

  Sets the placeholder hint for the user.

  The placeholder will be displayed in the case that there is no item selected, or the selected item has an empty string label, or the selected item has no label and it's DOM content is empty.

  Default value is null.

  Parameters:

  placeholder - the placeholder to set, or null to remove

• setLabel

  public void setLabel(String label)

  Sets the string for the label element.

  NOTE: the label must be set for the required indicator to be visible.

  Specified by:

  setLabel in interface HasLabel

  Parameters:

  label - string or null to clear it

• getLabel

  public String getLabel()

  Gets the string for the label element.

  Specified by:

  getLabel in interface HasLabel

  Returns:

  the label string, or null if not set

• setAutofocus

  public void setAutofocus(boolean autofocus)

  Sets the select to have focus when the page loads.

  Default is false.

  Parameters:

  autofocus - the autofocus to set

• isAutofocus

  public boolean isAutofocus()

  Gets whether this select has been set to autofocus when the page loads.

  Returns:

  true if set to autofocus, false if not

• getDataProvider

  public DataProvider<T,?> getDataProvider()

  Gets the data provider.

  Returns:

  the data provider, not null

• setItems

  public SelectDataView<T> setItems(DataProvider<T,Void> dataProvider)

  Description copied from interface: HasDataView

  Set a generic data provider for the component to use and returns the base DataView that provides API to get information on the items.

  This method should be used only when the data provider type is not either ListDataProvider or BackEndDataProvider.

  Specified by:

  setItems in interface HasDataView<T,Void,SelectDataView<T>>

  Parameters:

  dataProvider - DataProvider instance to use, not null

  Returns:

  DataView providing information on the data

• setItems

  public SelectDataView<T> setItems(InMemoryDataProvider<T> inMemoryDataProvider)

  Description copied from interface: HasDataView

  Sets an in-memory data provider for the component to use

  Note! Using a ListDataProvider instead of a InMemoryDataProvider is recommended to get access to ListDataView API by using HasListDataView.setItems(ListDataProvider).

  Specified by:

  setItems in interface HasDataView<T,Void,SelectDataView<T>>

  Parameters:

  inMemoryDataProvider - InMemoryDataProvider to use, not null

  Returns:

  DataView providing information on the data

• setItems

  public SelectListDataView<T> setItems(ListDataProvider<T> dataProvider)

  Description copied from interface: HasListDataView

  Sets a ListDataProvider for the component to use and returns a ListDataView that provides information and allows operations on the items.

  Specified by:

  setItems in interface HasListDataView<T,SelectListDataView<T>>

  Parameters:

  dataProvider - ListDataProvider providing items to the component.

  Returns:

  ListDataView providing access to the items

• getGenericDataView

  public SelectDataView<T> getGenericDataView()

  Gets the generic data view for the Select. This data view should only be used when getListDataView() is not applicable for the underlying data provider.

  Specified by:

  getGenericDataView in interface HasDataView<T,Void,SelectDataView<T>>

  Returns:

  the generic DataView instance implementing Select

• getListDataView

  public SelectListDataView<T> getListDataView()

  Gets the list data view for the Select. This data view should only be used when the items are in-memory and set with:

  • HasListDataView.setItems(Collection)
  • HasListDataView.setItems(Object[])
  • setItems(ListDataProvider)

  If the items are not in-memory, an exception is thrown.

  Specified by:

  getListDataView in interface HasListDataView<T,SelectListDataView<T>>

  Returns:

  the list data view that provides access to the data bound to the Select

• onEnabledStateChanged

  public void onEnabledStateChanged(boolean enabled)

  Description copied from class: Component

  Handle component enable state when the enabled state changes.

  By default this sets or removes the 'disabled' attribute from the element. This can be overridden to have custom handling.

  Overrides:

  onEnabledStateChanged in class Component

  Parameters:

  enabled - the new enabled state of the component

• setRequiredIndicatorVisible

  public void setRequiredIndicatorVisible(boolean requiredIndicatorVisible)

  Sets the required indicator visible or not.

  If set visible, it is visually indicated in the user interface.

  The method is intended to be used with Binder which does server-side validation. In case HTML element has its own (client-side) validation it should be disabled when setRequiredIndicatorVisible(true) is called and re-enabled back on setRequiredIndicatorVisible(false). It's responsibility of each component implementation to follow the contract so that the method call doesn't do anything else than show/hide the "required" indication. Usually components provide their own setRequired method which should be called in case the client-side validation is required. NOTE: The required indicator will not be visible, if the setLabel(String) property is not set for the select.

  Specified by:

  setRequiredIndicatorVisible in interface HasValue<AbstractField.ComponentValueChangeEvent<Select<T>,T>,T>

  Specified by:

  setRequiredIndicatorVisible in interface HasValueAndElement<AbstractField.ComponentValueChangeEvent<Select<T>,T>,T>

  Parameters:

  requiredIndicatorVisible - true to make the required indicator visible, false if not

• isRequiredIndicatorVisible

  public boolean isRequiredIndicatorVisible()

  Checks whether the required indicator is visible. NOTE: The required indicator will not be visible, if the setLabel(String) property is not set for the select.

  Specified by:

  isRequiredIndicatorVisible in interface HasValue<AbstractField.ComponentValueChangeEvent<Select<T>,T>,T>

  Specified by:

  isRequiredIndicatorVisible in interface HasValueAndElement<AbstractField.ComponentValueChangeEvent<Select<T>,T>,T>

  Returns:

  true if visible, false if not

• add

  public void add(Component... components)

  Adds the given components as children of this component.

  In case any of the specified components has already been added to another parent, it will be removed from there and added to this one.

  NOTE: If you add a component with the slot attribute set, it will be placed in the light-dom of the vaadin-select instead of the dropdown.

  Specified by:

  add in interface HasComponents

  Parameters:

  components - the components to add

• addComponents

  public void addComponents(T afterItem, Component... components)

  Description copied from interface: HasItemComponents

  Adds the components after the given item.

  Specified by:

  addComponents in interface HasItemComponents<T>

  Parameters:

  afterItem - item to add components after

  components - components to add after item

• prependComponents

  public void prependComponents(T beforeItem, Component... components)

  Description copied from interface: HasItemComponents

  Adds the components before the given item.

  Specified by:

  prependComponents in interface HasItemComponents<T>

  Parameters:

  beforeItem - item to add components in front of

  components - components to add before item

• addComponentAtIndex

  public void addComponentAtIndex(int index, Component component)

  Adds the given component as child of this component at the specific index.

  In case the specified component has already been added to another parent, it will be removed from there and added to this one.

  NOTE: If you add a component with the slot attribute set, it will be placed in the light-dom of the vaadin-select instead of the dropdown.

  Specified by:

  addComponentAtIndex in interface HasComponents

  Parameters:

  index - the index, where the component will be added. The index must be non-negative and may not exceed the children count

  component - the component to add, value should not be null

• addComponentAsFirst

  public void addComponentAsFirst(Component component)

  Adds the given component as the first child of this component.

  In case the specified component has already been added to another parent, it will be removed from there and added to this one.

  NOTE: If you add a component with the slot attribute set, it will be placed in the light-dom of the vaadin-select instead of the dropdown.

  Specified by:

  addComponentAsFirst in interface HasComponents

  Parameters:

  component - the component to add, value should not be null

• getChildren

  public Stream<Component> getChildren()

  Description copied from class: Component

  Gets the child components of this component.

  The default implementation finds child components by traversing each child Element tree.

  If the component is injected to a PolymerTemplate using the @Id annotation the getChildren method will only return children added from the server side and will not return any children declared in the template file.

  Overrides:

  getChildren in class Component

  Returns:

  the child components of this component

  See Also:

  • Id

• remove

  public void remove(Component... components)

  Removes the given child components from this component.

  NOTE: any component with the slot attribute will be attempted to removed from the light dom of the vaadin-select, instead of inside the options drop down.

  Specified by:

  remove in interface HasComponents

  Parameters:

  components - the components to remove

  Throws:

  IllegalArgumentException - if any of the components is not a child of this component

• removeAll

  public void removeAll()

  Removes all child components that are not items. To remove all items, reset the data provider or use HasListDataView.setItems(Object[]).

  NOTE: this will remove all non-items from the drop down and any slotted components from vaadin-select's light dom.

  Specified by:

  removeAll in interface HasComponents

  See Also:

  • HasComponents.removeAll()

• setOpened

  protected void setOpened(boolean opened)

  Set true to open the dropdown overlay.

  Parameters:

  opened - the boolean value to set

• isOpened

  @Synchronize(property="opened", value="opened-changed") protected boolean isOpened()

  Whether the dropdown is opened or not.

  Returns:

  true if the drop-down is opened, false otherwise

• hasValidValue

  protected boolean hasValidValue()

  Description copied from class: AbstractSinglePropertyField

  Checks whether the element property has a value that can be converted to the model type. Property changes from the element will be ignored if this method returns false. The default implementation always return true.

  Overrides:

  hasValidValue in class AbstractSinglePropertyField<Select<T>,T>

  Returns:

  true if the element property value can be converted to the model type; otherwise false

• onAttach

  protected void onAttach(AttachEvent attachEvent)

  Description copied from class: Component

  Called when the component is attached to a UI.

  The default implementation does nothing.

  This method is invoked before the AttachEvent is fired for the component.

  Overrides:

  onAttach in class Component

  Parameters:

  attachEvent - the attach event

• valueEquals

  protected boolean valueEquals(T value1, T value2)

  Compares two value instances to each other to determine whether they are equal. Equality is used to determine whether to update internal state and fire an event when AbstractField.setValue(Object) or AbstractField.setModelValue(Object, boolean) is called. Subclasses can override this method to define an alternative comparison method instead of Object.equals(Object).

  Overrides:

  valueEquals in class AbstractField<Select<T>,T>

  Parameters:

  value1 - the first instance

  value2 - the second instance

  Returns:

  true if the instances are equal; otherwise false

• validate

  protected void validate()

• addValidationStatusChangeListener

  public Registration addValidationStatusChangeListener(ValidationStatusChangeListener<T> listener)

  Description copied from interface: HasValidator

  Enables the implementing components to notify changes in their validation status to the observers.

  Note: This method can be overridden by the implementing classes e.g. components, to enable the associated Binder.Binding instance subscribing for their validation change events and revalidate itself.

  This method primarily designed for notifying the Binding about the validation status changes of a bound component at the client-side. WebComponents such as <vaadin-date-picker> or any other component that accept a formatted text as input should be able to communicate their invalid status to their server-side instance, and a bound server-side component instance must notify its binding about this validation status change as well. When the binding instance revalidates, a chain of validators and convertors get executed one of which is the default validator provided by HasValidator.getDefaultValidator(). Thus, In order for the binding to be able to show/clear errors for its associated bound field, it is important that implementing components take that validation status into account while implementing any validator and converter including HasValidator.getDefaultValidator(). Here is an example:

   @Tag("date-picker-demo")
   public class DatePickerDemo implements HasValidator<LocalDate> {
  
       // Each web component has a way to communicate its validation status
       // to its server-side component instance. The following clientSideValid
       // state is introduced here just for the sake of simplicity of this code
       // snippet:
       boolean clientSideValid = true;
  
       /**
        * Note how clientSideValid engaged in the definition
        * of this method. It is important to reflect this status either
        * in the returning validation result of this method or any other
        * validation that is associated with this component.
        */
       @Override
       public Validator getDefaultValidator() {
            return (value, valueContext) -> clientSideValid ? ValidationResult.ok()
                   : ValidationResult.error("Invalid date format");
       }
  
       private final Collection<ValidationStatusChangeListener<LocalDate>>
           validationStatusListeners = new ArrayList<>();
  
       /**
        * This enables the binding to subscribe for the validation status
        * change events that are fired by this component and revalidate
        * itself respectively.
        */
       @Override
       public Registration addValidationStatusChangeListener(
               ValidationStatusChangeListener<LocalDate> listener) {
           validationStatusListeners.add(listener);
           return () -> validationStatusListeners.remove(listener);
       }
  
       private void fireValidationStatusChangeEvent(
               boolean newValidationStatus) {
           if (this.clientSideValid != newValidationStatus) {
               this.clientSideValid = newValidationStatus;
               var event = new ValidationStatusChangeEvent<>(this,
                       newValidationStatus);
               validationStatusListeners.forEach(
                       listener -> listener.validationStatusChanged(event));
           }
       }
   }
   

  Specified by:

  addValidationStatusChangeListener in interface HasValidator<T>

  Returns:

  Registration of the added listener.

  See Also:

  • Binder.BindingBuilderImpl.bind(ValueProvider, Setter)

• addOpenedChangeListener

  protected Registration addOpenedChangeListener(ComponentEventListener<Select.OpenedChangeEvent> listener)

  Adds a listener for opened-changed events fired by the webcomponent.

  Parameters:

  listener - the listener

  Returns:

  a Registration for removing the event listener

• addInvalidChangeListener

  protected Registration addInvalidChangeListener(ComponentEventListener<Select.InvalidChangeEvent> listener)

  Adds a listener for invalid-changed events fired by the webcomponent.

  Parameters:

  listener - the listener

  Returns:

  a Registration for removing the event listener