public class DesignerHook extends AbstractDesignerModuleHook implements AlarmNotificationDesignerInterface
Constructor and Description |
---|
DesignerHook() |
Modifier and Type | Method and Description |
---|---|
static AlarmNotificationDesignerInterface |
get(DesignerContext context) |
java.util.List<PipelineBlockPrototype> |
getPipelineBlockTypes()
Retrieve all registered pipeline blocks
|
java.lang.String |
getResourceCategoryKey(Project project,
ProjectResource resource)
Used by modules that add project resources to an Ignition project.
|
java.lang.String |
getResourceDisplayName(Project project,
ProjectResource resource)
Allows a module to give an appropriate display name for the resource.
|
void |
initializeScriptManager(ScriptManager manager)
Initialize a newly-instantiated script manager.
|
void |
notifyProjectSaveStart(SaveContext save)
Notifies the module that the user has requested that the project is saved.
|
void |
registerPipelineBlock(PipelineBlockPrototype prototype)
Add a new kind of pipeline block to the system.
|
void |
shutdown()
Called when the module is shut down.
|
void |
startup(DesignerContext context,
LicenseState activationState)
The main entrypoint for the module hook.
|
configureDeserializer, configureFunctionFactory, configureSerializer, createPermissionKeys, getFrames, getModuleMenu, getModuleToolbars, getResourceIcon, notifyActivationStateChanged, notifyProjectSaveDone
public static AlarmNotificationDesignerInterface get(DesignerContext context)
public void startup(DesignerContext context, LicenseState activationState) throws java.lang.Exception
DesignerModuleHook
DesignerModuleHook.shutdown()
will be called and a new hook will be instantiatedstartup
in interface DesignerModuleHook
startup
in class AbstractDesignerModuleHook
java.lang.Exception
- if the module was not able to be initialized for the given project.public void notifyProjectSaveStart(SaveContext save)
DesignerModuleHook
notifyProjectSaveStart
in interface DesignerModuleHook
notifyProjectSaveStart
in class AbstractDesignerModuleHook
public void shutdown()
DesignerModuleHook
shutdown
in interface DesignerModuleHook
shutdown
in class AbstractDesignerModuleHook
public void registerPipelineBlock(PipelineBlockPrototype prototype)
AlarmNotificationDesignerInterface
registerPipelineBlock
in interface AlarmNotificationDesignerInterface
public java.util.List<PipelineBlockPrototype> getPipelineBlockTypes()
AlarmNotificationDesignerInterface
getPipelineBlockTypes
in interface AlarmNotificationDesignerInterface
public java.lang.String getResourceCategoryKey(Project project, ProjectResource resource)
DesignerModuleHook
Used by modules that add project resources to an Ignition project. This will be called when the exporter is displaying all of the resources inside a project for export. Only project resources that match this module's ID will passed to this function.
Used by the import/export system.
getResourceCategoryKey
in interface DesignerModuleHook
getResourceCategoryKey
in class AbstractDesignerModuleHook
resource
- A project resource that was added by this module.public java.lang.String getResourceDisplayName(Project project, ProjectResource resource)
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.
Used by the import/export system.
getResourceDisplayName
in interface DesignerModuleHook
getResourceDisplayName
in class AbstractDesignerModuleHook
public void initializeScriptManager(ScriptManager manager)
DesignerModuleHook
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.initializeScriptManager
in interface DesignerModuleHook
initializeScriptManager
in class AbstractDesignerModuleHook