public class ModuleLibrarySearchProvider extends AbstractSearchProvider
SearchProvider.SelectedObjectsHandler
Constructor and Description |
---|
ModuleLibrarySearchProvider(DesignerContext context,
java.lang.String name,
java.lang.Runnable locateFunc) |
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.
|
java.lang.String |
getName()
Returns the name of the search provider, which will be used in the UI.
|
protected java.lang.String |
getSelectableObjectBaseKey()
Returns a key that will be used with BundleUtil to get various descriptions of the selectable objects.
|
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.
|
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.
|
void |
selectObjects(SearchProvider.SelectedObjectsHandler handler)
Instructs the SearchProvider to show a dialog in order to select the objects to search.
|
protected byte[] |
serialize(java.lang.Object resource) |
notifySearchClosed, selectedObjectsToString, toString
public ModuleLibrarySearchProvider(DesignerContext context, java.lang.String name, java.lang.Runnable locateFunc)
public java.lang.String getName()
SearchProvider
public java.util.List<java.lang.Object> getCategories()
SearchProvider
public boolean hasSelectableObjects()
SearchProvider
public void selectObjects(SearchProvider.SelectedObjectsHandler handler)
SearchProvider
protected java.lang.String getSelectableObjectBaseKey()
AbstractSearchProvider
getSelectableObjectBaseKey
in class AbstractSearchProvider
public java.util.Iterator<SearchObject> retrieveSearchableObjects(java.util.Collection<java.lang.Object> categories, java.util.List<java.lang.Object> searchObjects, TaskProgressListener progress)
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).protected byte[] serialize(java.lang.Object resource) throws SerializationException
SerializationException