Package com.inductiveautomation.eventstream.designer

Class EventStreamDesignerHook

java.lang.Object

com.inductiveautomation.ignition.designer.model.AbstractDesignerModuleHook

com.inductiveautomation.eventstream.designer.EventStreamDesignerHook

All Implemented Interfaces:

LocationRenderingUpdater, DesignerModuleHook

public class EventStreamDesignerHook
extends AbstractDesignerModuleHook

Constructor Summary

Constructors

Constructor	Description
EventStreamDesignerHook()

Method Summary

Modifier and Type	Method	Description
static EventStreamDesignerHook	get(DesignerContext context)
DesignerEventStreamManager	getEventStreamManager()
EventStreamRpc	getRpc()
void	notifyProjectSaveStart(SaveContext save)	Notifies the module that the user has requested that the project is saved.
void	shutdown()	Called when the module is shut down.
void	startup(DesignerContext context, LicenseState activationState)	The main entrypoint for the module hook.

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

configureDeserializer, configureFunctionFactory, configureSerializer, createPermissionKeys, getFrames, getModuleMenu, getModuleToolbars, getResourceCategoryKey, getResourceDisplayName, getResourceIcon, initializeScriptManager, notifyActivationStateChanged, notifyProjectSaveDone

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.model.DesignerModuleHook

getModuleIcon, getResourceCategoryKey, getResourceDisplayName, getResourceIcon, updateLocationRenderer

Constructor Details

EventStreamDesignerHook

public EventStreamDesignerHook()

Method Details

getEventStreamManager

public DesignerEventStreamManager getEventStreamManager()

getRpc

public EventStreamRpc getRpc()

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

get

public static EventStreamDesignerHook get(DesignerContext context)

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.