Class KeyEvent

  • All Implemented Interfaces:
    java.lang.Comparable<KeyEvent>

    public class KeyEvent
    extends java.lang.Object
    implements java.lang.Comparable<KeyEvent>
    The class used behind the data model for the "Key Event" session events. Provides data structure, getters/setters and a JSON representation.
    • Field Detail

      • KEY_VALUES

        public static final java.util.List<java.lang.String> KEY_VALUES
    • Constructor Detail

      • KeyEvent

        public KeyEvent()
      • KeyEvent

        public KeyEvent​(KeyEvent copy)
      • KeyEvent

        public KeyEvent​(com.inductiveautomation.ignition.common.gson.JsonObject rawJson)
    • Method Detail

      • compareTo

        public int compareTo​(@NotNull
                             @NotNull KeyEvent other)
        Specified by:
        compareTo in interface java.lang.Comparable<KeyEvent>
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • toString

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

        public java.lang.String getName()
      • updateName

        public void updateName()
      • setEnabled

        public void setEnabled​(boolean en)
      • getEnabled

        public boolean getEnabled()
      • getEventBoundKey

        public java.lang.String getEventBoundKey()
      • setEventBoundKey

        public void setEventBoundKey​(java.lang.String key)
      • getEventBoundCode

        public java.lang.String getEventBoundCode()
      • setEventBoundCode

        public void setEventBoundCode​(java.lang.String code)
      • getRegexPattern

        public java.lang.String getRegexPattern()
      • setRegexPattern

        public void setRegexPattern​(java.lang.String pattern)
      • getRegexWindow

        public int getRegexWindow()
      • setRegexWindow

        public void setRegexWindow​(int window)
      • getAltEventModifier

        public boolean getAltEventModifier()
      • setAltEventModifier

        public void setAltEventModifier​(boolean modifier)
      • getControlEventModifier

        public boolean getControlEventModifier()
      • setControlEventModifier

        public void setControlEventModifier​(boolean modifier)
      • getShiftEventModifier

        public boolean getShiftEventModifier()
      • setShiftEventModifier

        public void setShiftEventModifier​(boolean modifier)
      • getMetaEventModifier

        public boolean getMetaEventModifier()
      • setMetaEventModifier

        public void setMetaEventModifier​(boolean modifier)
      • getCapturePhaseEventOption

        public boolean getCapturePhaseEventOption()
      • setCapturePhaseEventOption

        public void setCapturePhaseEventOption​(boolean option)
      • getPreventDefaultEventOption

        public boolean getPreventDefaultEventOption()
      • setPreventDefaultEventOption

        public void setPreventDefaultEventOption​(boolean option)
      • getStopPropagationEventOption

        public boolean getStopPropagationEventOption()
      • setStopPropagationEventOption

        public void setStopPropagationEventOption​(boolean option)
      • toJson

        public com.inductiveautomation.ignition.common.gson.JsonObject toJson()