bill.util.gui
Interface JTextFieldFilterInterface

All Known Implementing Classes:
JTextFieldEnterFilter, JTextFieldFilter

public interface JTextFieldFilterInterface

Interface to be implemented and JTextField extension classes that perform filtering on the characters entered in them.


Method Summary
 String getFilter()
          Retrieves the currently specified filter string.
 boolean isInclude()
          Retrieves the include mode for this instance.
 void setFilter(String filter)
          Sets the input character filter string to the specified value.
 void setInclude(boolean include)
          Sets the include mode of the filter.
 

Method Detail

setFilter

public void setFilter(String filter)
Sets the input character filter string to the specified value. All characters entered in the text field that are not in this filter string are discarded.
Parameters:
filter - The filter string.

getFilter

public String getFilter()
Retrieves the currently specified filter string.
Returns:
The filter string, or null if none has been specified.

setInclude

public void setInclude(boolean include)
Sets the include mode of the filter. If the include mode is true then characters entered that are in the filter string are kept and others are dropped, if false then vice versa.
Parameters:
include - Value to set include mode to.

isInclude

public boolean isInclude()
Retrieves the include mode for this instance.
Returns:
true if we are using include mode, false if we are using exclude mode.