com.inductiveautomation.ignition.client.model

Class AbstractClientContext

java.lang.Object

com.inductiveautomation.ignition.client.model.AbstractClientContext

All Implemented Interfaces:

ClientContext, ProjectHolder, CommonContext

Direct Known Subclasses:

ClientContextImpl, DesignerContextImpl

public abstract class AbstractClientContext
extends java.lang.Object
implements ClientContext

Field Summary

Fields

Modifier and Type	Field and Description
protected java.beans.PropertyChangeSupport	changeSupport
protected GlobalProps	globalProps
protected org.apache.log4j.Logger	log
protected LoggingManagerImpl	loggingManager

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractClientContext(LaunchContext launchContext)

Method Summary

Modifier and Type	Method and Description
void	addProjectChangeListener(ProjectChangeListener listener) Adds a listener that will recieve project diffs when the project changes
void	addPropertyChangeListener(java.beans.PropertyChangeListener pcl)
void	addPropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener pcl)
void	applyDiff(Project diff, boolean dirty)
void	applyGlobalDiff(Project diff, boolean dirty)
protected abstract FunctionFactory	createExpressionFunctionFactory()
java.lang.String	getAuthProfileName() Returns the current project's user source
java.lang.String	getCacheDir()
java.lang.String	getDefaultDatasourceName() Returns the current project's default datasource name
java.lang.String	getDefaultTagProviderName() Returns the current project's default Tag provider
com.google.common.eventbus.EventBus	getEventBus() This is a generic event bus that can be used by any part of Ignition within a single scope (jvm)
FunctionFactory	getExpressionFunctionFactory() Returns the core function factory used by expressions.
ProjectHolder	getGlobalProject()
GlobalProps	getGlobalProps()
LaunchContext	getLaunchContext()
LogFilterSettings	getLoggingManager()
ClientProgressManager	getProgressManager() Returns the progress manager, which allows the execution of long running or async tasks.
Project	getProject() Gets the underlying project.
protected ProjectHolder	getProjectHolder()
int	getTagPollRate() Returns the rate at which Tags should be polled for updates
com.google.common.eventbus.EventBus	getUIEventBus() This event bus schedules event notification on the swing EDT.
void	removeProjectChangeListener(ProjectChangeListener listener)
void	resetExpressionFunctionFactory() Null out the expressionFunctionFactory field, causing the next call to getExpressionFunctionFactory() to first invoke createExpressionFunctionFactory().
protected void	setGlobalProjectHolder(ProjectHolder projectHolder)
protected void	setGlobalProps(GlobalProps gp)
protected void	setProjectHolder(ProjectHolder ph)
protected void	updateGlobalProps(Project diff)
protected void	updateProject(Project diff)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.client.model.ClientContext

deserialize, getExecutionManager, getLocalizationManager, getModules, getNamedQueryRpc, getProjectVersion, getRootPaneContainer, getTagManager

Methods inherited from interface com.inductiveautomation.ignition.common.model.CommonContext

createDeserializer, getLicenseState, getModule, getScriptManager

Field Detail

log

protected org.apache.log4j.Logger log

changeSupport

protected java.beans.PropertyChangeSupport changeSupport

globalProps

protected GlobalProps globalProps

loggingManager

protected LoggingManagerImpl loggingManager

Constructor Detail

AbstractClientContext

protected AbstractClientContext(LaunchContext launchContext)

Method Detail

updateProject

protected void updateProject(Project diff)

getExpressionFunctionFactory

public FunctionFactory getExpressionFunctionFactory()

Description copied from interface: CommonContext

Returns the core function factory used by expressions. Includes extension functions registered by modules.

Specified by:

getExpressionFunctionFactory in interface CommonContext

resetExpressionFunctionFactory

public void resetExpressionFunctionFactory()

Null out the expressionFunctionFactory field, causing the next call to getExpressionFunctionFactory() to first invoke createExpressionFunctionFactory().

createExpressionFunctionFactory

protected abstract FunctionFactory createExpressionFunctionFactory()

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener pcl)

Specified by:

addPropertyChangeListener in interface ClientContext

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String property,
                                      java.beans.PropertyChangeListener pcl)

Specified by:

addPropertyChangeListener in interface ClientContext

getLoggingManager

public LogFilterSettings getLoggingManager()

Specified by:

getLoggingManager in interface CommonContext

getDefaultDatasourceName

public java.lang.String getDefaultDatasourceName()

Description copied from interface: ClientContext

Returns the current project's default datasource name

Specified by:

getDefaultDatasourceName in interface ClientContext

getDefaultTagProviderName

public java.lang.String getDefaultTagProviderName()

Description copied from interface: ClientContext

Returns the current project's default Tag provider

Specified by:

getDefaultTagProviderName in interface ClientContext

getAuthProfileName

public java.lang.String getAuthProfileName()

Description copied from interface: ClientContext

Returns the current project's user source

Specified by:

getAuthProfileName in interface ClientContext

getTagPollRate

public int getTagPollRate()

Description copied from interface: ClientContext

Returns the rate at which Tags should be polled for updates

Specified by:

getTagPollRate in interface ClientContext

getProjectHolder

protected ProjectHolder getProjectHolder()

setProjectHolder

protected void setProjectHolder(ProjectHolder ph)

getGlobalProject

public ProjectHolder getGlobalProject()

Specified by:

getGlobalProject in interface ClientContext

setGlobalProjectHolder

protected void setGlobalProjectHolder(ProjectHolder projectHolder)

getProject

public Project getProject()

Description copied from interface: ProjectHolder

Gets the underlying project. Do not modify resources directly, see ProjectHolder.addProjectChangeListener(ProjectChangeListener) and #deleteResource(long)

Specified by:

getProject in interface ProjectHolder

addProjectChangeListener

public void addProjectChangeListener(ProjectChangeListener listener)

Description copied from interface: ProjectHolder

Adds a listener that will recieve project diffs when the project changes

Specified by:

addProjectChangeListener in interface ProjectHolder

removeProjectChangeListener

public void removeProjectChangeListener(ProjectChangeListener listener)

Specified by:

removeProjectChangeListener in interface ProjectHolder

applyDiff

public void applyDiff(Project diff,
                      boolean dirty)

Specified by:

applyDiff in interface ProjectHolder

applyGlobalDiff

public void applyGlobalDiff(Project diff,
                            boolean dirty)

Specified by:

applyGlobalDiff in interface ClientContext

getGlobalProps

public GlobalProps getGlobalProps()

updateGlobalProps

protected void updateGlobalProps(Project diff)

setGlobalProps

protected void setGlobalProps(GlobalProps gp)

getProgressManager

public ClientProgressManager getProgressManager()

Description copied from interface: ClientContext

Returns the progress manager, which allows the execution of long running or async tasks.

Specified by:

getProgressManager in interface ClientContext

getLaunchContext

public LaunchContext getLaunchContext()

Specified by:

getLaunchContext in interface ClientContext

getCacheDir

public java.lang.String getCacheDir()

Specified by:

getCacheDir in interface ClientContext

getEventBus

public com.google.common.eventbus.EventBus getEventBus()

Description copied from interface: CommonContext

This is a generic event bus that can be used by any part of Ignition within a single scope (jvm)

Specified by:

getEventBus in interface CommonContext

getUIEventBus

public com.google.common.eventbus.EventBus getUIEventBus()

Description copied from interface: ClientContext

This event bus schedules event notification on the swing EDT. This is opposed to the event bus found on CommonContext.getEventBus(), which schedules event notification on a background thread.

Specified by:

getUIEventBus in interface ClientContext