Package com.inductiveautomation.ignition.designer.findreplace

Class DefaultSearchObject

java.lang.Object

com.inductiveautomation.ignition.designer.findreplace.DefaultSearchObject

All Implemented Interfaces:

SearchObject

public class DefaultSearchObject
extends Object
implements SearchObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultSearchObject.Builder

Method Summary

Modifier and Type	Method	Description
Icon	getIcon()	Returns an icon that can be used to identify this type of result.
String	getName()	The name of the object that matches the search pattern.
String	getOwnerName()	The name of the entity where this result is found.
String	getText()	Gets the text representation of the search result.
boolean	isMutable()	Whether or not the found object is mutable.
void	locate()	Brings focus to the item in the UI in whatever way is appropriate.
static DefaultSearchObject.Builder	newBuilder()
void	setText(String value)	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

Method Details

newBuilder

public static DefaultSearchObject.Builder newBuilder()

getIcon

public 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

getOwnerName

public 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

getName

public 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

getText

public 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

setText

public void setText(String value)
             throws 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:

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

isMutable

public boolean isMutable()

Description copied from interface: SearchObject

Whether or not the found object is mutable. Used for display purposes, as well as whether or not setText should be called.

Specified by:

isMutable in interface SearchObject