de.cismet.tools.gui.autocomplete

Class CompleterFilter

java.lang.Object

javax.swing.text.DocumentFilter

de.cismet.tools.gui.autocomplete.AbstractCompleterFilter

de.cismet.tools.gui.autocomplete.CompleterFilter

Direct Known Subclasses:

CompleterFilterWithWindow

public class CompleterFilter
extends AbstractCompleterFilter

A filter that will attempt to autocomplete enties into a textfield with the string representations of objects in a given array.

Add this filter class to the Document of the text field.

The first match in the array is the one used to autocomplete. So sort your array by most important objects first.

Version:

$Revision$, $Date$

Author:

neilcochrane

Nested Class Summary

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

DocumentFilter.FilterBypass

Field Summary

Fields

Modifier and Type	Field and Description
protected Object[]	objectList
protected JTextField	textField

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

caseSensitive, corrective, firstSelectedIndex, preText, strict

Constructor Summary

Constructors

Constructor and Description
CompleterFilter(Object[] completerObjs, JTextField textField) Creates a new instance of CompleterFilter.

Method Summary

Modifier and Type	Method and Description
int	getCompleterListSize() DOCUMENT ME!
Object	getCompleterObjectAt(int i) DOCUMENT ME!
JTextField	getTextField() DOCUMENT ME!
void	setCompleterMatches(Object[] objectsToMatch) Set the list of objects to match against.

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

getLeadingSelectedIndex, insertString, isCaseSensitive, isCorrectingCase, isStrict, remove, replace, setCaseSensitive, setCorrectCase, setStrict

Methods inherited from class java.lang.Object

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

Field Detail

textField

protected JTextField textField

objectList

protected Object[] objectList

Constructor Detail

CompleterFilter

public CompleterFilter(Object[] completerObjs,
                       JTextField textField)

Creates a new instance of CompleterFilter.

Parameters:

completerObjs - an array of objects used to attempt completion

textField - the text component to receive the completion

Method Detail

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!

setCompleterMatches

public void setCompleterMatches(Object[] objectsToMatch)

Set the list of objects to match against.

Parameters:

objectsToMatch - DOCUMENT ME!