E
- the type of the elements of this combo box browser.@NotThreadSafe public abstract class AbstractComboBoxBrowser<E> extends Object implements Serializable
JComboBox
which provides auto completion for the
editable text in the drop down list in order to provide quick browsing
capabilities for the user. Subclasses need to implement the update(java.lang.String)
method in order to update the combo box model with the actual auto
completion data.
This class is designed to be minimal intrusive: It's designed to work with
any JComboBox
and doesn't require a special ComboBoxModel
,
although its specific behaviour will only show if the JComboBox
is
editable
and uses a MutableComboBoxModel
(which, besides the
editable
property being set to true
, is the default setup
for a vanilla JComboBox
).
Modifier | Constructor and Description |
---|---|
protected |
AbstractComboBoxBrowser()
Creates a new combo box auto completion browser.
|
protected |
AbstractComboBoxBrowser(JComboBox<E> comboBox)
Creates a new combo box auto completion browser.
|
Modifier and Type | Method and Description |
---|---|
JComboBox<E> |
getComboBox()
Returns the combo box which this object is auto completing.
|
void |
setComboBox(JComboBox<E> comboBox)
Sets the combo box which this object is auto completing and updates the
drop down list with the auto completion for the currently selected item.
|
protected abstract boolean |
update(String initials)
Subclasses are expected to update the auto completion elements in the
model of this combo box based on the specified
initials . |
protected AbstractComboBoxBrowser()
setComboBox(javax.swing.JComboBox<E>)
must be called in order to use this object.protected AbstractComboBoxBrowser(@CheckForNull JComboBox<E> comboBox)
update(java.lang.String)
and hence the drop
down list of the combo box is left unchanged.comboBox
- The combo box to enable browsing for auto completions.
May be null
.@Nullable public JComboBox<E> getComboBox()
null
.public void setComboBox(@CheckForNull JComboBox<E> comboBox)
comboBox
- The combo box to enable browsing for auto completions.
May be null
.protected abstract boolean update(@CheckForNull String initials)
initials
.
They should not do any other work within this method.
In particular, they should not update the visual appearance of this
component.
getComboBox()
is guaranteed to return non-null
if this
method is called from this abstract base class.
initials
- The text to auto complete. May be null
.Copyright © 2005–2018 Schlichtherle IT Services. All rights reserved.