Package com.inductiveautomation.snap.ui

Class UIEvent

java.lang.Object
com.inductiveautomation.snap.ui.UIEvent
Direct Known Subclasses:
SwingEvent
public abstract class UIEvent extends Object
Represents a UI event sent to a UIOwner.

  • Constructor Details

    • UIEvent

      public UIEvent()
      Creates a new UIEvent.

    • UIEvent

      public UIEvent(Object anEvent, Object aTarget, UIEvent.Type aType)
      Creates a new UIEvent with given event, event target and property name.

  • Method Details

    • getName

      public String getName()
      Returns the name of the event (or the name of the Event Target).

    • setName

      public void setName(String aName)
      Returns the name of the event (or the name of the Event Target).

    • getEvent

      public Object getEvent()
      Returns the platform specific event, if available.

    • setEvent

      protected void setEvent(Object anEvent)
      Sets the platform specific event, if available.

    • getEvent

      public <T> T getEvent(Class<T> aClass)
      Returns the platform specific event as given class.

    • getType

      public UIEvent.Type getType()
      Returns the event type.

    • setType

      public void setType(UIEvent.Type aType)
      Sets the event type.

    • getType

      protected abstract UIEvent.Type getType(Object anEvent)
      Returns the UIEventType from given Event object.

    • getTarget

      public Object getTarget()
      Returns the event target.

    • setTarget

      protected void setTarget(Object aTarget)
      Sets the event target.

    • getTarget

      public <T> T getTarget(Class<T> aClass)
      Returns the target of the event as given class.

    • isValueChangeEvent

      public boolean isValueChangeEvent()
      Returns whether event is value change event.

    • isPropertyChangeEvent

      public boolean isPropertyChangeEvent()
      Returns whether event is property change.

    • getPropertyChangePropertyName

      protected abstract String getPropertyChangePropertyName()
      Returns whether event is property change.

    • getPropertyName

      public String getPropertyName()
      Returns the property name.

    • isActionEvent

      public boolean isActionEvent()
      Returns whether event is action event.

    • isSelectionEvent

      public boolean isSelectionEvent()
      Returns whether event is selection event.

    • isTimerEvent

      public boolean isTimerEvent()
      Returns whether event is timer event.

    • isMouseEvent

      public boolean isMouseEvent()
      Returns whether event is mouse event.

    • isMousePressed

      public boolean isMousePressed()
      Returns whether event is mouse pressed.

    • isMouseDragged

      public boolean isMouseDragged()
      Returns whether event is mouse dragged.

    • isMouseReleased

      public boolean isMouseReleased()
      Returns whether event is mouse released.

    • isMouseClicked

      public boolean isMouseClicked()
      Returns whether event is mouse clicked.

    • isMouseFinished

      public boolean isMouseFinished()
      Returns whether event is mouse finished.

    • isMouseEntered

      public boolean isMouseEntered()
      Returns whether event is mouse entered.

    • isMouseMoved

      public boolean isMouseMoved()
      Returns whether event is mouse moved.

    • isMouseExited

      public boolean isMouseExited()
      Returns whether event is mouse exited.

    • isKeyEvent

      public boolean isKeyEvent()
      Returns whether event is key event.

    • isKeyPressed

      public boolean isKeyPressed()
      Returns whether event is key pressed.

    • isKeyReleased

      public boolean isKeyReleased()
      Returns whether event is key released.

    • isKeyTyped

      public boolean isKeyTyped()
      Returns whether event is key typed.

    • isKeyFinished

      public boolean isKeyFinished()
      Returns whether event is key finished.

    • isDragEvent

      public boolean isDragEvent()
      Returns whether event is any drag event.

    • isDragEnter

      public boolean isDragEnter()
      Returns whether event is drag enter.

    • isDragOver

      public boolean isDragOver()
      Returns whether event is drag over.

    • isDragExit

      public boolean isDragExit()
      Returns whether event is drag exit.

    • isDragDropEvent

      public boolean isDragDropEvent()
      Returns whether event is drop event.

    • isDragGesture

      public boolean isDragGesture()
      Returns whether event is DragGesture event.

    • isDragSourceEnter

      public boolean isDragSourceEnter()
      Returns whether event is DragSourceEnter event.

    • isDragSourceExit

      public boolean isDragSourceExit()
      Returns whether event is DragSourceExit event.

    • isDragSourceEnd

      public boolean isDragSourceEnd()
      Returns whether event is DragSourceEnd event.

    • isFocusGained

      public boolean isFocusGained()
      Returns whether event is FocusGained.

    • isFocusLost

      public boolean isFocusLost()
      Returns whether event is FocusLost.

    • is

      public boolean is(String aName)
      Returns whether event represents component with given name.

    • equals

      public boolean equals(String aName)
      Returns whether widget is equal to given name.

    • getValue

      public Object getValue()
      Returns the value encapsulated by the event widget.

    • setValue

      public void setValue(Object aValue)
      Sets the value encapsulated by the event widget.

    • getStringValue

      public String getStringValue()
      Returns the String value encapsulated by the event widget.

    • getBoolValue

      public boolean getBoolValue()
      Returns the Boolean value encapsulated by the event widget.

    • getBooleanValue

      public Boolean getBooleanValue()
      Returns the Boolean value encapsulated by the event widget.

    • getIntValue

      public Integer getIntValue()
      Returns the Integer value encapsulated by the event widget.

    • getFloatValue

      public Float getFloatValue()
      Returns the Float value encapsulated by the event widget.

    • getText

      public String getText()
      Returns text for encapsulated widget.

    • getSelectedIndex

      public int getSelectedIndex()
      Returns the selected index for encapsulated widget.

    • getSelectedItem

      public Object getSelectedItem()
      Returns the selected item for encapsulated widget.

    • getSelectedItem

      public <T> T getSelectedItem(Class<T> aClass)
      Returns the selected item for encapsulated widget.

    • getHelper

      public abstract UIHelper getHelper()
      Returns the UI Helper for event target.

    • isValueAdjusting

      public boolean isValueAdjusting()
      Returns whether event widget or internal event is currently in a continuous state of change.

    • getTriggersReset

      public boolean getTriggersReset()
      Returns whether this event triggers a UI reset.

    • setTriggersReset

      public void setTriggersReset(boolean aValue)
      Sets whether this event triggers a UI reset.

    • consume

      public void consume()
      Consumes the event.

    • toString

      public String toString()
      Standard toString implementation.
      Overrides:
      toString in class Object