Class PropertyInteractionDescriptor

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String _getSymbolicSourcePath()  
      void _setSymbolicSourcePath​(java.lang.String symbolicSourcePath)
      Sets the symbolic path for when the ID is told to serialize symbolically
      void connect()
      Connects the listener to the listenable
      void disconnect()
      Removes the listener from the listenable.
      Adapter getAdapter()
      Returns the adapter that this interaction listener is a slave to.
      javax.swing.JComponent getListenable()
      Returns the component (source component) that we listen to for detecting when the interaction is updated
      java.beans.PropertyChangeListener getListener()
      The property change listener that is used to listen to the listenable (source)
      QualityCode getQuality()
      Looks up the quality of the property this is listening to
      java.awt.Component getSource()
      Returns the source component
      java.lang.String getSourceProperty()
      Returns the name of the property on the source that we are interested in
      java.lang.String getSourceQualityProperty()  
      void initialize​(java.lang.Class type, java.lang.Object oldInstance, java.lang.Object newInstance, java.beans.Encoder out)
      Serializes this ID
      boolean isSerializeSymbolically()
      True if this ID has been told to serialize symbolically
      void setAdapter​(Adapter a)  
      void setConnected​(boolean b)
      Deprecated.
      void setListener​(java.beans.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 setSource​(java.awt.Component component)
      Sets the source component
      void setSourceProperty​(java.lang.String string)
      Sets the source property name
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • PropertyInteractionDescriptor

        public PropertyInteractionDescriptor()
      • PropertyInteractionDescriptor

        public PropertyInteractionDescriptor​(java.awt.Component source,
                                             java.beans.PropertyChangeListener listener,
                                             PropertyAdapter adapter,
                                             java.lang.String sourceProp)
    • Method Detail

      • getListenable

        public javax.swing.JComponent getListenable()
        Returns the component (source component) that we listen to for detecting when the interaction is updated
      • getListener

        public java.beans.PropertyChangeListener getListener()
        The property change listener that is used to listen to the listenable (source)
      • getAdapter

        public Adapter 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 interface InteractionDescriptor
      • getQuality

        public QualityCode getQuality()
        Looks up the quality of the property this is listening to
      • setListener

        public void setListener​(java.beans.PropertyChangeListener listener)
        Sets the listener (the PCL that listens to the source)
      • setSource

        public void setSource​(java.awt.Component component)
        Sets the source component
        Specified by:
        setSource in interface InteractionDescriptor
      • getSourceProperty

        public java.lang.String getSourceProperty()
        Returns the name of the property on the source that we are interested in
      • setSourceProperty

        public void setSourceProperty​(java.lang.String string)
        Sets the source property name
      • getSourceQualityProperty

        public java.lang.String getSourceQualityProperty()
      • setConnected

        @Deprecated
        public void setConnected​(boolean b)
        Deprecated.
      • 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 interface InteractionDescriptor
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • initialize

        public void initialize​(java.lang.Class type,
                               java.lang.Object oldInstance,
                               java.lang.Object newInstance,
                               java.beans.Encoder out)
        Serializes this ID
        Specified by:
        initialize in interface InteractionDescriptor
      • _setSymbolicSourcePath

        public void _setSymbolicSourcePath​(java.lang.String symbolicSourcePath)
        Sets the symbolic path for when the ID is told to serialize symbolically
        Specified by:
        _setSymbolicSourcePath in interface InteractionDescriptor