Class AbstractScriptSearchProvider<T>
java.lang.Object
com.inductiveautomation.ignition.designer.findreplace.AbstractSearchProvider
com.inductiveautomation.ignition.designer.scripteditor.AbstractScriptSearchProvider<T>
- All Implemented Interfaces:
SearchProvider
- Direct Known Subclasses:
ScriptConfigSearchProvider, ScriptLibrarySearchProvider
This provider can be instantiated and added multiple times for different script scopes.
Inheriting classes will want to override retrieveSearchableObjects and use Iterators.concat() to
zipper additional results in.
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface SearchProvider
SearchProvider.SelectedObjectsHandler -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedAbstractScriptSearchProvider(DesignerContext context, String name, ResourceType resourceType, Runnable locateFunc) -
Method Summary
Modifier and TypeMethodDescriptionprotected Tdeserialize(Resource resource) Returns a list of "categories", or sub-selectable units, supported by this search provider.protected DesignerContextprotected org.apache.log4j.LoggergetName()Returns the name of the search provider, which will be used in the gateway and a UI to uniquely identify the provider.Returns a key that will be used withBundleUtilto get various descriptions of the selectable objects.protected TbooleanWhether or not the set of objects searched by this provider is selectable- for examples, which groups or windows are to be searched.protected voidprotected voidvoidInstructs the SearchProvider to show a dialog in order to select the objects to search.protected byte[]protected voidMethods inherited from class AbstractSearchProvider
notifySearchClosed, selectedObjectsToString, toStringMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface SearchProvider
addAsyncReplaceListener, getExecutor, getId, retrieveSearchableObjects
-
Constructor Details
-
AbstractScriptSearchProvider
protected AbstractScriptSearchProvider(DesignerContext context, String name, ResourceType resourceType, Runnable locateFunc)
-
-
Method Details
-
getContext
-
getLogger
protected org.apache.log4j.Logger getLogger() -
getTargetObject
-
getCategories
Description copied from interface:SearchProviderReturns a list of "categories", or sub-selectable units, supported by this search provider. The actual objects will be passed back in to retrieveSearchableObjects when the search is executed. -
getName
Description copied from interface:SearchProviderReturns the name of the search provider, which will be used in the gateway and a UI to uniquely identify the provider. It is expected to be in the current session's language. -
getSelectableObjectBaseKey
Description copied from class:AbstractSearchProviderReturns a key that will be used withBundleUtilto get various descriptions of the selectable objects. It is expected that the following keys exist:
'{Key}.One' - "%d object"
'{Key}.Many' - "%d objects"
'{Key}.Default' - what will be searched if no objects are selected. For example, "All groups" or "Default provider"- Specified by:
getSelectableObjectBaseKeyin classAbstractSearchProvider- Returns:
- a
BundleUtilkey corresponding to a description for a selectable object.
-
hasSelectableObjects
public boolean hasSelectableObjects()Description copied from interface:SearchProviderWhether or not the set of objects searched by this provider is selectable- for examples, which groups or windows are to be searched. -
selectObjects
Description copied from interface:SearchProviderInstructs the SearchProvider to show a dialog in order to select the objects to search. The object are returned through the passed in handler, and will later be passed into executeSearch. -
loadTargetObject
protected void loadTargetObject() -
deserialize
-
saveResource
protected void saveResource() -
serialize
- Throws:
SerializationException
-
showEditorWindow
protected void showEditorWindow()
-