com.sciapp.filter
Class StringVisualFilter

java.lang.Object
  com.sciapp.filter.VisualFilter
      com.sciapp.filter.StringVisualFilter

public class StringVisualFilter
extends VisualFilter

A VisualFilter for String values.

Field Summary

protected JCheckBox	caseSensitive a checkbox used to denote case(in)sensitivity.
protected JTextField	expression a textfield used to input the string expression.
protected JComboBox	fieldBoxOptions a combobox containing the filter options.
protected JLabel	filterLabel the label between the filter options combo box and the expression
protected StringFilter	stringFilter a string filter object used to filter Strings.

Fields inherited from class com.sciapp.filter.VisualFilter

anyKey, filterModel

Constructor Summary

StringVisualFilter()
Constructs a StringVisualFilter.

Method Summary

JCheckBox	getCaseSensitive() Returns a checkbox that is used to denote case(in)sensitivity for the string pattern.
JTextField	getExpression() Returns a textfield that is used to display and allow input of the string pattern.
JComboBox	getFieldBoxOptions() Returns a combobox containing the filter options.
Filter	getFilter() Returns the filter object that this component uses to filter the values.
JLabel	getFilterLabel() Returns a label between the filter options combo box and the expression textfield.
JPanel	getPanel() Returns the panel containing the controls used to manipulate the filter.
TableFilter	getTableFilter() Returns a table filter object corresponding to the visual controls of the filter.
void	setTableFilter(TableFilter tf) This method should modify the visual control's values to those corresponding to the supplied TableFilter object.
boolean	shouldApplyFilter() Returns true if the current filter should be applied, false otherwise.

Methods inherited from class com.sciapp.filter.VisualFilter

fireFilter, getFilterModel, getFilterOnKey, setFilterOnKey

Methods inherited from class java.lang.Object

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

Field Detail

caseSensitive

protected JCheckBox caseSensitive

a checkbox used to denote case(in)sensitivity.

fieldBoxOptions

protected JComboBox fieldBoxOptions

a combobox containing the filter options.

stringFilter

protected StringFilter stringFilter

a string filter object used to filter Strings.

expression

protected JTextField expression

a textfield used to input the string expression.

filterLabel

protected JLabel filterLabel

the label between the filter options combo box and the expression

Constructor Detail

StringVisualFilter

public StringVisualFilter()

Constructs a StringVisualFilter.

Method Detail

getCaseSensitive

public JCheckBox getCaseSensitive()

Returns a checkbox that is used to denote case(in)sensitivity for the string pattern.

Returns:

the checkbox showing the case sensitivity

getExpression

public JTextField getExpression()

Returns a textfield that is used to display and allow input of the string pattern.

Returns:

the 'string' text field.

getFieldBoxOptions

public JComboBox getFieldBoxOptions()

Returns a combobox containing the filter options.

Returns:

the 'filter' combobox.

getFilter

public Filter getFilter()

Returns the filter object that this component uses to filter the values.

Specified by:

getFilter in class VisualFilter

Returns:

a filter

getFilterLabel

public JLabel getFilterLabel()

Returns a label between the filter options combo box and the expression textfield.

Returns:

the 'filter' label.

getPanel

public JPanel getPanel()

Returns the panel containing the controls used to manipulate the filter.

Specified by:

getPanel in class VisualFilter

Returns:

a panel with controls used in filtering.

getTableFilter

public TableFilter getTableFilter()

Returns a table filter object corresponding to the visual controls of the filter.

Specified by:

getTableFilter in class VisualFilter

Returns:

a table filter

setTableFilter

public void setTableFilter(TableFilter tf)

This method should modify the visual control's values to those corresponding to the supplied TableFilter object.

Specified by:

setTableFilter in class VisualFilter

Parameters:

tf - the TableFilter to set.

shouldApplyFilter

public boolean shouldApplyFilter()

Returns true if the current filter should be applied, false otherwise. Sometimes, can opt NOT to filter, e.g. if a number or a date is not parseable.

Specified by:

shouldApplyFilter in class VisualFilter

Returns:

true if the filter should be applied