Package com.inductiveautomation.rm.graphics

Class RMKeyValueList

  • public class RMKeyValueList
extends java.lang.Object
    An animation object that keeps track of Key-Values at Key Frame times for a target/key pair.

    • Constructor Summary

      Constructors 
      Constructor Description
      RMKeyValueList​(java.lang.Object aTarget, java.lang.String aKey)
      Creates a new key value list for given target and key.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addKeyValue​(RMKeyValue aKeyValue, int aTime)
      Adds a key value and time to key values and times list.
      boolean containsTime​(int aTime)
      Returns whether key value list contains the given time.
      java.lang.String getKey()
      Returns the list key.
      RMKeyValue getKeyValue​(int anIndex)
      Returns the individual key value at given index.
      int getKeyValueCount()
      Returns the number of key values.
      java.lang.Object getTarget()
      Returns the list target.
      int getTime​(int anIndex)
      Returns the individual time at given index.
      RMKeyValue removeKeyValue​(int anIndex)
      Removes the key value and time at given index.
      int removeKeyValue​(RMKeyValue aKeyValue)
      Removes a given key value and its corresponding time.
      int removeTime​(int aTime)
      Removes a given time and its corresponding key value.
      void setTime​(int aTime, int theLastTime)
      Sets the time based on key-value-time entries.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • RMKeyValueList

        public RMKeyValueList​(java.lang.Object aTarget,
                      java.lang.String aKey)
        Creates a new key value list for given target and key.

    • Method Detail

      • getTarget

        public java.lang.Object getTarget()
        Returns the list target.

      • getKey

        public java.lang.String getKey()
        Returns the list key.

      • getKeyValueCount

        public int getKeyValueCount()
        Returns the number of key values.

      • getKeyValue

        public RMKeyValue getKeyValue​(int anIndex)
        Returns the individual key value at given index.

      • getTime

        public int getTime​(int anIndex)
        Returns the individual time at given index.

      • addKeyValue

        public void addKeyValue​(RMKeyValue aKeyValue,
                        int aTime)
        Adds a key value and time to key values and times list.

      • removeKeyValue

        public RMKeyValue removeKeyValue​(int anIndex)
        Removes the key value and time at given index.

      • removeKeyValue

        public int removeKeyValue​(RMKeyValue aKeyValue)
        Removes a given key value and its corresponding time.

      • removeTime

        public int removeTime​(int aTime)
        Removes a given time and its corresponding key value.

      • containsTime

        public boolean containsTime​(int aTime)
        Returns whether key value list contains the given time.

      • setTime

        public void setTime​(int aTime,
                    int theLastTime)
        Sets the time based on key-value-time entries.