de.cismet.tools.gui.autocomplete

Class ComboCompleterFilter

java.lang.Object

javax.swing.text.DocumentFilter

de.cismet.tools.gui.autocomplete.AbstractCompleterFilter

de.cismet.tools.gui.autocomplete.ComboCompleterFilter

public class ComboCompleterFilter
extends AbstractCompleterFilter

Class to add completion mechanism to combo boxes. The class assumes that the look and field uses a JTextField as the combo box editor. A check should be done to ensure this is true before adding this class to a ComboBox.

To add to a combo, call the static method addCompletionMechanism(yourCombo), or do the following:

if (!(myCombo.getEditor().getEditorComponent() instanceof JTextField)) return;

JTextField tf = (JTextField)myCombo.getEditor().getEditorComponent(); PlainDocument pd = new PlainDocument(); this.filter = new ComboCompleterFilter(myCombo); pd.setDocumentFilter(this.filter); tf.setDocument(pd);

Version:

$Revision$, $Date$

Author:

ncochran

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.text.DocumentFilter

DocumentFilter.FilterBypass

Field Summary

Fields inherited from class de.cismet.tools.gui.autocomplete.AbstractCompleterFilter

caseSensitive, corrective, firstSelectedIndex, preText, strict

Constructor Summary

Constructors

Constructor and Description
ComboCompleterFilter(JComboBox combo) Creates a new ComboCompleterFilter object.

Method Summary

Modifier and Type	Method and Description
static ComboCompleterFilter	addCompletionMechanism(JComboBox combo) Helper method to add auto-completion to a jcombobox or derivation.
int	getCompleterListSize() DOCUMENT ME!
Object	getCompleterObjectAt(int i) DOCUMENT ME!
String	getNullRespresentation() DOCUMENT ME!
JTextField	getTextField() DOCUMENT ME!
void	remove(DocumentFilter.FilterBypass filterBypass, int offset, int length)
void	replace(DocumentFilter.FilterBypass filterBypass, int offset, int length, String string, AttributeSet attributeSet)
void	setNullRespresentation(String nullRespresentation) DOCUMENT ME!
void	setStrict(boolean strict) DOCUMENT ME!

Methods inherited from class de.cismet.tools.gui.autocomplete.AbstractCompleterFilter

getLeadingSelectedIndex, insertString, isCaseSensitive, isCorrectingCase, isStrict, setCaseSensitive, setCorrectCase

Methods inherited from class java.lang.Object

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

Constructor Detail

ComboCompleterFilter

public ComboCompleterFilter(JComboBox combo)

Creates a new ComboCompleterFilter object.

Parameters:

combo - DOCUMENT ME!

Method Detail

getNullRespresentation

public String getNullRespresentation()

DOCUMENT ME!

Returns:

the nullRespresentation

setNullRespresentation

public void setNullRespresentation(String nullRespresentation)

DOCUMENT ME!

Parameters:

nullRespresentation - the nullRespresentation to set

getCompleterListSize

public int getCompleterListSize()

Description copied from class: AbstractCompleterFilter

DOCUMENT ME!

Specified by:

getCompleterListSize in class AbstractCompleterFilter

Returns:

DOCUMENT ME!

getCompleterObjectAt

public Object getCompleterObjectAt(int i)

Description copied from class: AbstractCompleterFilter

DOCUMENT ME!

Specified by:

getCompleterObjectAt in class AbstractCompleterFilter

Parameters:

i - DOCUMENT ME!

Returns:

DOCUMENT ME!

getTextField

public JTextField getTextField()

Description copied from class: AbstractCompleterFilter

DOCUMENT ME!

Specified by:

getTextField in class AbstractCompleterFilter

Returns:

DOCUMENT ME!

addCompletionMechanism

public static ComboCompleterFilter addCompletionMechanism(JComboBox combo)

Helper method to add auto-completion to a jcombobox or derivation.

The look and feel must use a JTextField as the combo box editor (or null will be returned).

The JTextField will have it's document set to a new PlainDocument and the returned filter will be set to autocomplete the contents. Use the returned filter to set options such as case-sensitivity.

Parameters:

combo - DOCUMENT ME!

Returns:

DOCUMENT ME!

replace

public void replace(DocumentFilter.FilterBypass filterBypass,
                    int offset,
                    int length,
                    String string,
                    AttributeSet attributeSet)
             throws BadLocationException

Overrides:

replace in class AbstractCompleterFilter

Throws:

BadLocationException

remove

public void remove(DocumentFilter.FilterBypass filterBypass,
                   int offset,
                   int length)
            throws BadLocationException

Overrides:

remove in class AbstractCompleterFilter

Throws:

BadLocationException

setStrict

public void setStrict(boolean strict)

Description copied from class: AbstractCompleterFilter

DOCUMENT ME!

Overrides:

setStrict in class AbstractCompleterFilter

Parameters:

strict - the this.strict to set