AbstractComboBoxBrowser (TrueZIP Swing 7.2-beta-1 API)

java.lang.Object
- de.schlichtherle.truezip.swing.AbstractComboBoxBrowser

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FileComboBoxBrowser
```
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
public abstract class AbstractComboBoxBrowser
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 works with any subclass of JComboBox and doesn't require a special ComboBoxModel, although its specific behaviour will only show if the JComboBox is editable and uses an instance of a MutableComboBoxModel (which, besides the editable property being set to true, is the default for a plain JComboBox).

Author:

Christian Schlichtherle

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`AbstractComboBoxBrowser.DecoratingComboBoxEditor` This proxy controls access to the real `ComboBoxEditor` installed by the client application or the pluggable look and feel.
`private class`	`AbstractComboBoxBrowser.Listener`

Field Summary

Fields
Modifier and Type	Field and Description
`private JComboBox`	`comboBox`
`private AbstractComboBoxBrowser.Listener`	`listener`
`private boolean`	`recursion` Used to inhibit mutual recursive event firing.
`private static long`	`serialVersionUID`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractComboBoxBrowser()` Creates a new combo box auto completion browser.
`protected`	`AbstractComboBoxBrowser(JComboBox comboBox)` Creates a new combo box auto completion browser.

Method Summary

Methods
Modifier and Type	Method and Description
`private void`	`changeComboBox(JComboBox oldCB, JComboBox newCB, boolean update)`
`private void`	`changeDocument(Document oldDoc, Document newDoc, boolean update)`
`private void`	`changeEditor(ComboBoxEditor oldCBE, ComboBoxEditor newCBE, boolean update)`
`private void`	`changeText(JTextComponent oldTC, JTextComponent newTC, boolean update)`
`private void`	`documentUpdated()`
`JComboBox`	`getComboBox()` Returns the combo box which this object is auto completing.
`private boolean`	`lock()` Locks out mutual recursive event notification.
`void`	`setComboBox(JComboBox 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.
`private void`	`unlock()` Unlocks mutual recursive event notification.
`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`.
`private void`	`updateEditor(ComboBoxEditor cbe, Object item)`

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

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    Constant Field Values
  - listener
```
private final AbstractComboBoxBrowser.Listener listener
```
  - comboBox
```
@CheckForNull
private JComboBox comboBox
```
  - recursion
```
private transient boolean recursion
```
    Used to inhibit mutual recursive event firing.
- Constructor Detail
  - AbstractComboBoxBrowser
```
protected AbstractComboBoxBrowser()
```
    Creates a new combo box auto completion browser. setComboBox(javax.swing.JComboBox) must be called in order to use this object.
  - AbstractComboBoxBrowser
```
protected AbstractComboBoxBrowser(@CheckForNull
                       JComboBox 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 getComboBox()
```
    Returns the combo box which this object is auto completing. The default is null.
  - setComboBox
```
public void setComboBox(@CheckForNull
               JComboBox 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.
  - changeComboBox
```
private void changeComboBox(@CheckForNull
                  JComboBox oldCB,
                  @CheckForNull
                  JComboBox newCB,
                  boolean update)
```
  - changeEditor
```
private void changeEditor(@CheckForNull
                ComboBoxEditor oldCBE,
                @CheckForNull
                ComboBoxEditor newCBE,
                boolean update)
```
  - changeText
```
private void changeText(@CheckForNull
              JTextComponent oldTC,
              @CheckForNull
              JTextComponent newTC,
              boolean update)
```
  - changeDocument
```
private void changeDocument(@CheckForNull
                  Document oldDoc,
                  @CheckForNull
                  Document newDoc,
                  boolean update)
```
  - documentUpdated
```
private void documentUpdated()
```
  - updateEditor
```
private void updateEditor(ComboBoxEditor cbe,
                @CheckForNull
                Object item)
```
  - 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.
  - lock
```
private boolean lock()
```
    Locks out mutual recursive event notification. Warning: This method works in a synchronized or single threaded environment only!
    
    Returns:
    Whether or not updating the combo box model was already locked.
  - unlock
```
private void unlock()
```
    Unlocks mutual recursive event notification. Warning: This method works in a synchronized or single threaded environment only!

Class AbstractComboBoxBrowser

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

listener

comboBox

recursion

Constructor Detail

AbstractComboBoxBrowser

AbstractComboBoxBrowser

Method Detail

getComboBox

setComboBox

changeComboBox

changeEditor

changeText

changeDocument

documentUpdated

updateEditor

update

lock

unlock