Package com.vaadin.flow.component.combobox

Enum Class PartialMatchMode

java.lang.Object

java.lang.Enum<PartialMatchMode>

com.vaadin.flow.component.combobox.PartialMatchMode

All Implemented Interfaces:

Serializable, Comparable<PartialMatchMode>, Constable

public enum PartialMatchMode
extends Enum<PartialMatchMode>

Defines which item in a combo box is automatically set to be selected, for example on Enter, when the typed filter only partially matches its label. The item that will be selected is highlighted in the dropdown while typing.

Since:

25.3

Author:

Vaadin Ltd.

See Also:

• ComboBoxBase.setPartialMatchMode(PartialMatchMode)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FIRST_MATCH	The first item in the filtered results is automatically set to be selected.
NONE	An item is automatically set to be selected only when the filter matches its label exactly.
ONLY_MATCH	The item is automatically set to be selected when filtering narrows the results to a single item.

Method Summary

Modifier and Type	Method	Description
String	getClientName()	Gets the name that is used in the client-side representation of the component.
static PartialMatchMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PartialMatchMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final PartialMatchMode NONE

An item is automatically set to be selected only when the filter matches its label exactly.

FIRST_MATCH

public static final PartialMatchMode FIRST_MATCH

The first item in the filtered results is automatically set to be selected.

ONLY_MATCH

public static final PartialMatchMode ONLY_MATCH

The item is automatically set to be selected when filtering narrows the results to a single item.

Method Details

values

public static PartialMatchMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PartialMatchMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getClientName

public String getClientName()

Gets the name that is used in the client-side representation of the component.

Returns:

the name used in the client-side representation of the component