Class CustomFunctionSearchObject
java.lang.Object
com.inductiveautomation.factorypmi.designer.search.searchobjects.CustomFunctionSearchObject
- All Implemented Interfaces:
SearchObject
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetIcon()
Returns an icon that can be used to identify this type of result.getName()
The name of the object that matches the search pattern.The name of the entity where this result is found.getText()
Gets the text representation of the search result.void
locate()
Brings focus to the item in the UI in whatever way is appropriate.void
Updates the search result with the new value- the "replace" in "search & replace".Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.inductiveautomation.ignition.designer.findreplace.SearchObject
isMutable
-
Constructor Details
-
CustomFunctionSearchObject
-
-
Method Details
-
getIcon
Description copied from interface:SearchObject
Returns an icon that can be used to identify this type of result. Should be 16x16 or smaller.- Specified by:
getIcon
in interfaceSearchObject
-
getOwnerName
Description copied from interface:SearchObject
The name of the entity where this result is found. Used in the results display to help distinguish similar items.- Specified by:
getOwnerName
in interfaceSearchObject
-
getName
Description copied from interface:SearchObject
The name of the object that matches the search pattern. In other words, a description of the element inside the owner, such as "Name", or "Expression".- Specified by:
getName
in interfaceSearchObject
-
getText
Description copied from interface:SearchObject
Gets the text representation of the search result. This is what will be used for the "search".- Specified by:
getText
in interfaceSearchObject
-
setText
Description copied from interface:SearchObject
Updates the search result with the new value- the "replace" in "search & replace".- Specified by:
setText
in interfaceSearchObject
- Throws:
IllegalArgumentException
- If the new text value is not suitable for this search object
-
locate
public void locate()Description copied from interface:SearchObject
Brings focus to the item in the UI in whatever way is appropriate. Most of the time this will mean bringing up the editor for the object.- Specified by:
locate
in interfaceSearchObject
-