com.sciapp.table.search
Class SearchModelEvent

java.lang.Object
  java.util.EventObject
      com.sciapp.table.search.SearchModelEvent

All Implemented Interfaces:

Serializable

public class SearchModelEvent
extends EventObject

An event used to search a table structure.

See Also:

Serialized Form

Field Summary

static int	ALL_COLUMNS denotes to search all columns
static int	ALL_ROWS denotes to search all rows
protected int	fromColumn the starting column
protected int	fromRow the starting row
static int	HIGHLIGHT_OFF the hightlight off mode
static int	HIGHLIGHT_ON the hightlight on mode
protected boolean	isForwards the search direction
static int	LAST_COLUMN denotes the last column that previously matched
static int	LAST_ROW denotes the last row that previously matched
protected int	mode the search mode
static int	NEXT_COLUMN denotes the next column from the previously matched
static int	NEXT_ROW denotes the next row from the previously matched
static int	NORMAL_MODE the normal mode
protected Search	search the search object

Fields inherited from class java.util.EventObject

source

Constructor Summary

SearchModelEvent(Object source, Search search)
Constructs a SearchModelEvent object.

SearchModelEvent(Object source, Search search, int fromRow, int fromColumn, boolean isForwards)
Constructs a SearchModelEvent object.

SearchModelEvent(Object source, Search search, int fromRow, int fromColumn, boolean isForwards, int mode)
Constructs a SearchModelEvent object.

Method Summary

int	getFromColumn() Returns the search starting column or NEXT_COLUMN.
int	getFromRow() Returns the search starting row or NEXT_ROW.
int	getMode() Returns the search mode.
Search	getSearch() Returns the object that will search the table structure.
boolean	isForwards() Returns the direction of the search.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

search

protected Search search

the search object

fromRow

protected int fromRow

the starting row

fromColumn

protected int fromColumn

the starting column

isForwards

protected boolean isForwards

the search direction

mode

protected int mode

the search mode

NEXT_ROW

public static final int NEXT_ROW

denotes the next row from the previously matched

See Also:

Constant Field Values

NEXT_COLUMN

public static final int NEXT_COLUMN

denotes the next column from the previously matched

See Also:

Constant Field Values

ALL_ROWS

public static final int ALL_ROWS

denotes to search all rows

See Also:

Constant Field Values

ALL_COLUMNS

public static final int ALL_COLUMNS

denotes to search all columns

See Also:

Constant Field Values

LAST_ROW

public static final int LAST_ROW

denotes the last row that previously matched

See Also:

Constant Field Values

LAST_COLUMN

public static final int LAST_COLUMN

denotes the last column that previously matched

See Also:

Constant Field Values

HIGHLIGHT_ON

public static final int HIGHLIGHT_ON

the hightlight on mode

See Also:

Constant Field Values

HIGHLIGHT_OFF

public static final int HIGHLIGHT_OFF

the hightlight off mode

See Also:

Constant Field Values

NORMAL_MODE

public static final int NORMAL_MODE

the normal mode

See Also:

Constant Field Values

Constructor Detail

SearchModelEvent

public SearchModelEvent(Object source,
                        Search search)

Constructs a SearchModelEvent object. The search is in forward direction, starts from NEXT_ROW and NEXT_COLUMN.

Parameters:

source - the object generating the event

search - the object that will search the table structure

SearchModelEvent

public SearchModelEvent(Object source,
                        Search search,
                        int fromRow,
                        int fromColumn,
                        boolean isForwards)

Constructs a SearchModelEvent object.

Parameters:

source - the Object generating the event

search - the object that will search the table structure

fromRow - the search starting row

fromColumn - the search starting column

isForwards - true if the search is in forward direction, false otherwise

SearchModelEvent

public SearchModelEvent(Object source,
                        Search search,
                        int fromRow,
                        int fromColumn,
                        boolean isForwards,
                        int mode)

Constructs a SearchModelEvent object.

Parameters:

source - the Object generating the event

search - the object that will search the table structure

fromRow - the search starting row

fromColumn - the search starting column

isForwards - true if the search is in forward direction, false otherwise

mode - the search mode

Method Detail

getFromColumn

public int getFromColumn()

Returns the search starting column or NEXT_COLUMN.

Returns:

an integer denoting the next column to search.

getFromRow

public int getFromRow()

Returns the search starting row or NEXT_ROW.

Returns:

an integer denoting the next row to search.

getMode

public int getMode()

Returns the search mode.

Returns:

the search mode

getSearch

public Search getSearch()

Returns the object that will search the table structure.

Returns:

the object set to search the data of the table.

isForwards

public boolean isForwards()

Returns the direction of the search.

Returns:

true if search is in forward direction, false otherwise.