com.inductiveautomation.factorypmi.designer.search.searchobjects

Class CustomFunctionSearchObject

java.lang.Object

com.inductiveautomation.factorypmi.designer.search.searchobjects.CustomFunctionSearchObject

All Implemented Interfaces:

SearchObject

public class CustomFunctionSearchObject
extends java.lang.Object
implements SearchObject

Constructor Summary

Constructors

Constructor and Description
CustomFunctionSearchObject(CachedComponent comp, CustomFunction function)

Method Summary

Modifier and Type	Method and Description
javax.swing.Icon	getIcon() Returns an icon that can be used to identify this type of result.
java.lang.String	getName() The name of the object that matches the search pattern.
java.lang.String	getOwnerName() The name of the entity where this result is found.
java.lang.String	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	setText(java.lang.String script) 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

Constructor Detail

CustomFunctionSearchObject

public CustomFunctionSearchObject(CachedComponent comp,
                                  CustomFunction function)

Method Detail

getIcon

public javax.swing.Icon 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 interface SearchObject

Returns:

getOwnerName

public java.lang.String 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 interface SearchObject

Returns:

getName

public java.lang.String 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 interface SearchObject

Returns:

getText

public java.lang.String 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 interface SearchObject

Returns:

setText

public void setText(java.lang.String script)
             throws java.lang.IllegalArgumentException

Description copied from interface: SearchObject

Updates the search result with the new value- the "replace" in "search & replace".

Specified by:

setText in interface SearchObject

Throws:

java.lang.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 interface SearchObject