Eclipse GEF and Draw2d Plug-in Developer Guide (Galileo) - ExclusionSearch (Eclipse Draw2d API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Draw2d
3.3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.draw2d
Class ExclusionSearch

java.lang.Object
  
org.eclipse.draw2d.ExclusionSearch

All Implemented Interfaces:: TreeSearch

public class ExclusionSearch
extends java.lang.Object
implements TreeSearch

A TreeSearch that excludes figures contained in a Collection.

Since:: 2.1

Constructor Summary

ExclusionSearch (java.util.Collection collection)
          Constructs an Exclusion search using the given collection.

Method Summary

boolean accept ( IFigure figure)
          Returns true if the given figure is accepted by the search.

boolean prune ( IFigure f)
          Returns true if the figure is a member of the Collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExclusionSearch

public ExclusionSearch(java.util.Collection collection)

Constructs an Exclusion search using the given collection.
Parameters:: collection - the exclusion set

Method Detail

accept

public boolean accept(
IFigure figure)

Description copied from interface: TreeSearch

Returns true if the given figure is accepted by the search.

Specified by:: accept in interface TreeSearch

Parameters:: figure - the current figure in the traversal
Returns:: true if the figure is accepted
See Also:: TreeSearch.accept(IFigure)

prune

public boolean prune(
IFigure f)

Returns true if the figure is a member of the Collection.

Specified by:: prune in interface TreeSearch

Parameters:: f - the current figure in the traversal
Returns:: true if the subgraph should be pruned
See Also:: TreeSearch.prune(IFigure)