Package com.inductiveautomation.factorypmi.application.script

Class ClientScriptConfig

java.lang.Object

com.inductiveautomation.ignition.common.script.ScriptConfig

com.inductiveautomation.factorypmi.application.script.ClientScriptConfig

public class ClientScriptConfig
extends ScriptConfig

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ClientScriptConfig.KeystrokeScript
static final record	ClientScriptConfig.MenubarScript
static final record	ClientScriptConfig.ShutdownInterceptScript

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.common.script.ScriptConfig

ScriptConfig.MessageHandlerScript, ScriptConfig.ShutdownScript, ScriptConfig.StartupScript, ScriptConfig.TagChangeScriptEvent, ScriptConfig.TimerScript

Field Summary

Fields

Modifier and Type	Field	Description
static final com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor	MESSAGE_DESCRIPTOR
static final ResourceType	MESSAGE_RESOURCE_TYPE
static final ResourceType	RESOURCE_TYPE
static final com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor	SHUTDOWN_DESCRIPTOR
static final ResourceType	SHUTDOWN_RESOURCE_TYPE
static final com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor	STARTUP_DESCRIPTOR
static final ResourceType	STARTUP_RESOURCE_TYPE
static final com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor	TAG_CHANGE_DESCRIPTOR
static final ResourceType	TAG_CHANGE_RESOURCE_TYPE
static final com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor	TIMER_DESCRIPTOR
static final ResourceType	TIMER_RESOURCE_TYPE

Fields inherited from class com.inductiveautomation.ignition.common.script.ScriptConfig

ENABLED_KEY, MESSAGE_SCRIPT_VALUE, messageHandlerScripts, PROJECT_UPDATE_VALUE, SCHEDULED_SCRIPT_VALUE, scheduledScripts, SHUTDOWN_LOCATION_VALUE, shutdownScript, STARTUP_LOCATION_VALUE, startupScript, TAG_CHANGE_VALUE, tagChangeScripts, TIMER_SCRIPT_VALUE, timerScripts, updateScript

Constructor Summary

Constructors

Constructor	Description
ClientScriptConfig()

Method Summary

Modifier and Type	Method	Description
Map<ResourcePath,Consumer<ResourceBuilder>>	collectMigrationScriptMappings()	Collects legacy script configurations (startup, shutdown, tag change, etc.) and maps each to its corresponding ResourcePath and ResourceBuilder.
static MenuNode	createDefaultMenu()
Map<KeystrokeKey,String>	getKeyScripts()
MenuNode	getMenuRoot()
String	getShutdownAllowedScript()
void	setKeyScripts(Map<KeystrokeKey,String> map)
void	setMenuRoot(MenuNode menuRoot)
void	setShutdownAllowedScript(String exitAllowedScript)

Methods inherited from class com.inductiveautomation.ignition.common.script.ScriptConfig

getMessageHandlerScripts, getScheduledScripts, getShutdownScript, getStartupScript, getTagChangeScripts, getTimerScripts, getUpdateScript, setMessageHandlerScripts, setScheduledScripts, setShutdownScript, setStartupScript, setTagChangeScripts, setTagChangeScripts, setTimerScripts, setUpdateScript

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

RESOURCE_TYPE

public static final ResourceType RESOURCE_TYPE

STARTUP_RESOURCE_TYPE

public static final ResourceType STARTUP_RESOURCE_TYPE

SHUTDOWN_RESOURCE_TYPE

public static final ResourceType SHUTDOWN_RESOURCE_TYPE

TIMER_RESOURCE_TYPE

public static final ResourceType TIMER_RESOURCE_TYPE

TAG_CHANGE_RESOURCE_TYPE

public static final ResourceType TAG_CHANGE_RESOURCE_TYPE

MESSAGE_RESOURCE_TYPE

public static final ResourceType MESSAGE_RESOURCE_TYPE

STARTUP_DESCRIPTOR

public static final com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor STARTUP_DESCRIPTOR

SHUTDOWN_DESCRIPTOR

public static final com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor SHUTDOWN_DESCRIPTOR

TIMER_DESCRIPTOR

public static final com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor TIMER_DESCRIPTOR

MESSAGE_DESCRIPTOR

public static final com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor MESSAGE_DESCRIPTOR

TAG_CHANGE_DESCRIPTOR

public static final com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor TAG_CHANGE_DESCRIPTOR

Constructor Details

ClientScriptConfig

public ClientScriptConfig()

Method Details

createDefaultMenu

public static MenuNode createDefaultMenu()

getKeyScripts

public Map<KeystrokeKey,String> getKeyScripts()

setKeyScripts

public void setKeyScripts(Map<KeystrokeKey,String> map)

getMenuRoot

public MenuNode getMenuRoot()

setMenuRoot

public void setMenuRoot(MenuNode menuRoot)

getShutdownAllowedScript

public String getShutdownAllowedScript()

setShutdownAllowedScript

public void setShutdownAllowedScript(String exitAllowedScript)

collectMigrationScriptMappings

public Map<ResourcePath,Consumer<ResourceBuilder>> collectMigrationScriptMappings()

Description copied from class: ScriptConfig

Collects legacy script configurations (startup, shutdown, tag change, etc.) and maps each to its corresponding ResourcePath and ResourceBuilder. The resulting map contains builders to construct and serialize these scripts into resources on disk

Overrides:

collectMigrationScriptMappings in class ScriptConfig