Class PropertyBinding
- java.lang.Object
-
- com.inductiveautomation.ignition.common.lifecycle.AbstractLifecycle
-
- com.inductiveautomation.perspective.gateway.binding.AbstractBinding
-
- com.inductiveautomation.perspective.gateway.binding.property.PropertyBinding
-
- All Implemented Interfaces:
PropertyBindingConstants
,Binding
public class PropertyBinding extends AbstractBinding implements PropertyBindingConstants
-
-
Field Summary
-
Fields inherited from class com.inductiveautomation.perspective.gateway.binding.AbstractBinding
bindingContext
-
Fields inherited from interface com.inductiveautomation.perspective.gateway.api.Binding
BAD_CONFIG, BAD_REF, BIDIRECTIONAL_KEY, INITIAL_VALUE, MDC_BINDING_TARGET, NOT_FOUND
-
Fields inherited from interface com.inductiveautomation.perspective.common.config.constants.PropertyBindingConstants
CONFIG_SOURCE_PATH, TYPE_ID
-
-
Constructor Summary
Constructors Constructor Description PropertyBinding(BindingContext bindingContext, BindingConfig bindingConfig)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
isBidirectional()
protected void
onShutdown()
protected void
onStartup()
void
onTargetPropertyChanged(QualifiedValue newTargetValue)
This will be called when the target property changes from a source other than the binding, if the binding returns true fromBinding.isBidirectional()
and there are no transforms present.void
onUserRefresh()
Called to prompt the binding to produce a value as soon as possible.-
Methods inherited from class com.inductiveautomation.ignition.common.lifecycle.AbstractLifecycle
isRunning, shutdown, startup
-
-
-
-
Constructor Detail
-
PropertyBinding
public PropertyBinding(BindingContext bindingContext, BindingConfig bindingConfig) throws ConfigurationException
- Throws:
ConfigurationException
-
-
Method Detail
-
isBidirectional
public boolean isBidirectional()
- Specified by:
isBidirectional
in interfaceBinding
- Returns:
- true if this binding wants to be bidirectional. Note that if any transforms are present, then the binding will not operate in a bidirectional way.
-
onStartup
protected void onStartup()
- Specified by:
onStartup
in classAbstractLifecycle
-
onTargetPropertyChanged
public void onTargetPropertyChanged(QualifiedValue newTargetValue)
Description copied from interface:Binding
This will be called when the target property changes from a source other than the binding, if the binding returns true fromBinding.isBidirectional()
and there are no transforms present.- Specified by:
onTargetPropertyChanged
in interfaceBinding
-
onShutdown
protected void onShutdown()
- Specified by:
onShutdown
in classAbstractLifecycle
-
onUserRefresh
public void onUserRefresh()
Description copied from interface:Binding
Called to prompt the binding to produce a value as soon as possible. This _not_ the normal way that bindings work. Bindings are expected to produce a value un-prompted after startup, and then again whenever they feel is appropriate. This is there to allow the user to call component.refreshBinding(property) and prompt a non-polling binding to run.- Specified by:
onUserRefresh
in interfaceBinding
-
-