Class PropertyInteractionDescriptor
java.lang.Object
com.inductiveautomation.factorypmi.application.binding.PropertyInteractionDescriptor
- All Implemented Interfaces:
InteractionDescriptor
- Direct Known Subclasses:
PropertyListenerDescriptor
An interaction descriptor that represents a dependency on a source component's property.
-
Constructor Summary
ConstructorsConstructorDescriptionPropertyInteractionDescriptor
(Component source, PropertyChangeListener listener, PropertyAdapter adapter, String sourceProp) -
Method Summary
Modifier and TypeMethodDescriptionvoid
_setSymbolicSourcePath
(String symbolicSourcePath) Sets the symbolic path for when the ID is told to serialize symbolicallyvoid
connect()
Connects the listener to the listenablevoid
Removes the listener from the listenable.Returns the adapter that this interaction listener is a slave to.Returns the component (source component) that we listen to for detecting when the interaction is updatedThe property change listener that is used to listen to the listenable (source)Looks up the quality of the property this is listening toReturns the source componentReturns the name of the property on the source that we are interested invoid
initialize
(Class type, Object oldInstance, Object newInstance, Encoder out) Serializes this IDboolean
True if this ID has been told to serialize symbolicallyvoid
void
setConnected
(boolean b) Deprecated.void
setListener
(PropertyChangeListener listener) Sets the listener (the PCL that listens to the source)void
setSerializeSymbolically
(boolean b) Notifies this ID that it should serialize symbolically.void
Sets the source componentvoid
setSourceProperty
(String string) Sets the source property nametoString()
-
Constructor Details
-
PropertyInteractionDescriptor
public PropertyInteractionDescriptor() -
PropertyInteractionDescriptor
public PropertyInteractionDescriptor(Component source, PropertyChangeListener listener, PropertyAdapter adapter, String sourceProp)
-
-
Method Details
-
getListenable
Returns the component (source component) that we listen to for detecting when the interaction is updated -
getListener
The property change listener that is used to listen to the listenable (source) -
getSource
Returns the source component- Specified by:
getSource
in interfaceInteractionDescriptor
-
getAdapter
Returns the adapter that this interaction listener is a slave to. It will be updated when we are updated from the source- Specified by:
getAdapter
in interfaceInteractionDescriptor
-
setAdapter
- Specified by:
setAdapter
in interfaceInteractionDescriptor
-
getQuality
Looks up the quality of the property this is listening to -
setListener
Sets the listener (the PCL that listens to the source) -
setSource
Sets the source component- Specified by:
setSource
in interfaceInteractionDescriptor
-
disconnect
public void disconnect()Removes the listener from the listenable.- Specified by:
disconnect
in interfaceInteractionDescriptor
-
connect
public void connect()Connects the listener to the listenable- Specified by:
connect
in interfaceInteractionDescriptor
-
getSourceProperty
Returns the name of the property on the source that we are interested in -
setSourceProperty
Sets the source property name -
getSourceQualityProperty
-
setConnected
Deprecated. -
isSerializeSymbolically
public boolean isSerializeSymbolically()True if this ID has been told to serialize symbolically- Specified by:
isSerializeSymbolically
in interfaceInteractionDescriptor
-
setSerializeSymbolically
public void setSerializeSymbolically(boolean b) Notifies this ID that it should serialize symbolically. Used when copying when the source isn't also being copied. Used by the InteractionDescriptorPersistenceDelegate- Specified by:
setSerializeSymbolically
in interfaceInteractionDescriptor
-
toString
-
initialize
Serializes this ID- Specified by:
initialize
in interfaceInteractionDescriptor
-
_getSymbolicSourcePath
- Specified by:
_getSymbolicSourcePath
in interfaceInteractionDescriptor
-
_setSymbolicSourcePath
Sets the symbolic path for when the ID is told to serialize symbolically- Specified by:
_setSymbolicSourcePath
in interfaceInteractionDescriptor
-