Class ReportingDesignerHook
- java.lang.Object
-
- com.inductiveautomation.ignition.designer.model.AbstractDesignerModuleHook
-
- com.inductiveautomation.reporting.designer.ReportingDesignerHook
-
- All Implemented Interfaces:
DesignerModuleHook
public class ReportingDesignerHook extends AbstractDesignerModuleHook
-
-
Constructor Summary
Constructors Constructor Description ReportingDesignerHook()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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 moduleDesignerDataSourceRegistry
getDataSourceRegistry()
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(ProjectResourceId resource)
Used by modules that add project resources to an Ignition project.javax.swing.Icon
getResourceIcon(ProjectResourceId resource)
Allows a module to give an appropriate icon for a resource.DesignerShapeRegistry
getShapeRegistry()
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.protected void
setupRM14()
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, createPermissionKeys, getResourceDisplayName, notifyActivationStateChanged, notifyProjectSaveDone, shutdown
-
-
-
-
Method Detail
-
startup
public void startup(DesignerContext context, LicenseState activationState) throws java.lang.Exception
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 interfaceDesignerModuleHook
- Overrides:
startup
in classAbstractDesignerModuleHook
- Throws:
java.lang.Exception
- if the module was not able to be initialized for the given project.
-
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 callingScriptManager.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 interfaceDesignerModuleHook
- Overrides:
initializeScriptManager
in classAbstractDesignerModuleHook
-
setupRM14
protected void setupRM14()
-
getDataSourceRegistry
public DesignerDataSourceRegistry getDataSourceRegistry()
-
getShapeRegistry
public DesignerShapeRegistry getShapeRegistry()
-
getResourceCategoryKey
public java.lang.String getResourceCategoryKey(ProjectResourceId resource)
Description copied from interface: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.
- Specified by:
getResourceCategoryKey
in interfaceDesignerModuleHook
- Overrides:
getResourceCategoryKey
in classAbstractDesignerModuleHook
- Parameters:
resource
- A project resource that was added by this module.- Returns:
- A bundle resource key for the category of this resource.
-
getResourceIcon
public javax.swing.Icon getResourceIcon(ProjectResourceId resource)
Description copied from interface:DesignerModuleHook
Allows a module to give an appropriate icon for a resource.
Used by the import/export system.
- Specified by:
getResourceIcon
in interfaceDesignerModuleHook
- Overrides:
getResourceIcon
in classAbstractDesignerModuleHook
-
configureSerializer
public void configureSerializer(XMLSerializer serializer)
Description copied from interface:DesignerModuleHook
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- Specified by:
configureSerializer
in interfaceDesignerModuleHook
- Overrides:
configureSerializer
in classAbstractDesignerModuleHook
-
notifyProjectSaveStart
public void notifyProjectSaveStart(SaveContext save)
Description copied from interface:DesignerModuleHook
Notifies the module that the user has requested that the project is saved. The module must check-in any checked-out resources that it is holding.- Specified by:
notifyProjectSaveStart
in interfaceDesignerModuleHook
- Overrides:
notifyProjectSaveStart
in classAbstractDesignerModuleHook
-
getFrames
@Nonnull public java.util.List<com.jidesoft.docking.DockableFrame> getFrames()
Description copied from interface:DesignerModuleHook
A list of DockableFrames that this module provides, that should be available to all workspaces.- Specified by:
getFrames
in interfaceDesignerModuleHook
- Overrides:
getFrames
in classAbstractDesignerModuleHook
-
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 interfaceDesignerModuleHook
- Overrides:
getModuleMenu
in classAbstractDesignerModuleHook
- See Also:
JMenuMerge
-
getModuleToolbars
@Nonnull public java.util.List<com.jidesoft.action.CommandBar> getModuleToolbars()
Description copied from interface:DesignerModuleHook
Returns the toolbars for the module. May be empty but not null.- Specified by:
getModuleToolbars
in interfaceDesignerModuleHook
- Overrides:
getModuleToolbars
in classAbstractDesignerModuleHook
-
-