Package com.inductiveautomation.ignition.designer.findreplace

Class AbstractSearchProvider

java.lang.Object

com.inductiveautomation.ignition.designer.findreplace.AbstractSearchProvider

All Implemented Interfaces:

SearchProvider

Direct Known Subclasses:

AbstractScriptSearchProvider, ModuleLibrarySearchProvider, NamedQuerySearchProvider, StylesSearchProvider, TagSearchProvider, ViewSearchProvider

public abstract class AbstractSearchProvider
extends Object
implements SearchProvider

Nested Class Summary

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

SearchProvider.SelectedObjectsHandler

Constructor Summary

Constructors

Constructor	Description
AbstractSearchProvider()

Method Summary

Modifier and Type	Method	Description
protected abstract String	getSelectableObjectBaseKey()	Returns a key that will be used with BundleUtil to get various descriptions of the selectable objects.
void	notifySearchClosed()	Called when the search dialog box is closed, so that the search provider can release any cached resources
String	selectedObjectsToString(List<Object> selectedObjects)	Formats the list of selected objects as a brief string.
String	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, getCategories, getExecutor, getId, getName, hasSelectableObjects, retrieveSearchableObjects, selectObjects

Constructor Details

AbstractSearchProvider

public AbstractSearchProvider()

Method Details

selectedObjectsToString

public String selectedObjectsToString(List<Object> selectedObjects)

Description copied from interface: SearchProvider

Formats the list of selected objects as a brief string.

Specified by:

selectedObjectsToString in interface SearchProvider

getSelectableObjectBaseKey

protected abstract String getSelectableObjectBaseKey()

Returns a key that will be used with BundleUtil to 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"

Returns:

a BundleUtil key corresponding to a description for a selectable object.

notifySearchClosed

public void notifySearchClosed()

Description copied from interface: SearchProvider

Called when the search dialog box is closed, so that the search provider can release any cached resources

Specified by:

notifySearchClosed in interface SearchProvider

toString

public String toString()

Overrides:

toString in class Object