Package com.inductiveautomation.ignition.client.model

Class AbstractClientContext

java.lang.Object

com.inductiveautomation.ignition.client.model.AbstractClientContext

All Implemented Interfaces:

ClientContext, CommonContext

Direct Known Subclasses:

ClientContextImpl, DesignerContextImpl

public abstract class AbstractClientContext
extends Object
implements ClientContext

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractClientContext.ClientContextResourceListener

Field Summary

Fields

Modifier and Type	Field	Description
protected PropertyChangeSupport	changeSupport
protected GlobalProps	globalProps
protected LoggerEx	log
protected LoggingManagerImpl	loggingManager
protected Project	project
protected String	projectDescription
protected String	projectTitle

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractClientContext(LaunchContext launchContext, String projectName)

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener pcl)
void	addPropertyChangeListener(String property, PropertyChangeListener pcl)
protected abstract FunctionFactory	createExpressionFunctionFactory()
String	getAuthProfileName()	Returns the current project's user source
String	getDefaultDatasourceName()	Returns the current project's default datasource name
String	getDefaultTagProviderName()	Returns the current project's default Tag provider
List<EdgeEdition>	getEdgeEditions()	Returns a list of currently available Edge editions (either licensed or in trial).
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.
GlobalProps	getGlobalProps()
LaunchContext	getLaunchContext()
LogFilterSettings	getLoggingManager()
protected <T> T	getOrDefault(ResourceType type, Supplier<T> defaultSupplier)
ClientProgressManager	getProgressManager()	Returns the progress manager, which allows the execution of long running or async tasks.
String	getProjectDescription()
String	getProjectName()	The name of the project this client will be / is running
String	getProjectTitle()
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.
protected void	initProject(Project project)
protected void	installLegacyScriptLibrary(ProjectResource resource)
protected ProjectResourceListener	newProjectResourceListener()
void	removePropertyChangeListener(PropertyChangeListener pcl)
void	removePropertyChangeListener(String property, PropertyChangeListener pcl)
void	resetExpressionFunctionFactory()	Null out the expressionFunctionFactory field, causing the next call to getExpressionFunctionFactory() to first invoke createExpressionFunctionFactory().
protected void	setGlobalProps(GlobalProps newGp)
protected void	shutdown()
protected void	startup()

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, getNamedQueryManager, getProject, getRootPaneContainer, getTagManager

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

createDeserializer, getLicenseState, getModule, getScriptManager

Field Details

log

protected LoggerEx log

changeSupport

protected PropertyChangeSupport changeSupport

globalProps

protected GlobalProps globalProps

project

protected Project project

loggingManager

protected LoggingManagerImpl loggingManager

projectTitle

protected String projectTitle

projectDescription

protected String projectDescription

Constructor Details

AbstractClientContext

protected AbstractClientContext(LaunchContext launchContext,
 String projectName)

Method Details

startup

protected void startup()

shutdown

protected void shutdown()

initProject

protected void initProject(@Nonnull
 Project project)

getOrDefault

protected <T> T getOrDefault(ResourceType type,
 Supplier<T> defaultSupplier)

newProjectResourceListener

protected ProjectResourceListener newProjectResourceListener()

getProjectName

@Nonnull
public String getProjectName()

Description copied from interface: ClientContext

The name of the project this client will be / is running

Specified by:

getProjectName in interface ClientContext

getProjectTitle

public String getProjectTitle()

getProjectDescription

public String getProjectDescription()

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(PropertyChangeListener pcl)

Specified by:

addPropertyChangeListener in interface ClientContext

addPropertyChangeListener

public void addPropertyChangeListener(String property,
 PropertyChangeListener pcl)

Specified by:

addPropertyChangeListener in interface ClientContext

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener pcl)

Specified by:

removePropertyChangeListener in interface ClientContext

removePropertyChangeListener

public void removePropertyChangeListener(String property,
 PropertyChangeListener pcl)

Specified by:

removePropertyChangeListener in interface ClientContext

getLoggingManager

public LogFilterSettings getLoggingManager()

Specified by:

getLoggingManager in interface CommonContext

getDefaultDatasourceName

public String getDefaultDatasourceName()

Description copied from interface: ClientContext

Returns the current project's default datasource name

Specified by:

getDefaultDatasourceName in interface ClientContext

getDefaultTagProviderName

public String getDefaultTagProviderName()

Description copied from interface: ClientContext

Returns the current project's default Tag provider

Specified by:

getDefaultTagProviderName in interface ClientContext

getAuthProfileName

public 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

getGlobalProps

public GlobalProps getGlobalProps()

setGlobalProps

protected void setGlobalProps(@Nullable
 GlobalProps newGp)

installLegacyScriptLibrary

protected void installLegacyScriptLibrary(ProjectResource resource)

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

getEdgeEditions

public List<EdgeEdition> getEdgeEditions()

Description copied from interface: CommonContext

Returns a list of currently available Edge editions (either licensed or in trial). Does not check if any required modules are installed and running.

Specified by:

getEdgeEditions in interface CommonContext

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