Package com.inductiveautomation.factorypmi.application.runtime

Class ClientContextImpl

java.lang.Object

com.inductiveautomation.ignition.client.model.AbstractClientContext

com.inductiveautomation.factorypmi.application.runtime.ClientContextImpl

All Implemented Interfaces:

ClientContext, CommonContext, VisionClientInterface

public class ClientContextImpl
extends AbstractClientContext
implements VisionClientInterface

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.client.model.AbstractClientContext

AbstractClientContext.ClientContextResourceListener

Field Summary

Fields inherited from class com.inductiveautomation.ignition.client.model.AbstractClientContext

changeSupport, globalProps, log, loggingManager, project, projectDescription, projectTitle

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

VISION_MODULE_ID

Method Summary

Modifier and Type	Method	Description
void	addExtensibleBindingType(BindingType binding)	Adds a new binding type to be used in the extensible binding system
void	addWindowListener(VisionWindowListener listener)	Adds a listener to be notified when windows are opened and closed.
static void	configureClassNameResolver(ClassNameResolver r)
static void	configureDeserializer(XMLDeserializer d)
XMLDeserializer	createDeserializer()	Returns an instance of the XMLDeserializer that can be used to deserialize project resources.
protected FunctionFactory	createExpressionFunctionFactory()
java.lang.Object	deserialize(byte[] data, org.apache.log4j.Logger log)	Convenience function to deserialize a gzipped byte array into a single object.
BindingType	getBindingType(java.lang.String bindingTypeKey)
ExecutionManager	getExecutionManager()	Returns the shared task execution manager for this client
GeneralProps	getGeneralProps()
WindowUtilities	getGuiUtil()
WindowUtilities	getGuiUtil(java.lang.String desktopHandle)	Gets the WindowUtilities for a secondary desktop, by handle
LaunchProps	getLaunchProps()
LicenseState	getLicenseState(java.lang.String moduleId)	Returns the license state for the given module
ClientLocalizationManager	getLocalizationManager()
LoginProps	getLoginProps()
java.lang.Object	getModule(java.lang.String id)	Returns the hook class for another module, used for modules that deal with each other's models.
java.util.List<ModuleInfo>	getModules()	Retrieve the list of all modules currently loaded in this context
NamedQueryManager	getNamedQueryManager()	Returns the appropriate named query rpc for the context.
NavUtilities	getNavUtil()	Gets the NavUtilities (for the primary desktop
NavUtilities	getNavUtil(java.lang.String desktopHandle)	Gets the NavUtilities for a secondary desktop, by handle
RuntimeProject	getProject()	Returns the project that this client is running.
javax.swing.RootPaneContainer	getRootPaneContainer()	Returns the RootPaneContainer that is currently the owner of the client
ScriptManager	getScriptManager()	Returns the ScriptManager that can be used to execute Python scripts.
ClientTagManager	getTagManager()	Returns the manager that provides access to Ignition's tag system.
UIProps	getUiProps()
void	loadModules(java.util.List<ModuleInfo> modules)	Create LoadedModule objects to represent each client-scoped module in the list.
protected ProjectResourceListener	newProjectResourceListener()	Make a custom resource listener so we can keep track of some Vision-specific resources
void	receiveVisionWindowEvent(VisionWindowEvent event)	Listens to the event bus for vision window evens to push all window open/close events to any modules that have registered VisionWindowListener objects.
void	removeWindowListener(VisionWindowListener listener)	Removes window listener
void	setApp(FPMIApp app)
void	setLocalizationManager(ClientLocalizationManager mgr)
void	setProject(Project project)
void	shutdown()
void	startup()

Methods inherited from class com.inductiveautomation.ignition.client.model.AbstractClientContext

addPropertyChangeListener, addPropertyChangeListener, getAuthProfileName, getDefaultDatasourceName, getDefaultTagProviderName, getEdgeEditions, getEventBus, getExpressionFunctionFactory, getGlobalProps, getLaunchContext, getLoggingManager, getOrDefault, getProgressManager, getProjectDescription, getProjectName, getProjectTitle, getTagPollRate, getUIEventBus, initProject, installLegacyScriptLibrary, removePropertyChangeListener, removePropertyChangeListener, resetExpressionFunctionFactory, setGlobalProps

Methods inherited from class java.lang.Object

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

Method Detail

getProject

public RuntimeProject getProject()

Description copied from interface: ClientContext

Returns the project that this client is running. Note that this may be null before the client is fully logged in and started, because the context is created before the project is downloaded.

Specified by:

getProject in interface ClientContext

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(java.lang.String bindingTypeKey)

Specified by:

getBindingType in interface VisionClientInterface

getExecutionManager

public ExecutionManager getExecutionManager()

Description copied from interface: ClientContext

Returns the shared task execution manager for this client

Specified by:

getExecutionManager in interface ClientContext

getLocalizationManager

public ClientLocalizationManager getLocalizationManager()

Specified by:

getLocalizationManager in interface ClientContext

setLocalizationManager

public void setLocalizationManager(ClientLocalizationManager mgr)

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 listener)

Description copied from interface: VisionClientInterface

Removes window listener

Specified by:

removeWindowListener in interface VisionClientInterface

receiveVisionWindowEvent

public void receiveVisionWindowEvent(VisionWindowEvent event)

Listens to the event bus for vision window evens to push all window open/close events to any modules that have registered VisionWindowListener objects.

deserialize

public java.lang.Object deserialize(byte[] data,
                                    org.apache.log4j.Logger log)
                             throws SerializationException

Description copied from interface: ClientContext

Convenience function to deserialize a gzipped byte array into a single object. If multiple objects are found, they will be discarded. Warnings are logged to the given logger. If data is null or empty, null is returned.

Specified by:

deserialize in interface ClientContext

Throws:

SerializationException

getRootPaneContainer

public javax.swing.RootPaneContainer getRootPaneContainer()

Description copied from interface: ClientContext

Returns the RootPaneContainer that is currently the owner of the client

Specified by:

getRootPaneContainer in interface ClientContext

getModules

public java.util.List<ModuleInfo> getModules()

Description copied from interface: ClientContext

Retrieve the list of all modules currently loaded in this context

Specified by:

getModules in interface ClientContext

getLicenseState

public LicenseState getLicenseState(java.lang.String moduleId)

Description copied from interface: CommonContext

Returns the license state for the given module

Specified by:

getLicenseState in interface CommonContext

createExpressionFunctionFactory

protected FunctionFactory createExpressionFunctionFactory()

Specified by:

createExpressionFunctionFactory in class AbstractClientContext

loadModules

public void loadModules(java.util.List<ModuleInfo> modules)
                 throws ModuleLoadException

Create LoadedModule objects to represent each client-scoped module in the list. This will instantiate, but not start up, the client module hooks.

Throws:

ModuleLoadException

startup

public void startup()

Overrides:

startup in class AbstractClientContext

setApp

public void setApp(FPMIApp app)

shutdown

public void shutdown()

Overrides:

shutdown in class AbstractClientContext

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(java.lang.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(java.lang.String desktopHandle)

Description copied from interface: VisionClientInterface

Gets the WindowUtilities for a secondary desktop, by handle

Specified by:

getGuiUtil in interface VisionClientInterface

setProject

public void setProject(Project project)

newProjectResourceListener

protected ProjectResourceListener newProjectResourceListener()

Make a custom resource listener so we can keep track of some Vision-specific resources

Overrides:

newProjectResourceListener in class AbstractClientContext

getTagManager

public ClientTagManager getTagManager()

Description copied from interface: CommonContext

Returns the manager that provides access to Ignition's tag system.

Specified by:

getTagManager in interface ClientContext

Specified by:

getTagManager in interface CommonContext

getScriptManager

public ScriptManager getScriptManager()

Description copied from interface: CommonContext

Returns the ScriptManager that can be used to execute Python scripts.

Specified by:

getScriptManager in interface CommonContext

getNamedQueryManager

public NamedQueryManager getNamedQueryManager()

Description copied from interface: ClientContext

Returns the appropriate named query rpc for the context. In the gateway and client, we only want to use named queries that have been saved. In the designer, we want to use the current version so that reports and bindings can be seen and used for testing before the project is saved.

Specified by:

getNamedQueryManager in interface ClientContext

Returns:

The correct NamedQueryManager implementation for the scope.

createDeserializer

public XMLDeserializer createDeserializer()

Description copied from interface: CommonContext

Returns an instance of the XMLDeserializer that can be used to deserialize project resources. Note that this is the only safe way to obtain an instance of XMLDeserializer, because the context will pass the new deserializer around to all loaded modules, giving them a chance to initialize any custom deserialization deletes on it first.

Specified by:

createDeserializer in interface CommonContext

configureDeserializer

public static void configureDeserializer(XMLDeserializer d)

configureClassNameResolver

public static void configureClassNameResolver(ClassNameResolver r)

getGeneralProps

public GeneralProps getGeneralProps()

getLaunchProps

public LaunchProps getLaunchProps()

getLoginProps

public LoginProps getLoginProps()

getUiProps

public UIProps getUiProps()

getModule

public java.lang.Object getModule(java.lang.String id)

Description copied from interface: CommonContext

Returns the hook class for another module, used for modules that deal with each other's models. Example: The reporting plugin's designer hook uses this to get FactoryPMI's palette.

Specified by:

getModule in interface CommonContext