Package com.inductiveautomation.ignition.designer.scripteditor.search

Class MessageHandlerScriptSearchObject

java.lang.Object

com.inductiveautomation.ignition.designer.scripteditor.search.AbstractScriptSearchObject

com.inductiveautomation.ignition.designer.scripteditor.search.MessageHandlerScriptSearchObject

All Implemented Interfaces:

SearchObject

public class MessageHandlerScriptSearchObject
extends AbstractScriptSearchObject

Field Summary

Fields inherited from class com.inductiveautomation.ignition.designer.scripteditor.search.AbstractScriptSearchObject

context, resource, workspace

Constructor Summary

Constructors

Constructor	Description
MessageHandlerScriptSearchObject(ResourceWorkspace workspace, DesignerContext context, Resource resource)

Method Summary

Modifier and Type	Method	Description
protected com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor	getDescriptor()
Icon	getIcon()	Returns an icon that can be used to identify this type of result.
String	getOwnerName()	The name of the entity where this result is found.
String	getText()	Gets the text representation of the search result.
protected void	openEditor()	Opens the editor for the resource in the current workspace.
protected void	saveResource()	Saves the resource in the current workspace.
protected void	serializeResource(ResourceBuilder builder)	Serializes the specific resource into the provided ResourceBuilder.
void	setText(String value)	Updates the search result with the new value- the "replace" in "search & replace".

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

getName, 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 Details

MessageHandlerScriptSearchObject

public MessageHandlerScriptSearchObject(ResourceWorkspace workspace,
 DesignerContext context,
 Resource resource)

Method Details

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

Overrides:

getIcon in class AbstractScriptSearchObject

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.

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

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

Throws:

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

openEditor

protected void openEditor()

Description copied from class: AbstractScriptSearchObject

Opens the editor for the resource in the current workspace. Implementations should handle the specific workspace type.

Specified by:

openEditor in class AbstractScriptSearchObject

saveResource

protected void saveResource()

Description copied from class: AbstractScriptSearchObject

Saves the resource in the current workspace. Implementations should manage serialization of the specific resource

Overrides:

saveResource in class AbstractScriptSearchObject

serializeResource

protected void serializeResource(ResourceBuilder builder)

Description copied from class: AbstractScriptSearchObject

Serializes the specific resource into the provided ResourceBuilder. Subclasses should implement this method to apply their resource-specific serialization logic.

Specified by:

serializeResource in class AbstractScriptSearchObject

Parameters:

builder - the ResourceBuilder instance representing the resource to be serialized

getDescriptor

protected com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor getDescriptor()