Package com.inductiveautomation.factorypmi.designer.search

Class ClientScriptSearchProvider

java.lang.Object

com.inductiveautomation.ignition.designer.findreplace.AbstractSearchProvider

com.inductiveautomation.ignition.designer.scripteditor.AbstractScriptSearchProvider<T>

com.inductiveautomation.ignition.designer.scripteditor.ScriptConfigSearchProvider<ClientScriptConfig>

com.inductiveautomation.factorypmi.designer.search.ClientScriptSearchProvider

All Implemented Interfaces:

SearchProvider

public class ClientScriptSearchProvider
extends ScriptConfigSearchProvider<ClientScriptConfig>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ClientScriptSearchProvider.MenuNodeCursor
protected class	ClientScriptSearchProvider.MenuNodeScriptSearchObject

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.designer.scripteditor.AbstractScriptSearchProvider

AbstractScriptSearchProvider.AbstractScriptSearchObject, AbstractScriptSearchProvider.MapIterator<K>, AbstractScriptSearchProvider.SimplePropertySO

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.designer.findreplace.SearchProvider

SearchProvider.SelectedObjectsHandler

Constructor Summary

Constructors

Constructor	Description
ClientScriptSearchProvider(DesignerContext context, String name, ResourceType resourceType, Runnable locateFunc)

Method Summary

Modifier and Type	Method	Description
Iterator<SearchObject>	retrieveSearchableObjects(Collection<Object> categories, List<Object> searchObjects, TaskProgressListener progress)	Returns an iterator that provides all of the objects described by the parameters.

Methods inherited from class com.inductiveautomation.ignition.designer.scripteditor.AbstractScriptSearchProvider

getCategories, getContext, getLogger, getName, getSelectableObjectBaseKey, getTargetObject, hasSelectableObjects, loadTargetObject, saveResource, selectObjects, serialize, showEditorWindow

Methods inherited from class com.inductiveautomation.ignition.designer.findreplace.AbstractSearchProvider

notifySearchClosed, selectedObjectsToString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.inductiveautomation.ignition.designer.findreplace.SearchProvider

addAsyncReplaceListener, getExecutor, getId

Constructor Details

ClientScriptSearchProvider

public ClientScriptSearchProvider(DesignerContext context,
 String name,
 ResourceType resourceType,
 Runnable locateFunc)

Method Details

retrieveSearchableObjects

public Iterator<SearchObject> retrieveSearchableObjects(Collection<Object> categories,
 List<Object> searchObjects,
 TaskProgressListener progress)

Description copied from interface: SearchProvider

Returns an iterator that provides all of the objects described by the parameters. The iterator will generally stream the results, calculating the next object on each call to hasNext().

The provided ProgressListener can be used to provide progress information as the Iterator is processed. Some providers may not be able to calculate progress, in which case they should call setIndeterminate(true), but the provider implementors are encouraged to provide anything they can, even if it's very coarse.

Specified by:

retrieveSearchableObjects in interface SearchProvider

Overrides:

retrieveSearchableObjects in class ScriptConfigSearchProvider<ClientScriptConfig>

Parameters:

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).