NativeEvent (GWT Javadoc)

Overview | Package | Class | Use | Deprecated | Help
| GWT 2.7.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.google.gwt.dom.client
Class NativeEvent

    java.lang.Object
      com.google.gwt.core.client.JavaScriptObject
          com.google.gwt.dom.client.NativeEvent

Direct Known Subclasses:
  Event

    public class NativeEvent

extends JavaScriptObject

The native dom event.

Field Summary
`static int` | `BUTTON_LEFT` The left mouse button.
`static int` | `BUTTON_MIDDLE` The middle mouse button.
`static int` | `BUTTON_RIGHT` The right mouse button.

Constructor Summary
`protected` | `NativeEvent()` Required constructor for GWT compiler to function.

Method Summary
`boolean` | `getAltKey()` Gets whether the ALT key was depressed when the given event occurred.
`int` | `getButton()` Gets the mouse buttons that were depressed when the given event occurred.
`JsArray<Touch>` | `getChangedTouches()` Get an array of touches which have changed since the last touch event.
`int` | `getCharCode()` Gets the Unicode codepoint of the character generated by this key event.
`int` | `getClientX()` Gets the mouse x-position within the browser window's client area.
`int` | `getClientY()` Gets the mouse y-position within the browser window's client area.
`boolean` | `getCtrlKey()` Gets whether the CTRL key was depressed when the given event occurred.
`EventTarget` | `getCurrentEventTarget()` Gets the current target element of this event.
`DataTransfer` | `getDataTransfer()` Get the `DataTransfer` associated with the current drag event.
`EventTarget` | `getEventTarget()` Returns the element that was the actual target of the given event.
`int` | `getKeyCode()` Gets the key code (code associated with the physical key) associated with this event.
`boolean` | `getMetaKey()` Gets whether the META key was depressed when the given event occurred.
`int` | `getMouseWheelVelocityY()` Gets the velocity of the mouse wheel associated with the event along the Y axis.
`EventTarget` | `getRelatedEventTarget()` Gets the related target for this event.
`double` | `getRotation()` Get the rotation in degrees, with positive values indicating clockwise rotation.
`double` | `getScale()` Get the amount scaled since the gesture started, with 1.0 representing no scaling.
`int` | `getScreenX()` Gets the mouse x-position on the user's display.
`int` | `getScreenY()` Gets the mouse y-position on the user's display.
`boolean` | `getShiftKey()` Gets whether the shift key was depressed when the given event occurred.
`java.lang.String` | `getString()` Gets a string representation of this event.
`JsArray<Touch>` | `getTargetTouches()` Get an array of touches which have changed since the last touch event.
`JsArray<Touch>` | `getTouches()` Get an array of touches which have changed since the last touch event.
`java.lang.String` | `getType()` Gets the enumerated type of this event.
`void` | `preventDefault()` Prevents the browser from taking its default action for the given event.
`void` | `stopPropagation()` Stops the event from being propagated to parent elements.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject
`cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Field Detail

### BUTTON_LEFT

    public static final int BUTTON_LEFT

  The left mouse button.

  See Also:
    Constant Field Values

### BUTTON_MIDDLE

    public static final int BUTTON_MIDDLE

  The middle mouse button.

  See Also:
    Constant Field Values

### BUTTON_RIGHT

    public static final int BUTTON_RIGHT

  The right mouse button.

  See Also:
    Constant Field Values

Constructor Detail

### NativeEvent

    protected NativeEvent()

  Required constructor for GWT compiler to function.

Method Detail

### getAltKey

    public final boolean getAltKey()

  Gets whether the ALT key was depressed when the given event occurred.

  Returns:
    `true` if ALT was depressed when the event occurred

### getButton

    public final int getButton()

  Gets the mouse buttons that were depressed when the given event occurred.

  Returns:
    a bit-field, defined by `BUTTON_LEFT`, `BUTTON_MIDDLE`, and `BUTTON_RIGHT`

### getChangedTouches

    public final JsArray<Touch> getChangedTouches()

  Get an array of touches which have changed since the last touch event.

  Returns:
    array of touches which have changed since the last touch event

### getCharCode

    public final int getCharCode()

  Gets the Unicode codepoint of the character generated by this key event.

  Returns:
    the Unicode codepoint.

### getClientX

    public final int getClientX()

  Gets the mouse x-position within the browser window's client area.

  Returns:
    the mouse x-position

### getClientY

    public final int getClientY()

  Gets the mouse y-position within the browser window's client area.

  Returns:
    the mouse y-position

### getCtrlKey

    public final boolean getCtrlKey()

  Gets whether the CTRL key was depressed when the given event occurred.

  Returns:
    `true` if CTRL was depressed when the event occurred

### getCurrentEventTarget

    public final EventTarget getCurrentEventTarget()

  Gets the current target element of this event. This is the element whose listener fired last, not the element which fired the event initially.

  Returns:
    the event's current target element

### getDataTransfer

    public final DataTransfer getDataTransfer()

  Get the `DataTransfer` associated with the current drag event.

  Returns:
    the `DataTransfer` object, or null if not a drag event

### getEventTarget

    public final EventTarget getEventTarget()

  Returns the element that was the actual target of the given event.

  Returns:
    the target element

### getKeyCode

    public final int getKeyCode()

  Gets the key code (code associated with the physical key) associated with this event.

  Returns:
    the key code
  See Also:
    `KeyCodes`

### getMetaKey

    public final boolean getMetaKey()

  Gets whether the META key was depressed when the given event occurred.

  Returns:
    `true` if META was depressed when the event occurred

### getMouseWheelVelocityY

    public final int getMouseWheelVelocityY()

  Gets the velocity of the mouse wheel associated with the event along the Y axis.

  The velocity of the event is an artifical measurement for relative comparisons of wheel activity. It is affected by some non-browser factors, including choice of input hardware and mouse acceleration settings. The sign of the velocity measurement agrees with the screen coordinate system; negative values are towards the origin and positive values are away from the origin. Standard scrolling speed is approximately ten units per event.

  Returns:
    The velocity of the mouse wheel.

### getRelatedEventTarget

    public final EventTarget getRelatedEventTarget()

  Gets the related target for this event.

  Returns:
    the related target

### getRotation

    public final double getRotation()

  Get the rotation in degrees, with positive values indicating clockwise rotation.

  Returns:
    the rotation in degrees since the gesture started

### getScale

    public final double getScale()

  Get the amount scaled since the gesture started, with 1.0 representing no scaling.

  Returns:
    the amount scaled since the gesture started

### getScreenX

    public final int getScreenX()

  Gets the mouse x-position on the user's display.

  Returns:
    the mouse x-position

### getScreenY

    public final int getScreenY()

  Gets the mouse y-position on the user's display.

  Returns:
    the mouse y-position

### getShiftKey

    public final boolean getShiftKey()

  Gets whether the shift key was depressed when the given event occurred.

  Returns:
    `true` if shift was depressed when the event occurred

### getString

    public final java.lang.String getString()

  Gets a string representation of this event. We do not override `JavaScriptObject.toString()` because it is final in `JavaScriptObject`.

  Returns:
    the string representation of this event

### getTargetTouches

    public final JsArray<Touch> getTargetTouches()

  Get an array of touches which have changed since the last touch event.

  Returns:
    array of touches which have changed since the last touch event

### getTouches

    public final JsArray<Touch> getTouches()

  Get an array of touches which have changed since the last touch event.

  Returns:
    array of touches which have changed since the last touch event

### getType

    public final java.lang.String getType()

  Gets the enumerated type of this event.

  Returns:
    the event's enumerated type

### preventDefault

    public final void preventDefault()

  Prevents the browser from taking its default action for the given event.

### stopPropagation

    public final void stopPropagation()

  Stops the event from being propagated to parent elements.

Overview | Package | Class | Use | Deprecated | Help
| GWT 2.7.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD