Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.search.ui.text
Class MatchFilter

java.lang.Object
  extended by 
org.eclipse.search.ui.text.MatchFilter

public abstract class MatchFilter
extends Object

A match filter is used to evaluate the filter state of a match ( Match.isFiltered(). Filters are managed by the ( AbstractTextSearchResult.

Since:
3.3

Constructor Summary
MatchFilter ()
           
 
Method Summary
abstract  boolean filters ( Match match)
          Returns whether the given match is filtered by this filter.
abstract   String getActionLabel ()
          Returns the label of the filter as shown by the filter action.
abstract   String getDescription ()
          Returns the description of the filter as shown in the match filter selection dialog.
abstract   String getID ()
          Returns an ID of this filter.
abstract   String getName ()
          Returns the name of the filter as shown in the match filter selection dialog.
 
Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MatchFilter

public MatchFilter()
Method Detail

filters

public abstract boolean filters(
Match match)
Returns whether the given match is filtered by this filter.

Parameters:
match - the match to look at
Returns:
returns true if the given match should be filtered or false if not.

getName

public abstract 
String getName()
Returns the name of the filter as shown in the match filter selection dialog.

Returns:
the name of the filter as shown in the match filter selection dialog.

getDescription

public abstract 
String getDescription()
Returns the description of the filter as shown in the match filter selection dialog.

Returns:
the description of the filter as shown in the match filter selection dialog.

getActionLabel

public abstract 
String getActionLabel()
Returns the label of the filter as shown by the filter action.

Returns:
the label of the filter as shown by the filter action.

getID

public abstract 
String getID()
Returns an ID of this filter.

Returns:
the id of the filter to be used when persisting this filter.

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire