|
Copyright © 2011 Citra Technologies. All Rights Reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.citra.filter.VisualFilter
public abstract class VisualFilter
This class represents an object through which filters can be manipulated visually in a FilterTablePanel.
Field Summary | |
---|---|
protected boolean |
anyKey
boolean flag that if true, filter events are fired whenever a key press is detected on a text field, otherwise the user must press the Enter key. |
protected FilterModel |
filterModel
the filter model |
Constructor Summary | |
---|---|
VisualFilter()
Creates a new VisualFilter object with users required to press the enter key on textfields so that the filter can be applied. |
Method Summary | |
---|---|
void |
fireFilter()
Generates and forwards a filter event to the listeners of the filter model. |
abstract Filter |
getFilter()
Returns the filter object that this component uses to filter the values. |
FilterModel |
getFilterModel()
Returns the filter model. |
boolean |
getFilterOnKey()
Returns a boolean value that if true, filter events are fired whenever a key press is detected on a text field, otherwise the user must press the Enter key for this to happen. |
abstract JPanel |
getPanel()
Returns the panel containing the controls used to manipulate the filter. |
abstract TableFilter |
getTableFilter()
Returns a table filter object corresponding to the visual controls of the filter. |
abstract void |
setFilter(Filter filter)
Assigns a filter object that this component uses to filter the values. |
void |
setFilterOnKey(boolean key)
Set key to true for filter events to be fired upon key detection. |
abstract void |
setTableFilter(TableFilter tf)
This method should modify the visual control's values to those corresponding to the supplied TableFilter object. |
abstract boolean |
shouldApplyFilter()
Returns true if the current filter should be applied, false otherwise. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected boolean anyKey
protected FilterModel filterModel
Constructor Detail |
---|
public VisualFilter()
Method Detail |
---|
public void fireFilter()
public abstract Filter getFilter()
public FilterModel getFilterModel()
public boolean getFilterOnKey()
public abstract JPanel getPanel()
public abstract TableFilter getTableFilter()
public abstract void setFilter(Filter filter)
filter
- the filter to assignpublic void setFilterOnKey(boolean key)
key
to true for filter events to be fired upon key detection.
key
- true if filter events are to be fired upon key detectionpublic abstract void setTableFilter(TableFilter tf)
tf
- the TableFilter to set.public abstract boolean shouldApplyFilter()
|
Copyright © 2011 Citra Technologies. All Rights Reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |