AbstractComboBoxBrowser (TrueZIP Swing 7.7.10 API)

java.lang.Object
- de.schlichtherle.truezip.swing.AbstractComboBoxBrowser<E>

Type Parameters:
E - the type of the elements of this combo box browser.

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FileComboBoxBrowser
```
@NotThreadSafe
public abstract class AbstractComboBoxBrowser<E>
extends Object
implements Serializable
```
An observer for a 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).

Author:

Christian Schlichtherle

See Also:
Serialized Form

Constructor Summary

Constructors
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.

Method Summary

Methods
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`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractComboBoxBrowser
```
protected AbstractComboBoxBrowser()
```
    Creates a new combo box auto completion browser. setComboBox(javax.swing.JComboBox<E>) must be called in order to use this object.
  - AbstractComboBoxBrowser
```
protected AbstractComboBoxBrowser(@CheckForNull
                       JComboBox<E> comboBox)
```
    Creates a new combo box auto completion browser. Note that this constructor does not call update(java.lang.String) and hence the drop down list of the combo box is left unchanged.
    
    Parameters:
    comboBox - The combo box to enable browsing for auto completions. May be null.
- Method Detail
  - getComboBox
```
@Nullable
public JComboBox<E> getComboBox()
```
    Returns the combo box which this object is auto completing. The default is null.
    
    Returns:
    The combo box which this object is auto completing.
  - setComboBox
```
public void setComboBox(@CheckForNull
               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.
    
    Parameters:
    comboBox - The combo box to enable browsing for auto completions. May be null.
  - update
```
protected abstract boolean update(@CheckForNull
             String initials)
```
    Subclasses are expected to update the auto completion elements in the model of this combo box based on the specified 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.
    
    Parameters:
    initials - The text to auto complete. May be null.
    
    Returns:
    Whether or not the combo box should pop up to show the updated contents of its model.

Class AbstractComboBoxBrowser<E>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractComboBoxBrowser

AbstractComboBoxBrowser

Method Detail

getComboBox

setComboBox

update