com.vaadin.flow.component.combobox.ComboBoxDataCommunicator.SelectionPreservingKeyMapper API 23.5.15 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.

com.vaadin.flow.component.combobox.

java.lang.Object
- com.vaadin.flow.data.provider.KeyMapper<TItem>
- - com.vaadin.flow.component.combobox.ComboBoxDataCommunicator.SelectionPreservingKeyMapper<TItem>

Type Parameters:

TItem - The type of the item selectable in the combo box

All Implemented Interfaces:

DataKeyMapper<TItem>, Serializable

Enclosing class:

ComboBoxDataCommunicator<TItem>
```
protected static class ComboBoxDataCommunicator.SelectionPreservingKeyMapper<TItem>
extends KeyMapper<TItem>
```
Customized key mapper that does not remove key for an item as long as it is selected.

See Also:

Serialized Form

- Constructor Summary
  
  Constructors
  Constructor Description
  
  SelectionPreservingKeyMapper(ComboBoxBase<?,TItem,?> comboBox)
- Method Summary
  
  All Methods
  Modifier and Type Method Description
  
  String key(TItem item)
  Gets key for an object.
  
  void purgeItems()
  
  void remove(TItem item)
  Removes object from the mapper.
  - Methods inherited from class com.vaadin.flow.data.provider.KeyMapper
    containsKey, createKey, get, has, refresh, removeAll, setIdentifierGetter
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SelectionPreservingKeyMapper
```
public SelectionPreservingKeyMapper(ComboBoxBase<?,TItem,?> comboBox)
```
- Method Detail
  - remove
```
public void remove(TItem item)
```
    Description copied from class: KeyMapper
    
    Removes object from the mapper.
    
    Specified by:
    
    remove in interface DataKeyMapper<TItem>
    
    Overrides:
    
    remove in class KeyMapper<TItem>
    
    Parameters:
    
    item - the object to be removed.
  - key
```
public String key(TItem item)
```
    Description copied from class: KeyMapper
    
    Gets key for an object.
    
    Specified by:
    
    key in interface DataKeyMapper<TItem>
    
    Overrides:
    
    key in class KeyMapper<TItem>
    
    Parameters:
    
    item - the object.
    
    Returns:
    
    key for given data object
  - purgeItems
```
public void purgeItems()
```