Package com.inductiveautomation.ignition.designer.findreplace

Interface SearchObject

All Known Implementing Classes:
AbstractActionHandlerSearchObject, AbstractScriptBuilderInfoSearchObject, AbstractScriptSearchProvider.AbstractScriptSearchObject, AbstractScriptSearchProvider.MapIterator.MapEntrySearchObject, AbstractScriptSearchProvider.SimplePropertySO, ClientScriptSearchProvider.MenuNodeScriptSearchObject, CustomFunctionSearchObject, DatasetPropertySearchObject, DefaultSearchObject, DynamicPropertyNameSearchObject, DynamicPropertyValueSearchObject, ExtensionFunctionSearchObject, ScriptBuilderStringArraySearchObject, ScriptBuilderStringListSearchObject, ScriptBuilderStringSearchObject, ScriptSearchObject, StandardPropertySearchObject
public interface SearchObject
A searchable object returned by a search provider. The Search/Replace engine will try to match the pattern against the result of getText, and if successful, will use the other methods of this class to represent the result to the user.

  • 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.
    default 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.
    void
    setText(String value)
    Updates the search result with the new value- the "replace" in "search & replace".

  • Method Details

    • getIcon

      Icon getIcon()
      Returns an icon that can be used to identify this type of result. Should be 16x16 or smaller.

    • getOwnerName

      String getOwnerName()
      The name of the entity where this result is found. Used in the results display to help distinguish similar items.

    • getName

      String getName()
      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

      String getText()
      Gets the text representation of the search result. This is what will be used for the "search".

    • setText

      void setText(String value) throws IllegalArgumentException
      Updates the search result with the new value- the "replace" in "search & replace".
      Throws:
      IllegalArgumentException - If the new text value is not suitable for this search object

    • locate

      void locate()
      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.

    • isMutable

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