public class SFCDesignerHook extends AbstractDesignerModuleHook implements ClientStepRegistryProvider, StepConfigRegistry
Constructor and Description |
---|
SFCDesignerHook() |
Modifier and Type | Method and Description |
---|---|
static SFCDesignerHook |
get(DesignerContext context) |
StepConfigFactory |
getConfigFactory(java.lang.String factoryId) |
MenuBarMerge |
getModuleMenu()
Returns a menu merge for any global menu additions.
|
java.lang.String |
getResourceCategoryKey(Project project,
ProjectResource resource)
Used by modules that add project resources to an Ignition project.
|
ClientStepRegistry |
getStepRegistry() |
SFCWorkspace |
getWorkspace() |
void |
initializeScriptManager(ScriptManager manager)
Initialize a newly-instantiated script manager.
|
boolean |
isSaving() |
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 |
register(java.lang.String stepFactoryId,
StepConfigFactory factory) |
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, getFrames, getModuleToolbars, getResourceDisplayName, getResourceIcon, notifyActivationStateChanged
public static SFCDesignerHook get(DesignerContext context)
public SFCWorkspace getWorkspace()
public void register(java.lang.String stepFactoryId, StepConfigFactory factory)
register
in interface StepConfigRegistry
public StepConfigFactory getConfigFactory(java.lang.String factoryId)
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 shutdown()
DesignerModuleHook
shutdown
in interface DesignerModuleHook
shutdown
in class AbstractDesignerModuleHook
public void notifyProjectSaveStart(SaveContext save)
DesignerModuleHook
notifyProjectSaveStart
in interface DesignerModuleHook
notifyProjectSaveStart
in class AbstractDesignerModuleHook
public void notifyProjectSaveDone()
DesignerModuleHook
notifyProjectSaveDone
in interface DesignerModuleHook
notifyProjectSaveDone
in class AbstractDesignerModuleHook
public boolean isSaving()
public MenuBarMerge getModuleMenu()
DesignerModuleHook
getModuleMenu
in interface DesignerModuleHook
getModuleMenu
in class AbstractDesignerModuleHook
JMenuMerge
public ClientStepRegistry getStepRegistry()
getStepRegistry
in interface ClientStepRegistryProvider
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
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.