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 java.lang.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 java.beans.PropertyChangeSupport
changeSupport
protected GlobalProps
globalProps
protected LoggerEx
log
protected LoggingManagerImpl
loggingManager
protected Project
project
protected java.lang.String
projectDescription
protected java.lang.String
projectTitle
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractClientContext(LaunchContext launchContext, java.lang.String projectName)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
addPropertyChangeListener(java.beans.PropertyChangeListener pcl)
void
addPropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener pcl)
protected abstract FunctionFactory
createExpressionFunctionFactory()
java.lang.String
getAuthProfileName()
Returns the current project's user sourcejava.lang.String
getDefaultDatasourceName()
Returns the current project's default datasource namejava.lang.String
getDefaultTagProviderName()
Returns the current project's default Tag providerjava.util.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, java.util.function.Supplier<T> defaultSupplier)
ClientProgressManager
getProgressManager()
Returns the progress manager, which allows the execution of long running or async tasks.java.lang.String
getProjectDescription()
java.lang.String
getProjectName()
The name of the project this client will be / is runningjava.lang.String
getProjectTitle()
int
getTagPollRate()
Returns the rate at which Tags should be polled for updatescom.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
resetExpressionFunctionFactory()
Null out theexpressionFunctionFactory
field, causing the next call togetExpressionFunctionFactory()
to first invokecreateExpressionFunctionFactory()
.protected void
setGlobalProps(GlobalProps newGp)
-
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 Detail
-
log
protected LoggerEx log
-
changeSupport
protected java.beans.PropertyChangeSupport changeSupport
-
globalProps
protected GlobalProps globalProps
-
project
protected Project project
-
loggingManager
protected LoggingManagerImpl loggingManager
-
projectTitle
protected java.lang.String projectTitle
-
projectDescription
protected java.lang.String projectDescription
-
-
Constructor Detail
-
AbstractClientContext
protected AbstractClientContext(LaunchContext launchContext, java.lang.String projectName)
-
-
Method Detail
-
initProject
protected void initProject(@Nonnull Project project)
-
getOrDefault
protected <T> T getOrDefault(ResourceType type, java.util.function.Supplier<T> defaultSupplier)
-
newProjectResourceListener
protected ProjectResourceListener newProjectResourceListener()
-
getProjectName
@Nonnull public java.lang.String getProjectName()
Description copied from interface:ClientContext
The name of the project this client will be / is running- Specified by:
getProjectName
in interfaceClientContext
-
getProjectTitle
public java.lang.String getProjectTitle()
-
getProjectDescription
public java.lang.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 interfaceCommonContext
-
resetExpressionFunctionFactory
public void resetExpressionFunctionFactory()
Null out theexpressionFunctionFactory
field, causing the next call togetExpressionFunctionFactory()
to first invokecreateExpressionFunctionFactory()
.
-
createExpressionFunctionFactory
protected abstract FunctionFactory createExpressionFunctionFactory()
-
addPropertyChangeListener
public void addPropertyChangeListener(java.beans.PropertyChangeListener pcl)
- Specified by:
addPropertyChangeListener
in interfaceClientContext
-
addPropertyChangeListener
public void addPropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener pcl)
- Specified by:
addPropertyChangeListener
in interfaceClientContext
-
getLoggingManager
public LogFilterSettings getLoggingManager()
- Specified by:
getLoggingManager
in interfaceCommonContext
-
getDefaultDatasourceName
public java.lang.String getDefaultDatasourceName()
Description copied from interface:ClientContext
Returns the current project's default datasource name- Specified by:
getDefaultDatasourceName
in interfaceClientContext
-
getDefaultTagProviderName
public java.lang.String getDefaultTagProviderName()
Description copied from interface:ClientContext
Returns the current project's default Tag provider- Specified by:
getDefaultTagProviderName
in interfaceClientContext
-
getAuthProfileName
public java.lang.String getAuthProfileName()
Description copied from interface:ClientContext
Returns the current project's user source- Specified by:
getAuthProfileName
in interfaceClientContext
-
getTagPollRate
public int getTagPollRate()
Description copied from interface:ClientContext
Returns the rate at which Tags should be polled for updates- Specified by:
getTagPollRate
in interfaceClientContext
-
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 interfaceClientContext
-
getLaunchContext
public LaunchContext getLaunchContext()
- Specified by:
getLaunchContext
in interfaceClientContext
-
getEdgeEditions
public java.util.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 interfaceCommonContext
-
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 interfaceCommonContext
-
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 onCommonContext.getEventBus()
, which schedules event notification on a background thread.- Specified by:
getUIEventBus
in interfaceClientContext
-
-