Copyright © 2011 Citra Technologies. All Rights Reserved.

com.citra.event
Class FilterTreeTableModelEvent

java.lang.Object
  extended by java.util.EventObject
      extended by com.citra.event.FilterTreeTableModelEvent
All Implemented Interfaces:
Serializable

public class FilterTreeTableModelEvent
extends EventObject

An event that is sent whenever filters of a FilterTreeTableModel are added or removed.

See Also:
Serialized Form

Field Summary
protected  int level
          the level at which a table filter was assigned
protected  Object node
          the node at which a table filter was assigned
protected  TableFilter tableFilter
          the table filter
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
FilterTreeTableModelEvent(FilterTreeTableModel source, TableFilter tableFilter, int level)
          Constructs a FilterTreeTableModelEvent object.
FilterTreeTableModelEvent(FilterTreeTableModel source, TableFilter tableFilter, Object node)
          Constructs a FilterTreeTableModelEvent object.
 
Method Summary
 int getLevel()
          Returns the tree level at which a table filter was installed.
 Object getNode()
          Returns the node at which a table filter was installed.
 TableFilter getTableFilter()
          Returns the table filter that was installed.
 
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

tableFilter

protected TableFilter tableFilter
the table filter


node

protected Object node
the node at which a table filter was assigned


level

protected int level
the level at which a table filter was assigned

Constructor Detail

FilterTreeTableModelEvent

public FilterTreeTableModelEvent(FilterTreeTableModel source,
                                 TableFilter tableFilter,
                                 int level)
Constructs a FilterTreeTableModelEvent object.

Parameters:
source - the Object generating the event
tableFilter - the table filter that was installed
level - the tree level at which a table filter was installed

FilterTreeTableModelEvent

public FilterTreeTableModelEvent(FilterTreeTableModel source,
                                 TableFilter tableFilter,
                                 Object node)
Constructs a FilterTreeTableModelEvent object.

Parameters:
source - the Object generating the event
tableFilter - the table filter that was installed
node - the node at which a table filter was installed
Method Detail

getLevel

public int getLevel()
Returns the tree level at which a table filter was installed. If this is -1, the table filter was installed on a specific node retrieved with FilterTreeTableModelEvent.getNode().

SPECIAL CASE:
If both FilterTreeTableModelEvent.getLevel() and FilterTreeTableModelEvent.getNode() return -1 and null respectively, then a default filter (overriding all other filters) was installed.

Returns:
the tree level on which the filter was installed or -1 if the filter was installed on a node.

getNode

public Object getNode()
Returns the node at which a table filter was installed. If this is null, the table filter was installed on a tree level retrieved with FilterTreeTableModelEvent.getLevel().

SPECIAL CASE:
If both FilterTreeTableModelEvent.getLevel() and FilterTreeTableModelEvent.getNode() return -1 and null respectively, then a default filter (overriding all other filters) was installed.

Returns:
the node on which the filter was installed or null if the filter was installed on a level.

getTableFilter

public TableFilter getTableFilter()
Returns the table filter that was installed. If this is null, the table filter previously installed, has now been uninstalled.

Returns:
the table filter installed

Copyright © 2011 Citra Technologies. All Rights Reserved.