|
Eclipse Platform Release 3.2 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.search.core.text.TextSearchScope
org.eclipse.search.ui.text.FileTextSearchScope
A text search scope used by the file search dialog. Additionally to roots it allows to define file name patterns and exclude all derived resources.
Clients should not instantiate or subclass this class.
Method Summary | |
---|---|
boolean |
contains(IResourceProxy proxy)
Returns if a given resource is part of the scope. |
IContentType[] |
getContentTypes()
Returns the content types configured for this scope or null to match
all content types. |
String |
getDescription()
Returns the description of the scope |
String[] |
getFileNamePatterns()
Returns the file name pattern configured for this scope or null to match
all file names. |
String |
getFilterDescription()
Returns a description describing the file name patterns and content types. |
IResource[] |
getRoots()
Returns the resources that form the root. |
IWorkingSet[] |
getWorkingSets()
Returns the working-sets that were used to configure this scope or null
if the scope was not created off working sets. |
boolean |
includeDerived()
Returns whether derived resources are included in this search scope. |
static FileTextSearchScope |
newSearchScope(IResource[] roots,
String[] fileNamePatterns,
boolean includeDerived)
Returns a scope for the given root resources. |
static FileTextSearchScope |
newSearchScope(IWorkingSet[] workingSets,
String[] fileNamePatterns,
boolean includeDerived)
Returns a scope for the given working sets. |
static FileTextSearchScope |
newWorkspaceScope(String[] fileNamePatterns,
boolean includeDerived)
Returns a scope for the workspace. |
Methods inherited from class org.eclipse.search.core.text.TextSearchScope |
---|
evaluateFilesInScope, newSearchScope |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public static FileTextSearchScope newWorkspaceScope(String[] fileNamePatterns, boolean includeDerived)
includeDerived
, derived resources or
resources inside a derived container are part of the scope or not.
fileNamePatterns
- file name pattern that all files have to match null
to include all file names.includeDerived
- defines if derived files and files inside derived containers are included in the scope.
public static FileTextSearchScope newSearchScope(IResource[] roots, String[] fileNamePatterns, boolean includeDerived)
includeDerived
, derived resources or
resources inside a derived container are part of the scope or not.
roots
- the roots resources defining the scope.fileNamePatterns
- file name pattern that all files have to match null
to include all file names.includeDerived
- defines if derived files and files inside derived containers are included in the scope.
public static FileTextSearchScope newSearchScope(IWorkingSet[] workingSets, String[] fileNamePatterns, boolean includeDerived)
includeDerived
, derived resources or
resources inside a derived container are part of the scope or not.
workingSets
- the working sets defining the scope.fileNamePatterns
- file name pattern that all files have to match null
to include all file names.includeDerived
- defines if derived files and files inside derived containers are included in the scope.
public String getDescription()
public String[] getFileNamePatterns()
null
to match
all file names.
public IWorkingSet[] getWorkingSets()
null
if the scope was not created off working sets.
public IContentType[] getContentTypes()
null
to match
all content types.
public String getFilterDescription()
public boolean includeDerived()
public IResource[] getRoots()
TextSearchScope
TextSearchScope.contains(IResourceProxy)
.
getRoots
in class TextSearchScope
public boolean contains(IResourceProxy proxy)
TextSearchScope
contains
in class TextSearchScope
proxy
- the resource proxy to test.
true
if a resource is part of the scope. if false
is returned the resource
and all its children are not part of the scope.
|
Eclipse Platform Release 3.2 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.