public class ReportingDesignerHook extends AbstractDesignerModuleHook
Constructor and Description |
---|
ReportingDesignerHook() |
Modifier and Type | Method and Description |
---|---|
void |
configureDeserializer(XMLDeserializer deserializer) |
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
|
DesignerDataSourceRegistry |
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(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.
|
DesignerShapeRegistry |
getShapeRegistry() |
void |
initializeScriptManager(ScriptManager manager)
Initialize a newly-instantiated script manager.
|
void |
notifyActivationStateChanged(LicenseState activationState)
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.
|
protected void |
setupRM14() |
void |
shutdown()
Called when the module is shut down.
|
void |
startup(DesignerContext context,
LicenseState activationState)
The main entrypoint for the module hook.
|
configureFunctionFactory
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 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
protected void setupRM14()
public DesignerDataSourceRegistry getDataSourceRegistry()
public DesignerShapeRegistry getShapeRegistry()
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 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
getResourceIcon
in class AbstractDesignerModuleHook
public void configureSerializer(XMLSerializer serializer)
DesignerModuleHook
configureSerializer
in interface DesignerModuleHook
configureSerializer
in class AbstractDesignerModuleHook
public void configureDeserializer(XMLDeserializer deserializer)
configureDeserializer
in interface DesignerModuleHook
configureDeserializer
in class AbstractDesignerModuleHook
public void notifyProjectSaveStart(SaveContext save)
DesignerModuleHook
notifyProjectSaveStart
in interface DesignerModuleHook
notifyProjectSaveStart
in class AbstractDesignerModuleHook
public java.util.List<com.jidesoft.docking.DockableFrame> getFrames()
DesignerModuleHook
getFrames
in interface DesignerModuleHook
getFrames
in class AbstractDesignerModuleHook
public MenuBarMerge getModuleMenu()
DesignerModuleHook
getModuleMenu
in interface DesignerModuleHook
getModuleMenu
in class AbstractDesignerModuleHook
JMenuMerge
public java.util.List<com.jidesoft.action.CommandBar> getModuleToolbars()
DesignerModuleHook
getModuleToolbars
in interface DesignerModuleHook
getModuleToolbars
in class AbstractDesignerModuleHook
public void notifyActivationStateChanged(LicenseState activationState)
DesignerModuleHook
notifyActivationStateChanged
in interface DesignerModuleHook
notifyActivationStateChanged
in class AbstractDesignerModuleHook
public void notifyProjectSaveDone()
DesignerModuleHook
notifyProjectSaveDone
in interface DesignerModuleHook
notifyProjectSaveDone
in class AbstractDesignerModuleHook
public void shutdown()
DesignerModuleHook
shutdown
in interface DesignerModuleHook
shutdown
in class AbstractDesignerModuleHook