Package com.inductiveautomation.factorypmi.designer.model

Class VisionDesignerImpl

java.lang.Object

com.inductiveautomation.ignition.designer.model.AbstractDesignerModuleHook

com.inductiveautomation.factorypmi.designer.model.VisionDesignerImpl

All Implemented Interfaces:

DesignerModuleHook, VisionClientInterface, VisionDesignerInterface

public class VisionDesignerImpl
extends AbstractDesignerModuleHook
implements VisionDesignerInterface

This is the core of the Vision module, implementing both DesignerModuleHook and VisionDesignerInterface. Most of the heavy lifting is actually done in the WindowWorkspace class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	VisionDesignerImpl.Handler

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MODULE_ID

Fields inherited from interface com.inductiveautomation.vision.api.client.VisionClientInterface

VISION_MODULE_ID

Constructor Summary

Constructors

Constructor	Description
VisionDesignerImpl()

Method Summary

Modifier and Type	Method	Description
void	addDesignableProjectListener()
void	addExtensibleBindingType(BindingType binding)	Adds a new binding type to be used in the extensible binding system
void	addNewTemplate(ResourcePath parentFolder, int width, int height)
void	addNewTemplate(ResourcePath parentFolder, int width, int height, Consumer<ResourcePath> onAfter)
void	addNewTemplate(ResourcePath parentFolder, VisionTemplate template)
void	addNewTemplate(ResourcePath parentFolder, VisionTemplate template, Consumer<ResourcePath> onFinished)
void	addNewWindow(ResourcePath parentFolder, int width, int height, Consumer<ResourcePath> onAfter)	Adds a new window to the FPMIApp being designed
void	addNewWindow(ResourcePath parentFolder, FPMIWindow newWindow)
void	addNewWindow(ResourcePath parentFolder, FPMIWindow newWindow, Consumer<ResourcePath> onFinished)	Adds a new window to the FHMIApp being designed
void	addWindowDropHandler(WindowDropHandler handler)	Add a new drop handler for custom drop types onto windows and templates
void	addWindowListener(VisionWindowListener listener)	Adds a listener to be notified when windows are opened and closed.
Component	cloneComponent(Component comp)
boolean	configureBinding(Component component, String property, BindingConfiguration configuration)	Configures a new property binding for the component.property using the given configuration.
void	configureDeserializer(XMLDeserializer deserializer)
void	configureSerializer(XMLSerializer s)	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
FPMIWindow	createNewDockedWindow(int width, int height, int side)
FPMIWindow	createNewMainWindow()
FPMIWindow	createNewPopupWindow()
BindingType	getBindingType(String bindingTypeKey)
ClientScriptEditor	getClientEventScriptEditor()
DesignerPrefs	getCurrentPrefs()
DesignerContext	getDesignerContext()
Collection<BindingType>	getExtensibleBindings()
List<com.jidesoft.docking.DockableFrame>	getFrames()	A list of DockableFrames that this module provides, that should be available to all workspaces.
WindowUtilities	getGuiUtil()
WindowUtilities	getGuiUtil(String desktopHandle)	Gets the WindowUtilities for a secondary desktop, by handle
VisionDesignerImpl.Handler	getHandler()
MenuBarMerge	getMenu()
MenuBarMerge	getModuleMenu()	Returns a menu merge for any global menu additions.
List<com.jidesoft.action.CommandBar>	getModuleToolbars()	Returns the toolbars for the module.
NavUtilities	getNavUtil()	Gets the NavUtilities (for the primary desktop
NavUtilities	getNavUtil(String desktopHandle)	Gets the NavUtilities for a secondary desktop, by handle
PaletteImpl	getPalette()
DesignableProject	getProject()
String	getResourceCategoryKey(ProjectResourceId resource)	Used by modules that add project resources to an Ignition project.
String	getResourceDisplayName(ProjectResourceId resource)	Allows a module to give an appropriate display name for the resource.
SerializationEncoding	getResourceEncoding()
Icon	getResourceIcon(ProjectResourceId resource)	Allows a module to give an appropriate icon for a resource.
String[]	getRoles(Component owner)
FPMIApp	getRoot()
WindowFolderNode	getRootFolderNode()
ResourcePath	getSelectedTemplateFolder()
ResourcePath	getSelectedWindowFolder()	Returns the id of the currently selected window folder in the project browser tree.
ResourceDescriptor	getTemplateResourceDescriptor()
List<WindowDropHandler>	getWindowDropHandlers()
ResourceDescriptor	getWindowResourceDescriptor()
WindowWorkspace	getWorkspace()
protected void	initSearchProviders()
void	newDockedWindow(ResourcePath parentFolder)
void	newDockedWindow(ResourcePath parentFolder, Consumer<ResourcePath> onFinished)
void	newMainWindow(ResourcePath folder)
void	newMainWindow(ResourcePath folder, Consumer<ResourcePath> onFinished)
void	newPopupWindow(ResourcePath parentFolder)
void	newPopupWindow(ResourcePath parentFolder, Consumer<ResourcePath> onFinished)
void	notifyActivationStateChanged(LicenseState licenseState)	Notifies this designer module that its license state has changed.
void	notifyDesignableContainerClosed(ResourcePath path)
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	openBindingDialog(Component component, String propertyName)	Opens the binding dialog for a given component.
void	removeDesignableProjectListener()
void	removeWindowDropHandler(WindowDropHandler handler)	Removes a drop handler for custom drop types onto windows and templates
void	removeWindowListener(VisionWindowListener listiner)	Removes window listener
byte[]	serializeProjectResource(Object obj)	Serializes an object to be stored in a ProjectResource.
byte[]	serializeProjectResource(Object obj, SerializationEncoding encoding)	Serializes an object to be stored in a ProjectResource.
void	setContext(DesignerContext context)
void	setWorkspace(WindowWorkspace workspace)
void	shutdown()	Called when the module is shut down.
void	startup(DesignerContext designerContext, LicenseState activationState)	The main entrypoint for the module hook.
Consumer<ProjectResourceBuilder>	windowResourceBuilder(FPMIWindow newWindow, boolean openOnStartIfFirst)

Methods inherited from class com.inductiveautomation.ignition.designer.model.AbstractDesignerModuleHook

configureFunctionFactory, createPermissionKeys, initializeScriptManager

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MODULE_ID

public static final String MODULE_ID

See Also:

• Constant Field Values

Constructor Details

VisionDesignerImpl

public VisionDesignerImpl()

Method Details

startup

public void startup(DesignerContext designerContext,
 LicenseState activationState)
             throws 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 interface DesignerModuleHook

Overrides:

startup in class AbstractDesignerModuleHook

Throws:

Exception - if the module was not able to be initialized for the given project.

shutdown

public void shutdown()

Description copied from interface: DesignerModuleHook

Called when the module is shut down. This will happen if the user opens a different project within the same designer session - the existing modules will be shut down, and new module hooks will be instantiated and started up.

Specified by:

shutdown in interface DesignerModuleHook

Overrides:

shutdown in class AbstractDesignerModuleHook

addDesignableProjectListener

public void addDesignableProjectListener()

removeDesignableProjectListener

public void removeDesignableProjectListener()

addWindowDropHandler

public void addWindowDropHandler(WindowDropHandler handler)

Description copied from interface: VisionDesignerInterface

Add a new drop handler for custom drop types onto windows and templates

Specified by:

addWindowDropHandler in interface VisionDesignerInterface

removeWindowDropHandler

public void removeWindowDropHandler(WindowDropHandler handler)

Description copied from interface: VisionDesignerInterface

Removes a drop handler for custom drop types onto windows and templates

Specified by:

removeWindowDropHandler in interface VisionDesignerInterface

getWindowDropHandlers

public List<WindowDropHandler> getWindowDropHandlers()

getResourceCategoryKey

public 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 interface DesignerModuleHook

Overrides:

getResourceCategoryKey in class AbstractDesignerModuleHook

Parameters:

resource - A project resource that was added by this module.

Returns:

A bundle resource key for the category of this resource.

getResourceDisplayName

public String getResourceDisplayName(ProjectResourceId resource)

Description copied from interface: 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.

Specified by:

getResourceDisplayName in interface DesignerModuleHook

Overrides:

getResourceDisplayName in class AbstractDesignerModuleHook

Returns:

the name for a resource, or null to use the resource's folder path/name.

getResourceIcon

public 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 interface DesignerModuleHook

Overrides:

getResourceIcon in class AbstractDesignerModuleHook

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 interface DesignerModuleHook

Overrides:

getModuleMenu in class AbstractDesignerModuleHook

See Also:

• JMenuMerge

getMenu

public MenuBarMerge getMenu()

Returns:

the MenuBarMerge specific to the vision workspace

getModuleToolbars

@Nonnull
public 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 interface DesignerModuleHook

Overrides:

getModuleToolbars in class AbstractDesignerModuleHook

getFrames

@Nonnull
public 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 interface DesignerModuleHook

Overrides:

getFrames in class AbstractDesignerModuleHook

notifyActivationStateChanged

public void notifyActivationStateChanged(LicenseState licenseState)

Description copied from interface: DesignerModuleHook

Notifies this designer module that its license state has changed. This could mean that the trial mode has expired (or been reset), the module has been activated, etc.

Specified by:

notifyActivationStateChanged in interface DesignerModuleHook

Overrides:

notifyActivationStateChanged in class AbstractDesignerModuleHook

addWindowListener

public void addWindowListener(VisionWindowListener listener)

Description copied from interface: VisionClientInterface

Adds a listener to be notified when windows are opened and closed. Only works during runtime, not designer

Specified by:

addWindowListener in interface VisionClientInterface

removeWindowListener

public void removeWindowListener(VisionWindowListener listiner)

Description copied from interface: VisionClientInterface

Removes window listener

Specified by:

removeWindowListener in interface VisionClientInterface

configureSerializer

public void configureSerializer(XMLSerializer s)

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 interface DesignerModuleHook

Overrides:

configureSerializer in class AbstractDesignerModuleHook

configureDeserializer

public void configureDeserializer(XMLDeserializer deserializer)

Specified by:

configureDeserializer in interface DesignerModuleHook

Overrides:

configureDeserializer in class AbstractDesignerModuleHook

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 interface DesignerModuleHook

Overrides:

notifyProjectSaveStart in class AbstractDesignerModuleHook

notifyProjectSaveDone

public void notifyProjectSaveDone()

Description copied from interface: DesignerModuleHook

Notifies the module that the save operation has finished. This is the cue to check-out any previously checked-out resources that it was forced to check-in before the save.

Specified by:

notifyProjectSaveDone in interface DesignerModuleHook

Overrides:

notifyProjectSaveDone in class AbstractDesignerModuleHook

initSearchProviders

protected void initSearchProviders()

notifyDesignableContainerClosed

public void notifyDesignableContainerClosed(ResourcePath path)

setContext

public void setContext(DesignerContext context)

getProject

public DesignableProject getProject()

getRoot

public FPMIApp getRoot()

getHandler

public VisionDesignerImpl.Handler getHandler()

getClientEventScriptEditor

public ClientScriptEditor getClientEventScriptEditor()

addNewTemplate

public void addNewTemplate(ResourcePath parentFolder,
 int width,
 int height)

addNewTemplate

public void addNewTemplate(ResourcePath parentFolder,
 int width,
 int height,
 Consumer<ResourcePath> onAfter)

addNewTemplate

public void addNewTemplate(ResourcePath parentFolder,
 VisionTemplate template)

addNewTemplate

public void addNewTemplate(ResourcePath parentFolder,
 VisionTemplate template,
 Consumer<ResourcePath> onFinished)

newMainWindow

public void newMainWindow(ResourcePath folder)

newMainWindow

public void newMainWindow(ResourcePath folder,
 Consumer<ResourcePath> onFinished)

createNewMainWindow

public FPMIWindow createNewMainWindow()

createNewDockedWindow

public FPMIWindow createNewDockedWindow(int width,
 int height,
 int side)

newDockedWindow

public void newDockedWindow(ResourcePath parentFolder)

newDockedWindow

public void newDockedWindow(ResourcePath parentFolder,
 Consumer<ResourcePath> onFinished)

createNewPopupWindow

public FPMIWindow createNewPopupWindow()

newPopupWindow

public void newPopupWindow(ResourcePath parentFolder)

newPopupWindow

public void newPopupWindow(ResourcePath parentFolder,
 Consumer<ResourcePath> onFinished)

addNewWindow

public void addNewWindow(ResourcePath parentFolder,
 FPMIWindow newWindow)

windowResourceBuilder

public Consumer<ProjectResourceBuilder> windowResourceBuilder(FPMIWindow newWindow,
 boolean openOnStartIfFirst)

addNewWindow

public void addNewWindow(ResourcePath parentFolder,
 FPMIWindow newWindow,
 Consumer<ResourcePath> onFinished)

Adds a new window to the FHMIApp being designed

getSelectedWindowFolder

public ResourcePath getSelectedWindowFolder()

Returns the id of the currently selected window folder in the project browser tree.

getSelectedTemplateFolder

public ResourcePath getSelectedTemplateFolder()

getRootFolderNode

public WindowFolderNode getRootFolderNode()

getResourceEncoding

public SerializationEncoding getResourceEncoding()

serializeProjectResource

public byte[] serializeProjectResource(Object obj)
                                throws SerializationException

Serializes an object to be stored in a ProjectResource. Serialized code is stored using SerializationEncoding.BINARY. It is usually preferable to use serializeProjectResource(Object, SerializationEncoding) if the resource supports more than the binary format.

Throws:

SerializationException

serializeProjectResource

public byte[] serializeProjectResource(Object obj,
 SerializationEncoding encoding)
                                throws SerializationException

Serializes an object to be stored in a ProjectResource. Serialized code is stored based on the current SerializationEncoding for the vision project.

Throws:

SerializationException

addExtensibleBindingType

public void addExtensibleBindingType(BindingType binding)

Description copied from interface: VisionClientInterface

Adds a new binding type to be used in the extensible binding system

Specified by:

addExtensibleBindingType in interface VisionClientInterface

getBindingType

public BindingType getBindingType(String bindingTypeKey)

Specified by:

getBindingType in interface VisionClientInterface

getNavUtil

public NavUtilities getNavUtil()

Description copied from interface: VisionClientInterface

Gets the NavUtilities (for the primary desktop

Specified by:

getNavUtil in interface VisionClientInterface

getNavUtil

public NavUtilities getNavUtil(String desktopHandle)

Description copied from interface: VisionClientInterface

Gets the NavUtilities for a secondary desktop, by handle

Specified by:

getNavUtil in interface VisionClientInterface

getGuiUtil

public WindowUtilities getGuiUtil()

Specified by:

getGuiUtil in interface VisionClientInterface

getGuiUtil

public WindowUtilities getGuiUtil(String desktopHandle)

Description copied from interface: VisionClientInterface

Gets the WindowUtilities for a secondary desktop, by handle

Specified by:

getGuiUtil in interface VisionClientInterface

getExtensibleBindings

public Collection<BindingType> getExtensibleBindings()

getPalette

public PaletteImpl getPalette()

Specified by:

getPalette in interface VisionDesignerInterface

addNewWindow

public void addNewWindow(ResourcePath parentFolder,
 int width,
 int height,
 Consumer<ResourcePath> onAfter)

Description copied from interface: VisionDesignerInterface

Adds a new window to the FPMIApp being designed

Specified by:

addNewWindow in interface VisionDesignerInterface

cloneComponent

public Component cloneComponent(Component comp)

Specified by:

cloneComponent in interface VisionDesignerInterface

getCurrentPrefs

public DesignerPrefs getCurrentPrefs()

Specified by:

getCurrentPrefs in interface VisionDesignerInterface

getWorkspace

public WindowWorkspace getWorkspace()

Specified by:

getWorkspace in interface VisionDesignerInterface

setWorkspace

public void setWorkspace(WindowWorkspace workspace)

getDesignerContext

public DesignerContext getDesignerContext()

Specified by:

getDesignerContext in interface VisionDesignerInterface

openBindingDialog

public void openBindingDialog(Component component,
 String propertyName)
                       throws NotBindableException

Description copied from interface: VisionDesignerInterface

Opens the binding dialog for a given component. The component should be on a window that is currently open for design

Specified by:

openBindingDialog in interface VisionDesignerInterface

Throws:

NotBindableException

configureBinding

public boolean configureBinding(Component component,
 String property,
 BindingConfiguration configuration)
                         throws Exception

Description copied from interface: VisionDesignerInterface

Configures a new property binding for the component.property using the given configuration. The binding type is defined by the configuration's BindingConfiguration.getBindingType()

Specified by:

configureBinding in interface VisionDesignerInterface

Throws:

Exception

getRoles

public String[] getRoles(@Nullable
 Component owner)
                  throws GatewayException

Throws:

GatewayException

getWindowResourceDescriptor

public ResourceDescriptor getWindowResourceDescriptor()

getTemplateResourceDescriptor

public ResourceDescriptor getTemplateResourceDescriptor()