edu.umd.cs.jazz.util
Class ZBoundsFindFilter

java.lang.Object
  |
  +--edu.umd.cs.jazz.util.ZBoundsFindFilter
All Implemented Interfaces:
java.io.Serializable, ZFindFilter
Direct Known Subclasses:
ZMagBoundsFindFilter

public class ZBoundsFindFilter
extends java.lang.Object
implements ZFindFilter, java.io.Serializable

ZBoundsFindFilter is a filter that accepts visual and terminal nodes that overlap the specified bounds in global coordinates. Visual nodes are those node types that have visual components, and are not editors of another node (i.e., do not have 'hasOneChild' set). Terminal nodes are leaf nodes and group nodes that do not "childrenFindable".

Warning: Serialized and ZSerialized objects of this class will not be compatible with future Jazz releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Jazz. A future release of Jazz will provide support for long term persistence.

Author:
Ben Bederson
See Also:
Serialized Form

Constructor Summary
ZBoundsFindFilter(ZBounds bounds)
          Create a new bounds filter.
 
Method Summary
 boolean accept(ZNode node)
          Determine if the specified node is accepted by this filter.
 boolean childrenFindable(ZNode node)
          Determine if the children of the specified node should be searched.
 ZBounds getBounds()
          Return the bounds of this filter's search region.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ZBoundsFindFilter

public ZBoundsFindFilter(ZBounds bounds)
Create a new bounds filter.

Parameters:
bounds - The bounds in global coordinates to search within.
Method Detail

accept

public boolean accept(ZNode node)
Determine if the specified node is accepted by this filter.

Specified by:
accept in interface ZFindFilter
Parameters:
node - The node that is to be examined by this filter
Returns:
True if the node is accepted by the filter
See Also:
ZDrawingSurface.findNodes(edu.umd.cs.jazz.util.ZFindFilter)

childrenFindable

public boolean childrenFindable(ZNode node)
Determine if the children of the specified node should be searched.

Specified by:
childrenFindable in interface ZFindFilter
Parameters:
node - The node that is to be examined by this filter
Returns:
True if this node's children should be searched, or false otherwise.

getBounds

public ZBounds getBounds()
Return the bounds of this filter's search region.

Returns:
The bounds.


Copyright 2003 by University of Maryland, College Park, MD 20742, USA All rights reserved.