java.lang.Object
com.inductiveautomation.perspective.common.config.KeyEvent
All Implemented Interfaces:
Comparable<KeyEvent>

public class KeyEvent extends Object implements 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 Details

    • KEY_VALUES

      public static final List<String> KEY_VALUES
  • Constructor Details

    • KeyEvent

      public KeyEvent()
    • KeyEvent

      public KeyEvent(KeyEvent copy)
    • KeyEvent

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

    • compareTo

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

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

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • toString

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

      public String getName()
    • updateName

      public void updateName()
    • setEnabled

      public void setEnabled(boolean en)
    • getEnabled

      public boolean getEnabled()
    • getEventMode

      public KeyEvent.EventMode getEventMode()
    • setEventMode

      public void setEventMode(KeyEvent.EventMode mode)
    • getEventModeValues

      public List<KeyEvent.EventMode> getEventModeValues()
    • getEventBound

      public KeyEvent.EventBound getEventBound()
    • setEventBound

      public void setEventBound(KeyEvent.EventBound bound)
    • getEventBoundKey

      public String getEventBoundKey()
    • setEventBoundKey

      public void setEventBoundKey(String key)
    • getEventBoundCode

      public String getEventBoundCode()
    • setEventBoundCode

      public void setEventBoundCode(String code)
    • getRegexPattern

      public String getRegexPattern()
    • setRegexPattern

      public void setRegexPattern(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()