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

Class AbstractScriptSearchObject

java.lang.Object

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

All Implemented Interfaces:

SearchObject

Direct Known Subclasses:

AccelerometerScriptSearchObject, AuthChallengeScriptSearchObject, BarcodeScriptSearchObject, BluetoothScriptSearchObject, FormSubmissionHandlerScriptSearchObject, KeyEventScriptSearchObject, KeystrokeScriptSearchObject, MessageHandlerScriptSearchObject, NfcScanScriptSearchObject, PageStartupScriptSearchObject, ScheduledScriptSearchObject, ShutdownInterceptSearchObject, ShutdownScriptSearchObject, StartupScriptSearchObject, TagChangeScriptSearchObject, TimerScriptSearchObject, UpdateScriptSearchObject

public abstract class AbstractScriptSearchObject
extends Object
implements SearchObject

Abstract base class for search objects that provide functionality for locating and managing event scripts saved as resources within the designer context. This class offers common methods and properties for handling these scripts.

Field Summary

Fields

Modifier and Type	Field	Description
protected final DesignerContext	context
protected final Resource	resource
protected final ResourceWorkspace	workspace

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractScriptSearchObject(ResourceWorkspace workspace, DesignerContext context, Resource resource)

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.
void	locate()	Brings focus to the item in the UI in whatever way is appropriate.
protected abstract void	openEditor()	Opens the editor for the resource in the current workspace.
protected void	saveResource()	Saves the resource in the current workspace.
protected abstract void	serializeResource(ResourceBuilder builder)	Serializes the specific resource into the provided ResourceBuilder.

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

getOwnerName, getText, isMutable, setText

Field Details

context

protected final DesignerContext context

workspace

protected final ResourceWorkspace workspace

resource

protected final Resource resource

Constructor Details

AbstractScriptSearchObject

protected AbstractScriptSearchObject(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

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

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

openEditor

protected abstract void openEditor()

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

saveResource

protected void saveResource()

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

serializeResource

protected abstract void serializeResource(ResourceBuilder builder)

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

Parameters:

builder - the ResourceBuilder instance representing the resource to be serialized