Copyright © 2005 Scientific Applications. All Rights Reserved.

com.sciapp.table.search
Class VisualSeeker

java.lang.Object
  extended by com.sciapp.table.search.VisualSeeker
Direct Known Subclasses:
BooleanVisualSeeker, DateVisualSeeker, NumericalVisualSeeker, StringVisualSeeker

public abstract class VisualSeeker
extends Object

This class represents an object through which searching can be manipulated visually from a SearchTablePanel.


Field Summary
protected  boolean anyKey
          boolean flag that if true, search model events are fired whenever a key press is detected on a text field, otherwise the user must press the Enter key.
protected  SearchModel searchModel
          the search model
 
Constructor Summary
VisualSeeker()
          Creates a new VisualSeeker object with users required to press the enter key on textfields so that the search can be performed.
 
Method Summary
 void fireSearch()
          Generates and forwards a search model event to the listeners of the search model.
abstract  JPanel getPanel()
          Returns the panel containing the controls used to manipulate the search.
 SearchModel getSearchModel()
          Returns the search model.
 boolean getSearchOnKey()
          Returns a boolean value that if true, search model 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  TableSearch getTableSearch()
          Returns a table search object corresponding to the visual controls of the search.
 void setSearchOnKey(boolean key)
          Set key to true for search model events to be fired upon key detection.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

anyKey

protected boolean anyKey
boolean flag that if true, search model events are fired whenever a key press is detected on a text field, otherwise the user must press the Enter key.


searchModel

protected SearchModel searchModel
the search model

Constructor Detail

VisualSeeker

public VisualSeeker()
Creates a new VisualSeeker object with users required to press the enter key on textfields so that the search can be performed.

Method Detail

fireSearch

public void fireSearch()
Generates and forwards a search model event to the listeners of the search model. The search model event is initialized with a TableSearch taken by calling the getTableSearch() method.


getPanel

public abstract JPanel getPanel()
Returns the panel containing the controls used to manipulate the search.

Returns:
a panel with controls used in searching.

getSearchModel

public SearchModel getSearchModel()
Returns the search model.

Returns:
the search model.

getSearchOnKey

public boolean getSearchOnKey()
Returns a boolean value that if true, search model 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.

Returns:
true for search model events to be fired upon key detection

getTableSearch

public abstract TableSearch getTableSearch()
Returns a table search object corresponding to the visual controls of the search.

Returns:
a table search

setSearchOnKey

public void setSearchOnKey(boolean key)
Set key to true for search model events to be fired upon key detection.

Parameters:
key - true if search model events are to be fired upon key detection

Copyright © 2005 Scientific Applications. All Rights Reserved.