de.cismet.tools.gui.autocomplete

Class AbstractCompleterFilter

java.lang.Object

javax.swing.text.DocumentFilter

de.cismet.tools.gui.autocomplete.AbstractCompleterFilter

Direct Known Subclasses:

ComboCompleterFilter, CompleterFilter

public abstract class AbstractCompleterFilter
extends DocumentFilter

DOCUMENT ME!

Version:

$Revision$, $Date$

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 boolean	caseSensitive
protected boolean	corrective
protected int	firstSelectedIndex
protected String	preText
protected boolean	strict

Constructor Summary

Constructors

Constructor and Description
AbstractCompleterFilter()

Method Summary

Modifier and Type	Method and Description
abstract int	getCompleterListSize() DOCUMENT ME!
abstract Object	getCompleterObjectAt(int i) DOCUMENT ME!
int	getLeadingSelectedIndex() DOCUMENT ME!
abstract JTextField	getTextField() DOCUMENT ME!
void	insertString(DocumentFilter.FilterBypass filterBypass, int offset, String string, AttributeSet attributeSet)
boolean	isCaseSensitive() DOCUMENT ME!
boolean	isCorrectingCase() DOCUMENT ME!
boolean	isStrict() 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	setCaseSensitive(boolean correctCaseSensitive) DOCUMENT ME!
void	setCorrectCase(boolean correctCase) Will change the user entered part of the string to match the caseSensitive of the matched item.
void	setStrict(boolean strict) DOCUMENT ME!

Methods inherited from class java.lang.Object

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

Field Detail

preText

protected String preText

caseSensitive

protected boolean caseSensitive

corrective

protected boolean corrective

strict

protected boolean strict

firstSelectedIndex

protected int firstSelectedIndex

Constructor Detail

AbstractCompleterFilter

public AbstractCompleterFilter()

Method Detail

getCompleterListSize

public abstract int getCompleterListSize()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getCompleterObjectAt

public abstract Object getCompleterObjectAt(int i)

DOCUMENT ME!

Parameters:

i - DOCUMENT ME!

Returns:

DOCUMENT ME!

getTextField

public abstract JTextField getTextField()

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 DocumentFilter

Throws:

BadLocationException

insertString

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

Overrides:

insertString in class DocumentFilter

Throws:

BadLocationException

remove

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

Overrides:

remove in class DocumentFilter

Throws:

BadLocationException

setCaseSensitive

public void setCaseSensitive(boolean correctCaseSensitive)

DOCUMENT ME!

Parameters:

correctCaseSensitive - DOCUMENT ME!

isCaseSensitive

public boolean isCaseSensitive()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setCorrectCase

public void setCorrectCase(boolean correctCase)

Will change the user entered part of the string to match the caseSensitive of the matched item.

e.g. "europe/lONdon" would be corrected to "Europe/London"

This option only makes sense if caseSensitive sensitive is turned off

Parameters:

correctCase - DOCUMENT ME!

isCorrectingCase

public boolean isCorrectingCase()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getLeadingSelectedIndex

public int getLeadingSelectedIndex()

DOCUMENT ME!

Returns:

the index of the first object in the object array that can match the user entered string (-1 if no object is currently being used as a match)

isStrict

public boolean isStrict()

DOCUMENT ME!

Returns:

the this.strict

setStrict

public void setStrict(boolean strict)

DOCUMENT ME!

Parameters:

strict - the this.strict to set