Module is.codion.swing.common.ui

Package is.codion.swing.common.ui.component.combobox

Class Completion

java.lang.Object

is.codion.swing.common.ui.component.combobox.Completion

public final class Completion
extends Object

Selects an item in a JComboBox based on values typed on the keyboard.

Based on code originally from: http://www.orbital-computer.de/JComboBox
Included with permission.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Completion.Mode	The available completion modes.
static enum	Completion.Normalize	Specifies whether to normalize accented characters in a String.

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<Completion.Mode>	COMBO_BOX_COMPLETION_MODE	Specifies the default completion model used for comboboxes.

Method Summary

Modifier and Type	Method	Description
static <C extends JComboBox<T>, T> C	autoComplete(C comboBox)	Enables auto-completion on the given combobox
static <C extends JComboBox<T>, T> C	autoComplete(C comboBox, Completion.Normalize normalize)	Enables auto-completion on the given combobox
static <C extends JComboBox<T>, T> C	enable(C comboBox)	Enables the default completion mode on the given combo box
static <C extends JComboBox<T>, T> C	enable(C comboBox, Completion.Mode completionMode)	Enables the given completion mode on the given combo box
static <C extends JComboBox<T>, T> C	maximumMatch(C comboBox)	Enables maximum match on the given combobox
static <C extends JComboBox<T>, T> C	maximumMatch(C comboBox, Completion.Normalize normalize)	Enables maximum match on the given combobox

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

COMBO_BOX_COMPLETION_MODE

public static final PropertyValue<Completion.Mode> COMBO_BOX_COMPLETION_MODE

Specifies the default completion model used for comboboxes.

• Completion.Mode.MAXIMUM_MATCH for maximum match,
• Completion.Mode.AUTOCOMPLETE for auto-completion or
• Completion.Mode.NONE for no completion.
• Value type:String
• Default value: Completion.Mode.MAXIMUM_MATCH

Method Details

maximumMatch

public static <C extends JComboBox<T>,
T> C maximumMatch(C comboBox)

Enables maximum match on the given combobox

Type Parameters:

C - the combobox type

T - the type

Parameters:

comboBox - the combobox on which to enable maximum match

Returns:

the combo box

maximumMatch

public static <C extends JComboBox<T>,
T> C maximumMatch(C comboBox,
 Completion.Normalize normalize)

Enables maximum match on the given combobox

Type Parameters:

C - the combobox type

T - the type

Parameters:

comboBox - the combobox on which to enable maximum match

normalize - if YES then accented characters are normalized before matching

Returns:

the combo box

autoComplete

public static <C extends JComboBox<T>,
T> C autoComplete(C comboBox)

Enables auto-completion on the given combobox

Type Parameters:

C - the combobox type

T - the type

Parameters:

comboBox - the combobox on which to enable autocompletion

Returns:

the combo box

autoComplete

public static <C extends JComboBox<T>,
T> C autoComplete(C comboBox,
 Completion.Normalize normalize)

Enables auto-completion on the given combobox

Type Parameters:

C - the combobox type

T - the type

Parameters:

comboBox - the combobox on which to enable autocompletion

normalize - if YES then accented characters are normalized before matching

Returns:

the combo box

enable

public static <C extends JComboBox<T>,
T> C enable(C comboBox)

Enables the default completion mode on the given combo box

Type Parameters:

C - the combo box type

T - the value type

Parameters:

comboBox - the combo box

Returns:

the combo box

See Also:

• COMBO_BOX_COMPLETION_MODE

enable

public static <C extends JComboBox<T>,
T> C enable(C comboBox,
 Completion.Mode completionMode)

Enables the given completion mode on the given combo box

Type Parameters:

C - the combo box type

T - the value type

Parameters:

comboBox - the combo box

completionMode - the mode to enable

Returns:

the combo box

See Also:

• COMBO_BOX_COMPLETION_MODE