public class ScriptSearchManager extends java.lang.Object implements SearchProvider
SearchProvider.SelectedObjectsHandler
Modifier and Type | Method and Description |
---|---|
java.util.List<java.lang.Object> |
getCategories()
Returns a list of "categories", or sub-selectable units, supported by this search provider.
|
static ScriptSearchManager |
getInstance() |
java.lang.String |
getName()
Returns the name of the search provider, which will be used in the UI.
|
boolean |
hasSelectableObjects()
Whether or not the set of objects searched by this provider is selectable- for examples, which groups or windows
are to be searched.
|
void |
notifySearchClosed()
Called when the search dialog box is closed, so that the search provider can release any cached resources
|
void |
registerSubProvider(SearchProvider provider) |
java.util.Iterator<SearchObject> |
retrieveSearchableObjects(java.util.Collection<java.lang.Object> categories,
java.util.List<java.lang.Object> searchObjects,
TaskProgressListener progress)
Returns an iterator that provides all of the objects described by the parameters.
|
java.lang.String |
selectedObjectsToString(java.util.List<java.lang.Object> objects)
Formats the list of selected objects as a brief string.
|
void |
selectObjects(SearchProvider.SelectedObjectsHandler handler)
Instructs the SearchProvider to show a dialog in order to select the objects to search.
|
void |
unregisterSubProvider(java.lang.String providerName) |
public static ScriptSearchManager getInstance()
public void registerSubProvider(SearchProvider provider)
public void unregisterSubProvider(java.lang.String providerName)
public java.lang.String getName()
SearchProvider
getName
in interface SearchProvider
public java.util.List<java.lang.Object> getCategories()
SearchProvider
getCategories
in interface SearchProvider
public boolean hasSelectableObjects()
SearchProvider
hasSelectableObjects
in interface SearchProvider
public java.lang.String selectedObjectsToString(java.util.List<java.lang.Object> objects)
SearchProvider
selectedObjectsToString
in interface SearchProvider
public void selectObjects(SearchProvider.SelectedObjectsHandler handler)
SearchProvider
selectObjects
in interface SearchProvider
public java.util.Iterator<SearchObject> retrieveSearchableObjects(java.util.Collection<java.lang.Object> categories, java.util.List<java.lang.Object> searchObjects, TaskProgressListener progress)
SearchProvider
retrieveSearchableObjects
in interface SearchProvider
categories
- indicates the user selection (if applicable) of which categories should be searched.searchObjects
- the user selected objects (if applicable) to be searched.progress
- a progress listener for this provider, which can be updated as the returned Iterator is used. If not
supported, the provider should call setIndeterminate(true).public void notifySearchClosed()
SearchProvider
notifySearchClosed
in interface SearchProvider