public abstract class AbstractDesignerModuleHook extends java.lang.Object implements DesignerModuleHook
Base class for all designer module hook implementations. All methods are given empty implementations. It is expected that subclasses will override any methods that they wish to give real implementations.
Best practice is to subclass this class rather than implement DesignerModuleHook
directly, so that when new
methods get added to the interface, your module automatically inherits an empty implementation of the new method
rather than breaking with a NoSuchMethodError
.
Constructor and Description |
---|
AbstractDesignerModuleHook() |
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.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 it's 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.
|
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
java.lang.Exception
- if the module was not able to be initialized for the given project.public void shutdown()
DesignerModuleHook
shutdown
in interface DesignerModuleHook
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
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
public javax.swing.Icon getResourceIcon(Project project, ProjectResource resource)
DesignerModuleHook
Allows a module to give an appropriate icon for a resource.
Used by the import/export system.
getResourceIcon
in interface DesignerModuleHook
public MenuBarMerge getModuleMenu()
DesignerModuleHook
getModuleMenu
in interface DesignerModuleHook
JMenuMerge
public java.util.List<com.jidesoft.action.CommandBar> getModuleToolbars()
DesignerModuleHook
getModuleToolbars
in interface DesignerModuleHook
public java.util.List<com.jidesoft.docking.DockableFrame> getFrames()
DesignerModuleHook
getFrames
in interface DesignerModuleHook
public void notifyActivationStateChanged(LicenseState licenseState)
DesignerModuleHook
notifyActivationStateChanged
in interface DesignerModuleHook
public void configureSerializer(XMLSerializer serializer)
DesignerModuleHook
configureSerializer
in interface DesignerModuleHook
public void configureDeserializer(XMLDeserializer deserializer)
configureDeserializer
in interface DesignerModuleHook
public void configureFunctionFactory(ExpressionFunctionManager factory)
DesignerModuleHook
configureFunctionFactory
in interface DesignerModuleHook
public void notifyProjectSaveStart(SaveContext save)
DesignerModuleHook
notifyProjectSaveStart
in interface DesignerModuleHook
public void notifyProjectSaveDone()
DesignerModuleHook
notifyProjectSaveDone
in interface DesignerModuleHook
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