public interface DesignerModuleHook
<hook scope="D">com.example.module.designer.SuperHookClass</hook>
Best practice: Instead of implementing this interface directly, subclass your hook class from
AbstractDesignerModuleHook
instead.
Modifier and Type | Method and Description |
---|---|
void |
configureDeserializer(XMLDeserializer deserializer) |
void |
configureFunctionFactory(ExpressionFunctionManager factory)
Provides the module with an opportunity to define its own expression functions
|
void |
configureSerializer(XMLSerializer serializer)
Provides the module a chance to add serialization delegates to the serializer custom for classes that might be
encountered when serializing objects provided by this module
|
java.util.Map<java.lang.String,java.lang.String> |
createPermissionKeys()
Allows a module to create one or more id-bundlekey pairs that the module will use for role-based client
security.
|
java.util.List<com.jidesoft.docking.DockableFrame> |
getFrames()
A list of DockableFrames that this module provides, that should be available to all workspaces.
|
MenuBarMerge |
getModuleMenu()
Returns a menu merge for any global menu additions.
|
java.util.List<com.jidesoft.action.CommandBar> |
getModuleToolbars()
Returns the toolbars for the module.
|
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.
|
javax.swing.Icon |
getResourceIcon(Project project,
ProjectResource resource)
Allows a module to give an appropriate icon for a resource.
|
void |
initializeScriptManager(ScriptManager manager)
Initialize a newly-instantiated script manager.
|
void |
notifyActivationStateChanged(LicenseState licenseState)
Notifies this designer module that its license state has changed.
|
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 |
shutdown()
Called when the module is shut down.
|
void |
startup(DesignerContext context,
LicenseState activationState)
The main entrypoint for the module hook.
|
void startup(DesignerContext context, LicenseState activationState) throws java.lang.Exception
shutdown()
will be called and a new hook will be instantiatedjava.lang.Exception
- if the module was not able to be initialized for the given project.void shutdown()
MenuBarMerge getModuleMenu()
JMenuMerge
java.util.List<com.jidesoft.action.CommandBar> getModuleToolbars()
java.util.List<com.jidesoft.docking.DockableFrame> getFrames()
void notifyActivationStateChanged(LicenseState licenseState)
void configureSerializer(XMLSerializer serializer)
void configureDeserializer(XMLDeserializer deserializer)
void configureFunctionFactory(ExpressionFunctionManager factory)
void notifyProjectSaveStart(SaveContext save)
void notifyProjectSaveDone()
void initializeScriptManager(ScriptManager manager)
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.java.lang.String getResourceCategoryKey(Project project, ProjectResource resource)
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.
resource
- A project resource that was added by this module.java.lang.String getResourceDisplayName(Project project, ProjectResource resource)
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.
javax.swing.Icon getResourceIcon(Project project, ProjectResource resource)
Allows a module to give an appropriate icon for a resource.
Used by the import/export system.
java.util.Map<java.lang.String,java.lang.String> createPermissionKeys()