com.inductiveautomation.factorypmi.designer.search

Class ClientScriptSearchProvider.MenuNodeScriptSearchObject

java.lang.Object

com.inductiveautomation.ignition.designer.scripteditor.AbstractScriptSearchProvider.AbstractScriptSearchObject

com.inductiveautomation.factorypmi.designer.search.ClientScriptSearchProvider.MenuNodeScriptSearchObject

All Implemented Interfaces:

SearchObject

Enclosing class:

ClientScriptSearchProvider

protected class ClientScriptSearchProvider.MenuNodeScriptSearchObject
extends AbstractScriptSearchProvider.AbstractScriptSearchObject

Constructor Summary

Constructors

Constructor and Description
MenuNodeScriptSearchObject(java.lang.String parentPath, MenuNode node)

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.
MenuNode	getNode()
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	setText(java.lang.String value) Updates the search result with the new value- the "replace" in "search & replace".

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

locate

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 Detail

MenuNodeScriptSearchObject

public MenuNodeScriptSearchObject(java.lang.String parentPath,
                                  MenuNode node)

Method Detail

getNode

public MenuNode getNode()

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.

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

Overrides:

getOwnerName in class AbstractScriptSearchProvider.AbstractScriptSearchObject

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

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

setText

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

Description copied from interface: SearchObject

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

Throws:

java.lang.IllegalArgumentException - If the new text value is not suitable for this search object