Class Event

java.lang.Object
org.eclipse.swt.widgets.Event

public class Event extends Object
Instances of this class provide a description of a particular event which occurred within SWT. The SWT untyped listener API uses these instances for all event dispatching.

Note: For a given event, only the fields which are appropriate will be filled in. The contents of the fields which are not used by the event are unspecified.

See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    int
    the button that was pressed or released; 1 for the first button, 2 for the second button, and 3 for the third button, etc.
    char
    depending on the event, the character represented by the key that was typed.
    int
    depending on the event type, the number of following paint events that are pending which may always be zero on some platforms, or the number of lines or pages to scroll using the mouse wheel, or the number of times the mouse has been clicked
    a field for application use
    int
    the event specific detail field, as defined by the detail constants in class SWT
    the display where the event occurred
    boolean
    depending on the event, a flag indicating whether the operation should be allowed.
    int
    depending on the event, the range of text being modified.
    the graphics context to use when painting that is configured to use the colors, font and damaged region of the control.
    int
    the height of the bounding rectangle of the region that requires painting
    int
    the index of the item where the event occurred
    the item that the event occurred in (can be null)
    int
    depending on the event, the key code of the key that was typed, as defined by the key code constants in class SWT.
    int
    depending on the event, the location of key specified by the keyCode or character.
    double
    The change in magnification.
    double
    The number of degrees rotated on the track pad.
    int[]
    Bidi segment offsets
    char[]
    Characters to be applied on the segment boundaries
    int
    depending on the event, the range of text being modified.
    int
    depending on the event, the state of the keyboard modifier keys and mouse masks at the time the event was generated.
    depending on the event, the new text that will be inserted.
    int
    the time that the event occurred.
    An array of the touch states for the current touch event.
    int
    the type of event, as defined by the event type constants in class SWT
    the widget that issued the event
    int
    the width of the bounding rectangle of the region that requires painting
    int
    depending on the event type, the x offset of the bounding rectangle of the region that requires painting or the widget-relative, x coordinate of the pointer at the time the mouse button was pressed or released
    int
    If nonzero, a positive value indicates a swipe to the right, and a negative value indicates a swipe to the left.
    int
    depending on the event type, the y offset of the bounding rectangle of the region that requires painting or the widget-relative, y coordinate of the pointer at the time the mouse button was pressed or released
    int
    If nonzero, a positive value indicates a swipe in the up direction, and a negative value indicates a swipe in the down direction.
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Gets the bounds.
    void
    Sets the bounds.
    Returns a string containing a concise, human-readable description of the receiver.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details

    • display

      public Display display
      the display where the event occurred
      Since:
      2.0
    • widget

      public Widget widget
      the widget that issued the event
    • type

      public int type
      the type of event, as defined by the event type constants in class SWT
      See Also:
    • detail

      public int detail
      the event specific detail field, as defined by the detail constants in class SWT
      See Also:
    • item

      public Widget item
      the item that the event occurred in (can be null)
    • index

      public int index
      the index of the item where the event occurred
      Since:
      3.2
    • gc

      public GC gc
      the graphics context to use when painting that is configured to use the colors, font and damaged region of the control. It is valid only during the paint and must not be disposed
    • x

      public int x
      depending on the event type, the x offset of the bounding rectangle of the region that requires painting or the widget-relative, x coordinate of the pointer at the time the mouse button was pressed or released
    • y

      public int y
      depending on the event type, the y offset of the bounding rectangle of the region that requires painting or the widget-relative, y coordinate of the pointer at the time the mouse button was pressed or released
    • width

      public int width
      the width of the bounding rectangle of the region that requires painting
    • height

      public int height
      the height of the bounding rectangle of the region that requires painting
    • count

      public int count
      depending on the event type, the number of following paint events that are pending which may always be zero on some platforms, or the number of lines or pages to scroll using the mouse wheel, or the number of times the mouse has been clicked
    • time

      public int time
      the time that the event occurred. NOTE: This field is an unsigned integer and should be AND'ed with 0xFFFFFFFFL so that it can be treated as a signed long.
    • button

      public int button
      the button that was pressed or released; 1 for the first button, 2 for the second button, and 3 for the third button, etc.
    • character

      public char character
      depending on the event, the character represented by the key that was typed. This is the final character that results after all modifiers have been applied. For example, when the user types Ctrl+A, the character value is 0x01 (ASCII SOH). It is important that applications do not attempt to modify the character value based on a stateMask (such as SWT.CTRL) or the resulting character will not be correct.
    • keyCode

      public int keyCode
      depending on the event, the key code of the key that was typed, as defined by the key code constants in class SWT. When the character field of the event is ambiguous, this field contains the unaffected value of the original character. For example, typing Ctrl+M or Enter both result in the character '\r' but the keyCode field will also contain '\r' when Enter was typed and 'm' when Ctrl+M was typed.
      See Also:
    • keyLocation

      public int keyLocation
      depending on the event, the location of key specified by the keyCode or character. The possible values for this field are SWT.LEFT, SWT.RIGHT, SWT.KEYPAD, or SWT.NONE representing the main keyboard area.

      The location field can be used to differentiate key events that have the same key code and character but are generated by different keys in the keyboard. For example, a key down event with the key code equals to SWT.SHIFT can be generated by the left and the right shift keys in the keyboard. The location field can only be used to determine the location of the key code or character in the current event. It does not include information about the location of modifiers in state mask.

      Since:
      3.6
      See Also:
    • stateMask

      public int stateMask
      depending on the event, the state of the keyboard modifier keys and mouse masks at the time the event was generated.
      See Also:
    • start

      public int start
      depending on the event, the range of text being modified. Setting these fields only has effect during ImeComposition events.
    • end

      public int end
      depending on the event, the range of text being modified. Setting these fields only has effect during ImeComposition events.
    • text

      public String text
      depending on the event, the new text that will be inserted. Setting this field will change the text that is about to be inserted or deleted.
    • segments

      public int[] segments
      Bidi segment offsets
      Since:
      3.8
    • segmentsChars

      public char[] segmentsChars
      Characters to be applied on the segment boundaries
      Since:
      3.8
    • doit

      public boolean doit
      depending on the event, a flag indicating whether the operation should be allowed. Setting this field to false will cancel the operation.
    • data

      public Object data
      a field for application use
    • touches

      public Touch[] touches
      An array of the touch states for the current touch event.
      Since:
      3.7
    • xDirection

      public int xDirection
      If nonzero, a positive value indicates a swipe to the right, and a negative value indicates a swipe to the left.
      Since:
      3.7
    • yDirection

      public int yDirection
      If nonzero, a positive value indicates a swipe in the up direction, and a negative value indicates a swipe in the down direction.
      Since:
      3.7
    • magnification

      public double magnification
      The change in magnification. This value should be added to the current scaling of an item to get the new scale factor.
      Since:
      3.7
    • rotation

      public double rotation
      The number of degrees rotated on the track pad.
      Since:
      3.7
  • Constructor Details

    • Event

      public Event()
  • Method Details

    • getBounds

      public Rectangle getBounds()
      Gets the bounds.
      Returns:
      a rectangle that is the bounds.
    • setBounds

      public void setBounds(Rectangle rect)
      Sets the bounds.
      Parameters:
      rect - the new rectangle
    • toString

      public String toString()
      Returns a string containing a concise, human-readable description of the receiver.
      Overrides:
      toString in class Object
      Returns:
      a string representation of the event