Class CommonContextDecorator
- java.lang.Object
-
- com.inductiveautomation.ignition.common.model.CommonContextDecorator
-
- All Implemented Interfaces:
CommonContext
- Direct Known Subclasses:
PerspectiveExpression.PerspectiveExpressionCommonContext
public abstract class CommonContextDecorator extends java.lang.Object implements CommonContext
Simple abstract decorator forCommonContext
-
-
Constructor Summary
Constructors Constructor Description CommonContextDecorator(CommonContext delegate)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description XMLDeserializer
createDeserializer()
Returns an instance of the XMLDeserializer that can be used to deserialize project resources.java.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.LicenseState
getLicenseState(java.lang.String moduleId)
Returns the license state for the given moduleLogFilterSettings
getLoggingManager()
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.ScriptManager
getScriptManager()
Returns the ScriptManager that can be used to execute Python scripts.TagManager
getTagManager()
Returns the manager that provides access to Ignition's tag system.
-
-
-
Constructor Detail
-
CommonContextDecorator
public CommonContextDecorator(@Nonnull CommonContext delegate)
-
-
Method Detail
-
getTagManager
public TagManager getTagManager()
Description copied from interface:CommonContext
Returns the manager that provides access to Ignition's tag system.- Specified by:
getTagManager
in interfaceCommonContext
-
getScriptManager
public ScriptManager getScriptManager()
Description copied from interface:CommonContext
Returns the ScriptManager that can be used to execute Python scripts.- Specified by:
getScriptManager
in interfaceCommonContext
-
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 interfaceCommonContext
-
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
-
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 interfaceCommonContext
-
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 interfaceCommonContext
-
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
-
getLoggingManager
public LogFilterSettings getLoggingManager()
- Specified by:
getLoggingManager
in interfaceCommonContext
-
-