Package com.inductiveautomation.sfc.designer

Class SFCDesignerHook

java.lang.Object

com.inductiveautomation.ignition.designer.model.AbstractDesignerModuleHook

com.inductiveautomation.sfc.designer.SFCDesignerHook

All Implemented Interfaces:

Locatable, LocationRenderingUpdater, DesignerModuleHook, ClientStepRegistryProvider, SfcRpcProvider, StepConfigRegistry

public class SFCDesignerHook
extends AbstractDesignerModuleHook
implements ClientStepRegistryProvider, StepConfigRegistry, Locatable, SfcRpcProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final com.inductiveautomation.ignition.common.script.typing.TypeDescriptor	CHART_SCOPE_DESCRIPTOR
static final Icon	TREE_ICON

Constructor Summary

Constructors

Constructor	Description
SFCDesignerHook()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	createPermissionKeys()	Allows a module to create one or more id-bundlekey pairs that the module will use for role-based client security.
static SFCDesignerHook	get(DesignerContext context)
StepConfigFactory	getConfigFactory(String factoryId)
Icon	getModuleIcon()	Return an appropriate icon to display for this module.
MenuBarMerge	getModuleMenu()	Returns a menu merge for any global menu additions.
String	getResourceCategoryKey(ResourcePath resource)	Used by modules that add project resources to an Ignition project.
String	getResourceDisplayName(ResourcePath resourcePath)	Allows a module to give an appropriate display name for the resource.
Icon	getResourceIcon(ResourcePath resourcePath)	Allows a module to give an appropriate icon for a resource.
SfcRpcFunctions	getRpc()
ClientStepRegistry	getStepRegistry()
SfcWorkspace	getWorkspace()
void	initializeScriptManager(ScriptManager manager)	Initialize a newly-instantiated script manager.
boolean	isSaving()
void	locate(Location location)
void	notifyProjectSaveDone()	Notifies the module that the save operation has finished.
void	notifyProjectSaveStart(SaveContext save)	Notifies the module that the user has requested that the project is saved.
void	register(String stepFactoryId, StepConfigFactory factory)
void	shutdown()	Called when the module is shut down.
void	startup(DesignerContext context, LicenseState activationState)	The main entrypoint for the module hook.
void	updateLocationRenderer(LocationRenderingInfo builder, Location location)	Provides an opportunity for a module to enrich tag reference locations with extra context.

Methods inherited from class com.inductiveautomation.ignition.designer.model.AbstractDesignerModuleHook

configureDeserializer, configureFunctionFactory, configureSerializer, getFrames, getModuleToolbars, getResourceCategoryKey, getResourceDisplayName, getResourceIcon, notifyActivationStateChanged

Methods inherited from class java.lang.Object

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

Field Details

CHART_SCOPE_DESCRIPTOR

public static final com.inductiveautomation.ignition.common.script.typing.TypeDescriptor CHART_SCOPE_DESCRIPTOR

TREE_ICON

public static final Icon TREE_ICON

Constructor Details

SFCDesignerHook

public SFCDesignerHook()

Method Details

get

public static SFCDesignerHook get(DesignerContext context)

getWorkspace

public SfcWorkspace getWorkspace()

register

public void register(String stepFactoryId,
 StepConfigFactory factory)

Specified by:

register in interface StepConfigRegistry

getConfigFactory

public StepConfigFactory getConfigFactory(String factoryId)

startup

public void startup(DesignerContext context,
 LicenseState activationState)

Description copied from interface: DesignerModuleHook

The main entrypoint for the module hook. This will only be called once for a given project. If another project is ever opened, DesignerModuleHook.shutdown() will be called and a new hook will be instantiated

Specified by:

startup in interface DesignerModuleHook

Overrides:

startup in class AbstractDesignerModuleHook

shutdown

public void shutdown()

Description copied from interface: DesignerModuleHook

Called when the module is shut down. This will happen if the user opens a different project within the same designer session - the existing modules will be shut down, and new module hooks will be instantiated and started up.

Specified by:

shutdown in interface DesignerModuleHook

Overrides:

shutdown in class AbstractDesignerModuleHook

getRpc

public SfcRpcFunctions getRpc()

Specified by:

getRpc in interface SfcRpcProvider

notifyProjectSaveStart

public void notifyProjectSaveStart(SaveContext save)
                            throws Exception

Description copied from interface: DesignerModuleHook

Notifies the module that the user has requested that the project is saved. The module must commit any active workspaces. Use the provided SaveContext to report status back to the platform.

This method is guaranteed to be called off the EDT.

Specified by:

notifyProjectSaveStart in interface DesignerModuleHook

Overrides:

notifyProjectSaveStart in class AbstractDesignerModuleHook

Throws:

Exception - Any exception thrown will abort the save operation.

notifyProjectSaveDone

public void notifyProjectSaveDone()

Description copied from interface: DesignerModuleHook

Notifies the module that the save operation has finished.

This method is guaranteed to be called off the EDT.

Specified by:

notifyProjectSaveDone in interface DesignerModuleHook

Overrides:

notifyProjectSaveDone in class AbstractDesignerModuleHook

isSaving

public boolean isSaving()

getModuleMenu

public MenuBarMerge getModuleMenu()

Description copied from interface: DesignerModuleHook

Returns a menu merge for any global menu additions. May be null.

Specified by:

getModuleMenu in interface DesignerModuleHook

Overrides:

getModuleMenu in class AbstractDesignerModuleHook

See Also:

• JMenuMerge

getStepRegistry

public ClientStepRegistry getStepRegistry()

Specified by:

getStepRegistry in interface ClientStepRegistryProvider

initializeScriptManager

public void initializeScriptManager(ScriptManager manager)

Description copied from interface: DesignerModuleHook

Initialize a newly-instantiated script manager. This will be called exactly once for any given ScriptManager instance. Usually this will involve calling ScriptManager.addScriptModule(String, Object), which reflectively loads the public (instance and static) java functions from the given object into the scripting environment, at the provided path.

Specified by:

initializeScriptManager in interface DesignerModuleHook

Overrides:

initializeScriptManager in class AbstractDesignerModuleHook

getResourceCategoryKey

public String getResourceCategoryKey(ResourcePath resource)

Description copied from interface: DesignerModuleHook

Used by modules that add project resources to an Ignition project. This will be called when the platform needs to render your resource type in first-party UI. Only project resources that match this module's ID will passed to this function.

Specified by:

getResourceCategoryKey in interface DesignerModuleHook

Parameters:

resource - A resource path within this module's resources.

Returns:

A bundle resource key for the category of this resource.

getResourceDisplayName

public String getResourceDisplayName(ResourcePath resourcePath)

Description copied from interface: DesignerModuleHook

Allows a module to give an appropriate display name for the resource. For most resources this won't be necessary (the resource's name itself should be used), but for some resources whose name is null, this may be appropriate.

Specified by:

getResourceDisplayName in interface DesignerModuleHook

Returns:

the name for a resource, or null to use the resource's folder path/name.

getModuleIcon

@Nullable
public Icon getModuleIcon()

Description copied from interface: DesignerModuleHook

Return an appropriate icon to display for this module. Ideally, an InteractiveIcon of some kind.

Specified by:

getModuleIcon in interface DesignerModuleHook

See Also:

• InteractiveSvgIcon
• InteractiveVectorIcon
• VectorIcons.getInteractive

getResourceIcon

@Nullable
public Icon getResourceIcon(ResourcePath resourcePath)

Description copied from interface: DesignerModuleHook

Allows a module to give an appropriate icon for a resource.

Specified by:

getResourceIcon in interface DesignerModuleHook

See Also:

• InteractiveSvgIcon
• InteractiveVectorIcon
• VectorIcons.getInteractive

createPermissionKeys

@Nonnull
public Map<String,String> createPermissionKeys()

Description copied from interface: DesignerModuleHook

Allows a module to create one or more id-bundlekey pairs that the module will use for role-based client security.

Specified by:

createPermissionKeys in interface DesignerModuleHook

Overrides:

createPermissionKeys in class AbstractDesignerModuleHook

Returns:

Map of id-bundlekey entries. May be empty but not null.

updateLocationRenderer

public void updateLocationRenderer(@Nonnull
 LocationRenderingInfo builder,
 @Nonnull
 Location location)

Description copied from interface: DesignerModuleHook

Provides an opportunity for a module to enrich tag reference locations with extra context. The location provided is guaranteed to reside within your module. Call methods on LocationRenderingInfo to enrich the rendering.

Specified by:

updateLocationRenderer in interface DesignerModuleHook

Specified by:

updateLocationRenderer in interface LocationRenderingUpdater

See Also:

• LocationRenderingUpdater

locate

public void locate(Location location)

Specified by:

locate in interface Locatable