Package com.inductiveautomation.snap.ui

Class Binding

  • All Implemented Interfaces:
    Archivable, java.lang.Cloneable
    public class Binding
extends java.lang.Object
implements java.lang.Cloneable, Archivable
    This class maps a UI node value to a model key value (some kind of display object like a Swing component value or an RMShape size).

    • Constructor Summary

      Constructors 
      Constructor Description
      Binding()
      Creates a new binding.
      Binding​(java.lang.String aPropName, java.lang.String aKey)
      Creates a new binding for property name and key.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Binding clone()
      Standard clone implementation.
      Binding fromXML​(RXArchiver anArchiver, RXElement anElement)
      XML unarchival.
      java.lang.String getConversionKey()
      Returns the conversion key used to get conversion map to convert bound object value to UI node.
      java.text.Format getFormat()
      Returns the format object to be used to format values to strings.
      UIHelper getHelper()
      Returns the UI node's helper (convenience).
      java.lang.String getKey()
      Returns the key that is used to get the property value from the bound object.
      java.lang.Object getNode()
      Returns the UI node.
      java.lang.String getPropertyName()
      Returns the property name.
      void setConversionKey​(java.lang.String aKey)
      Sets the conversion key used to get conversion map to convert bound object value to UI node.
      void setFormat​(java.text.Format aFormat)
      Sets the format object to be used to convert values to strings.
      void setHelper​(UIHelper aHelper)
      Sets the UI node's helper.
      void setKey​(java.lang.String aKey)
      Sets the key that is used to get the property value from the bound object.
      void setNode​(java.lang.Object anObj)
      Sets the UI node.
      void setPropertyName​(java.lang.String aPropertyName)
      Sets the property name.
      java.lang.String toString()
      Returns a string representation.
      RXElement toXML​(RXArchiver anArchiver)
      XML archival.

      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • Binding

        public Binding()
        Creates a new binding.

      • Binding

        public Binding​(java.lang.String aPropName,
               java.lang.String aKey)
        Creates a new binding for property name and key.

    • Method Detail

      • getNode

        public java.lang.Object getNode()
        Returns the UI node.

      • setNode

        public void setNode​(java.lang.Object anObj)
        Sets the UI node.

      • getHelper

        public UIHelper getHelper()
        Returns the UI node's helper (convenience).

      • setHelper

        public void setHelper​(UIHelper aHelper)
        Sets the UI node's helper.

      • getPropertyName

        public java.lang.String getPropertyName()
        Returns the property name.

      • setPropertyName

        public void setPropertyName​(java.lang.String aPropertyName)
        Sets the property name.

      • getKey

        public java.lang.String getKey()
        Returns the key that is used to get the property value from the bound object.

      • setKey

        public void setKey​(java.lang.String aKey)
        Sets the key that is used to get the property value from the bound object.

      • getConversionKey

        public java.lang.String getConversionKey()
        Returns the conversion key used to get conversion map to convert bound object value to UI node.

      • setConversionKey

        public void setConversionKey​(java.lang.String aKey)
        Sets the conversion key used to get conversion map to convert bound object value to UI node.

      • getFormat

        public java.text.Format getFormat()
        Returns the format object to be used to format values to strings.

      • setFormat

        public void setFormat​(java.text.Format aFormat)
        Sets the format object to be used to convert values to strings.

      • clone

        public Binding clone()
        Standard clone implementation.
        Overrides:
        clone in class java.lang.Object

      • toString

        public java.lang.String toString()
        Returns a string representation.
        Overrides:
        toString in class java.lang.Object