com.jidesoft.grid
Class FilterableTableModelEvent

java.lang.Object
  java.util.EventObject
      java.awt.AWTEvent
          com.jidesoft.grid.FilterableTableModelEvent

All Implemented Interfaces:

Serializable

public class FilterableTableModelEvent
extends AWTEvent

An AWTEvent that adds support for FilterableTableModel objects as the event source when filter is added or removed.

See Also:

Serialized Form

Field Summary

static int	ALL_COLUMNS Specifies all columns.
static int	ANY_COLUMNS Specifies any columns.
static int	FILTER_ADDED This event is delivered when a Filter is added.
static int	FILTER_REMOVED This event is delivered when a Filter is removed.
static int	FILTERABLE_TABLE_MODEL_EVENT_FIRST The first number in the range of IDs used for FilterableTableModel events.
static int	FILTERABLE_TABLE_MODEL_EVENT_LAST The last number in the range of IDs used for FilterableTableModel events.
static int	WHOLE_TABLE_MODEL Specifies any columns.

Fields inherited from class java.awt.AWTEvent

ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK

Fields inherited from class java.util.EventObject

source

Constructor Summary

FilterableTableModelEvent(Object source, int id)
Constructs an FilterEvent object.

FilterableTableModelEvent(Object source, int id, int column, Filter filter)

Method Summary

int	getColumn() Gets the column index that this change event affects.
Filter	getFilter()

Methods inherited from class java.awt.AWTEvent

consume, getID, isConsumed, paramString, setSource, toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

FILTERABLE_TABLE_MODEL_EVENT_FIRST

public static final int FILTERABLE_TABLE_MODEL_EVENT_FIRST

The first number in the range of IDs used for FilterableTableModel events.

See Also:

Constant Field Values

FILTERABLE_TABLE_MODEL_EVENT_LAST

public static final int FILTERABLE_TABLE_MODEL_EVENT_LAST

The last number in the range of IDs used for FilterableTableModel events.

See Also:

Constant Field Values

FILTER_ADDED

public static final int FILTER_ADDED

This event is delivered when a Filter is added. You can call getColumn() to find the column where the filter is added and getFilter() will tell you the filter that is added.

See Also:

Constant Field Values

FILTER_REMOVED

public static final int FILTER_REMOVED

This event is delivered when a Filter is removed. You can call getColumn() to find the column where the filter is removed and getFilter() will tell you the filter that is removed. It could return null when removeFilters is called which means all filters for that particular columns are removed. In particular,

See Also:

Constant Field Values

ALL_COLUMNS

public static final int ALL_COLUMNS

Specifies all columns. You can use this to apply a filter to all columns. All columns must satisfy the filter condition in order for the row not to be filtered away.

See Also:

Constant Field Values

ANY_COLUMNS

public static final int ANY_COLUMNS

Specifies any columns. You can use this to apply a filter to any columns. As long as there is one column satisfies the filter condition, the row will not be filtered away.

See Also:

Constant Field Values

WHOLE_TABLE_MODEL

public static final int WHOLE_TABLE_MODEL

Specifies any columns. You can use this to apply a filter to any columns. As long as there is one column satisfies the filter condition, the row will not be filtered away.

See Also:

Constant Field Values

Constructor Detail

FilterableTableModelEvent

public FilterableTableModelEvent(Object source,
                                 int id)

Constructs an FilterEvent object.

Parameters:

source - the Filter object that originated the event

id - an integer indicating the type of event

FilterableTableModelEvent

public FilterableTableModelEvent(Object source,
                                 int id,
                                 int column,
                                 Filter filter)

Method Detail

getFilter

public Filter getFilter()

getColumn

public int getColumn()

Gets the column index that this change event affects. It could be 0 to columnCount -1. Or -1 means ALL_COLUMNS. -2, means ANY_COLUMN, or -3 means the whole table model. The last -3 case is only used when FilterableTableModel.clearFilters() is called.

Returns:

the column index.