com.jroller.completer
Class AbstractCompleterFilter

java.lang.Object
  javax.swing.text.DocumentFilter
      com.jroller.completer.AbstractCompleterFilter

Direct Known Subclasses:

CompleterFilter

public abstract class AbstractCompleterFilter
extends javax.swing.text.DocumentFilter

Nested Class Summary

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

javax.swing.text.DocumentFilter.FilterBypass

Field Summary

protected boolean	_case
protected boolean	_corrective
protected int	_firstSelectedIndex
protected java.lang.String	_preText

Constructor Summary

AbstractCompleterFilter()

Method Summary

abstract int	getCompleterListSize()
abstract java.lang.Object	getCompleterObjectAt(int i)
int	getLeadingSelectedIndex()
abstract javax.swing.text.JTextComponent	getTextComponent()
void	insertString(javax.swing.text.DocumentFilter.FilterBypass filterBypass, int offset, java.lang.String string, javax.swing.text.AttributeSet attributeSet)
boolean	isCaseSensitive()
boolean	isCorrectingCase()
boolean	isPerformCompletion()
void	remove(javax.swing.text.DocumentFilter.FilterBypass filterBypass, int offset, int length)
void	replace(javax.swing.text.DocumentFilter.FilterBypass filterBypass, int offset, int length, java.lang.String string, javax.swing.text.AttributeSet attributeSet)
void	setCaseSensitive(boolean caseSensitive)
void	setCorrectCase(boolean correctCase) Will change the user entered part of the string to match the case of the matched item.
void	setPerformCompletion(boolean perform)

Methods inherited from class java.lang.Object

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

Field Detail

_preText

protected java.lang.String _preText

_case

protected boolean _case

_corrective

protected boolean _corrective

_firstSelectedIndex

protected int _firstSelectedIndex

Constructor Detail

AbstractCompleterFilter

public AbstractCompleterFilter()

Method Detail

getCompleterListSize

public abstract int getCompleterListSize()

getCompleterObjectAt

public abstract java.lang.Object getCompleterObjectAt(int i)

getTextComponent

public abstract javax.swing.text.JTextComponent getTextComponent()

setPerformCompletion

public void setPerformCompletion(boolean perform)

isPerformCompletion

public boolean isPerformCompletion()

replace

public void replace(javax.swing.text.DocumentFilter.FilterBypass filterBypass,
                    int offset,
                    int length,
                    java.lang.String string,
                    javax.swing.text.AttributeSet attributeSet)
             throws javax.swing.text.BadLocationException

Overrides:

replace in class javax.swing.text.DocumentFilter

Throws:

javax.swing.text.BadLocationException

insertString

public void insertString(javax.swing.text.DocumentFilter.FilterBypass filterBypass,
                         int offset,
                         java.lang.String string,
                         javax.swing.text.AttributeSet attributeSet)
                  throws javax.swing.text.BadLocationException

Overrides:

insertString in class javax.swing.text.DocumentFilter

Throws:

javax.swing.text.BadLocationException

remove

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

Overrides:

remove in class javax.swing.text.DocumentFilter

Throws:

javax.swing.text.BadLocationException

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

isCaseSensitive

public boolean isCaseSensitive()

setCorrectCase

public void setCorrectCase(boolean correctCase)

Will change the user entered part of the string to match the case of the matched item. e.g. "europe/lONdon" would be corrected to "Europe/London" This option only makes sense if case sensitive is turned off

isCorrectingCase

public boolean isCorrectingCase()

getLeadingSelectedIndex

public int getLeadingSelectedIndex()

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)