java.lang.Object | |
↳ | android.view.MotionEvent |
Object used to report movement (mouse, pen, finger, trackball) events. This class may hold either absolute or relative movements, depending on what it is being used for.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | ACTION_CANCEL | Constant for getAction() : The current gesture has been aborted. |
|||||||||
int | ACTION_DOWN | Constant for getAction() : A pressed gesture has started, the
motion contains the initial starting location. |
|||||||||
int | ACTION_MASK | Bit mask of the parts of the action code that are the action itself. | |||||||||
int | ACTION_MOVE | Constant for getAction() : A change has happened during a
press gesture (between ACTION_DOWN and ACTION_UP ). |
|||||||||
int | ACTION_OUTSIDE | Constant for getAction() : A movement has happened outside of the
normal bounds of the UI element. |
|||||||||
int | ACTION_POINTER_1_DOWN | Synonym for ACTION_POINTER_DOWN with
ACTION_POINTER_ID_MASK of 0: the primary pointer has gone done. |
|||||||||
int | ACTION_POINTER_1_UP | Synonym for ACTION_POINTER_UP with
ACTION_POINTER_ID_MASK of 0: the primary pointer has gone up. |
|||||||||
int | ACTION_POINTER_2_DOWN | Synonym for ACTION_POINTER_DOWN with
ACTION_POINTER_ID_MASK of 1: the secondary pointer has gone done. |
|||||||||
int | ACTION_POINTER_2_UP | Synonym for ACTION_POINTER_UP with
ACTION_POINTER_ID_MASK of 1: the secondary pointer has gone up. |
|||||||||
int | ACTION_POINTER_3_DOWN | Synonym for ACTION_POINTER_DOWN with
ACTION_POINTER_ID_MASK of 2: the tertiary pointer has gone done. |
|||||||||
int | ACTION_POINTER_3_UP | Synonym for ACTION_POINTER_UP with
ACTION_POINTER_ID_MASK of 2: the tertiary pointer has gone up. |
|||||||||
int | ACTION_POINTER_DOWN | A non-primary pointer has gone down. | |||||||||
int | ACTION_POINTER_ID_MASK | Bits in the action code that represent a pointer ID, used with
ACTION_POINTER_DOWN and ACTION_POINTER_UP . |
|||||||||
int | ACTION_POINTER_ID_SHIFT | Bit shift for the action bits holding the pointer identifier as
defined by ACTION_POINTER_ID_MASK . |
|||||||||
int | ACTION_POINTER_UP | A non-primary pointer has gone up. | |||||||||
int | ACTION_UP | Constant for getAction() : A pressed gesture has finished, the
motion contains the final release location as well as any intermediate
points since the last down or move event. |
|||||||||
Creator<MotionEvent> | CREATOR | ||||||||||
int | EDGE_BOTTOM | Flag indicating the motion event intersected the bottom edge of the screen. | |||||||||
int | EDGE_LEFT | Flag indicating the motion event intersected the left edge of the screen. | |||||||||
int | EDGE_RIGHT | Flag indicating the motion event intersected the right edge of the screen. | |||||||||
int | EDGE_TOP | Flag indicating the motion event intersected the top edge of the screen. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface
android.os.Parcelable
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Add a new movement to the batch of movements in this event.
| |||||||||||
Describe the kinds of special objects contained in this Parcelable's
marshalled representation.
| |||||||||||
Given a pointer identifier, find the index of its data in the event.
| |||||||||||
Return the kind of action being performed -- one of either
ACTION_DOWN , ACTION_MOVE , ACTION_UP , or
ACTION_CANCEL . | |||||||||||
Return the id for the device that this event came from.
| |||||||||||
Returns the time (in ms) when the user originally pressed down to start
a stream of position events.
| |||||||||||
Returns a bitfield indicating which edges, if any, where touched by this
MotionEvent.
| |||||||||||
Returns the time (in ms) when this specific event was generated.
| |||||||||||
Returns the time that a historical movement occurred between this event
and the previous event.
| |||||||||||
Returns a historical pressure coordinate, as per
getPressure(int) ,
that occurred between this event and the previous event for the given
pointer. | |||||||||||
getHistoricalPressure(int) for the first pointer index (may be an
arbitrary pointer identifier). | |||||||||||
getHistoricalSize(int) for the first pointer index (may be an
arbitrary pointer identifier). | |||||||||||
Returns a historical size coordinate, as per
getSize(int) , that
occurred between this event and the previous event for the given pointer. | |||||||||||
getHistoricalX(int) for the first pointer index (may be an
arbitrary pointer identifier). | |||||||||||
Returns a historical X coordinate, as per
getX(int) , that
occurred between this event and the previous event for the given pointer. | |||||||||||
Returns a historical Y coordinate, as per
getY(int) , that
occurred between this event and the previous event for the given pointer. | |||||||||||
getHistoricalY(int) for the first pointer index (may be an
arbitrary pointer identifier). | |||||||||||
Returns the number of historical points in this event.
| |||||||||||
Returns the state of any meta / modifier keys that were in effect when
the event was generated.
| |||||||||||
The number of pointers of data contained in this event.
| |||||||||||
Return the pointer identifier associated with a particular pointer
data index is this event.
| |||||||||||
getPressure(int) for the first pointer index (may be an
arbitrary pointer identifier). | |||||||||||
Returns the current pressure of this event for the given pointer
index (use
getPointerId(int) to find the pointer
identifier for this index). | |||||||||||
Returns the original raw X coordinate of this event.
| |||||||||||
Returns the original raw Y coordinate of this event.
| |||||||||||
getSize(int) for the first pointer index (may be an
arbitrary pointer identifier). | |||||||||||
Returns a scaled value of the approximate size for the given pointer
index (use
getPointerId(int) to find the pointer
identifier for this index). | |||||||||||
getX(int) for the first pointer index (may be an
arbitrary pointer identifier). | |||||||||||
Returns the X coordinate of this event for the given pointer
index (use
getPointerId(int) to find the pointer
identifier for this index). | |||||||||||
Return the precision of the X coordinates being reported.
| |||||||||||
Returns the Y coordinate of this event for the given pointer
index (use
getPointerId(int) to find the pointer
identifier for this index). | |||||||||||
getY(int) for the first pointer index (may be an
arbitrary pointer identifier). | |||||||||||
Return the precision of the Y coordinates being reported.
| |||||||||||
Create a new MotionEvent, copying from an existing one.
| |||||||||||
Create a new MotionEvent, filling in a subset of the basic motion
values.
| |||||||||||
Create a new MotionEvent, filling in all of the basic values that
define the motion.
| |||||||||||
Create a new MotionEvent, filling in all of the basic values that
define the motion.
| |||||||||||
Create a new MotionEvent, copying from an existing one, but not including
any historical point information.
| |||||||||||
Adjust this event's location.
| |||||||||||
Recycle the MotionEvent, to be re-used by a later caller.
| |||||||||||
Sets this event's action.
| |||||||||||
Sets the bitfield indicating which edges, if any, where touched by this
MotionEvent.
| |||||||||||
Set this event's location.
| |||||||||||
Returns a string containing a concise, human-readable description of this
object.
| |||||||||||
Flatten this object in to a Parcel.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class java.lang.Object
| |||||||||||
From interface android.os.Parcelable
|
Constant for getAction()
: The current gesture has been aborted.
You will not receive any more points in it. You should treat this as
an up event, but not perform any action that you normally would.
Constant for getAction()
: A pressed gesture has started, the
motion contains the initial starting location.
Bit mask of the parts of the action code that are the action itself.
Constant for getAction()
: A change has happened during a
press gesture (between ACTION_DOWN
and ACTION_UP
).
The motion contains the most recent point, as well as any intermediate
points since the last down or move event.
Constant for getAction()
: A movement has happened outside of the
normal bounds of the UI element. This does not provide a full gesture,
but only the initial location of the movement/touch.
Synonym for ACTION_POINTER_DOWN
with
ACTION_POINTER_ID_MASK
of 0: the primary pointer has gone done.
Synonym for ACTION_POINTER_UP
with
ACTION_POINTER_ID_MASK
of 0: the primary pointer has gone up.
Synonym for ACTION_POINTER_DOWN
with
ACTION_POINTER_ID_MASK
of 1: the secondary pointer has gone done.
Synonym for ACTION_POINTER_UP
with
ACTION_POINTER_ID_MASK
of 1: the secondary pointer has gone up.
Synonym for ACTION_POINTER_DOWN
with
ACTION_POINTER_ID_MASK
of 2: the tertiary pointer has gone done.
Synonym for ACTION_POINTER_UP
with
ACTION_POINTER_ID_MASK
of 2: the tertiary pointer has gone up.
A non-primary pointer has gone down. The bits in
ACTION_POINTER_ID_MASK
indicate which pointer changed.
Bits in the action code that represent a pointer ID, used with
ACTION_POINTER_DOWN
and ACTION_POINTER_UP
. Pointer IDs
start at 0, with 0 being the primary (first) pointer in the motion. Note
that this not not an index into the array of pointer values,
which is compacted to only contain pointers that are down; the pointer
ID for a particular index can be found with findPointerIndex(int)
.
Bit shift for the action bits holding the pointer identifier as
defined by ACTION_POINTER_ID_MASK
.
A non-primary pointer has gone up. The bits in
ACTION_POINTER_ID_MASK
indicate which pointer changed.
Constant for getAction()
: A pressed gesture has finished, the
motion contains the final release location as well as any intermediate
points since the last down or move event.
Flag indicating the motion event intersected the bottom edge of the screen.
Flag indicating the motion event intersected the left edge of the screen.
Flag indicating the motion event intersected the right edge of the screen.
Flag indicating the motion event intersected the top edge of the screen.
Add a new movement to the batch of movements in this event. The event's current location, position and size is updated to the new values. In the future, the current values in the event will be added to a list of historic values.
eventTime | The time stamp for this data. |
---|---|
x | The new X position. |
y | The new Y position. |
pressure | The new pressure. |
size | The new size. |
metaState | Meta key state. |
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
Given a pointer identifier, find the index of its data in the event.
pointerId | The identifier of the pointer to be found. |
---|
Return the kind of action being performed -- one of either
ACTION_DOWN
, ACTION_MOVE
, ACTION_UP
, or
ACTION_CANCEL
.
Return the id for the device that this event came from. An id of zero indicates that the event didn't come from a physical device; other numbers are arbitrary and you shouldn't depend on the values.
Returns the time (in ms) when the user originally pressed down to start a stream of position events.
Returns a bitfield indicating which edges, if any, where touched by this MotionEvent. For touch events, clients can use this to determine if the user's finger was touching the edge of the display.
Returns the time (in ms) when this specific event was generated.
Returns the time that a historical movement occurred between this event and the previous event. Only applies to ACTION_MOVE events.
pos | Which historical value to return; must be less than
getHistorySize() |
---|
Returns a historical pressure coordinate, as per getPressure(int)
,
that occurred between this event and the previous event for the given
pointer. Only applies to ACTION_MOVE events.
pointerIndex | Raw index of pointer to retrieve. Value may be from 0
(the first pointer that is down) to getPointerCount() -1. |
---|---|
pos | Which historical value to return; must be less than
getHistorySize() |
getHistoricalPressure(int)
for the first pointer index (may be an
arbitrary pointer identifier).
getHistoricalSize(int)
for the first pointer index (may be an
arbitrary pointer identifier).
Returns a historical size coordinate, as per getSize(int)
, that
occurred between this event and the previous event for the given pointer.
Only applies to ACTION_MOVE events.
pointerIndex | Raw index of pointer to retrieve. Value may be from 0
(the first pointer that is down) to getPointerCount() -1. |
---|---|
pos | Which historical value to return; must be less than
getHistorySize() |
getHistoricalX(int)
for the first pointer index (may be an
arbitrary pointer identifier).
Returns a historical X coordinate, as per getX(int)
, that
occurred between this event and the previous event for the given pointer.
Only applies to ACTION_MOVE events.
pointerIndex | Raw index of pointer to retrieve. Value may be from 0
(the first pointer that is down) to getPointerCount() -1. |
---|---|
pos | Which historical value to return; must be less than
getHistorySize() |
Returns a historical Y coordinate, as per getY(int)
, that
occurred between this event and the previous event for the given pointer.
Only applies to ACTION_MOVE events.
pointerIndex | Raw index of pointer to retrieve. Value may be from 0
(the first pointer that is down) to getPointerCount() -1. |
---|---|
pos | Which historical value to return; must be less than
getHistorySize() |
getHistoricalY(int)
for the first pointer index (may be an
arbitrary pointer identifier).
Returns the number of historical points in this event. These are movements that have occurred between this event and the previous event. This only applies to ACTION_MOVE events -- all other actions will have a size of 0.
Returns the state of any meta / modifier keys that were in effect when
the event was generated. This is the same values as those
returned by KeyEvent.getMetaState
.
The number of pointers of data contained in this event. Always >= 1.
Return the pointer identifier associated with a particular pointer data index is this event. The identifier tells you the actual pointer number associated with the data, accounting for individual pointers going up and down since the start of the current gesture.
pointerIndex | Raw index of pointer to retrieve. Value may be from 0
(the first pointer that is down) to getPointerCount() -1.
|
---|
getPressure(int)
for the first pointer index (may be an
arbitrary pointer identifier).
Returns the current pressure of this event for the given pointer
index (use getPointerId(int)
to find the pointer
identifier for this index).
The pressure generally
ranges from 0 (no pressure at all) to 1 (normal pressure), however
values higher than 1 may be generated depending on the calibration of
the input device.
pointerIndex | Raw index of pointer to retrieve. Value may be from 0
(the first pointer that is down) to getPointerCount() -1.
|
---|
Returns the original raw X coordinate of this event. For touch events on the screen, this is the original location of the event on the screen, before it had been adjusted for the containing window and views.
Returns the original raw Y coordinate of this event. For touch events on the screen, this is the original location of the event on the screen, before it had been adjusted for the containing window and views.
getSize(int)
for the first pointer index (may be an
arbitrary pointer identifier).
Returns a scaled value of the approximate size for the given pointer
index (use getPointerId(int)
to find the pointer
identifier for this index).
This represents some approximation of the area of the screen being
pressed; the actual value in pixels corresponding to the
touch is normalized with the device specific range of values
and scaled to a value between 0 and 1. The value of size can be used to
determine fat touch events.
pointerIndex | Raw index of pointer to retrieve. Value may be from 0
(the first pointer that is down) to getPointerCount() -1.
|
---|
getX(int)
for the first pointer index (may be an
arbitrary pointer identifier).
Returns the X coordinate of this event for the given pointer
index (use getPointerId(int)
to find the pointer
identifier for this index).
Whole numbers are pixels; the
value may have a fraction for input devices that are sub-pixel precise.
pointerIndex | Raw index of pointer to retrieve. Value may be from 0
(the first pointer that is down) to getPointerCount() -1.
|
---|
Return the precision of the X coordinates being reported. You can
multiple this number with getX()
to find the actual hardware
value of the X coordinate.
Returns the Y coordinate of this event for the given pointer
index (use getPointerId(int)
to find the pointer
identifier for this index).
Whole numbers are pixels; the
value may have a fraction for input devices that are sub-pixel precise.
pointerIndex | Raw index of pointer to retrieve. Value may be from 0
(the first pointer that is down) to getPointerCount() -1.
|
---|
getY(int)
for the first pointer index (may be an
arbitrary pointer identifier).
Return the precision of the Y coordinates being reported. You can
multiple this number with getY()
to find the actual hardware
value of the Y coordinate.
Create a new MotionEvent, copying from an existing one.
Create a new MotionEvent, filling in a subset of the basic motion values. Those not specified here are: device id (always 0), pressure and size (always 1), x and y precision (always 1), and edgeFlags (always 0).
downTime | The time (in ms) when the user originally pressed down to start
a stream of position events. This must be obtained from uptimeMillis() . |
---|---|
eventTime | The the time (in ms) when this specific event was generated. This
must be obtained from uptimeMillis() . |
action | The kind of action being performed -- one of either
ACTION_DOWN , ACTION_MOVE , ACTION_UP , or
ACTION_CANCEL . |
x | The X coordinate of this event. |
y | The Y coordinate of this event. |
metaState | The state of any meta / modifier keys that were in effect when the event was generated. |
Create a new MotionEvent, filling in all of the basic values that define the motion.
downTime | The time (in ms) when the user originally pressed down to start
a stream of position events. This must be obtained from uptimeMillis() . |
---|---|
eventTime | The the time (in ms) when this specific event was generated. This
must be obtained from uptimeMillis() . |
action | The kind of action being performed -- one of either
ACTION_DOWN , ACTION_MOVE , ACTION_UP , or
ACTION_CANCEL . |
x | The X coordinate of this event. |
y | The Y coordinate of this event. |
pressure | The current pressure of this event. The pressure generally ranges from 0 (no pressure at all) to 1 (normal pressure), however values higher than 1 may be generated depending on the calibration of the input device. |
size | A scaled value of the approximate size of the area being pressed when touched with the finger. The actual value in pixels corresponding to the finger touch is normalized with a device specific range of values and scaled to a value between 0 and 1. |
metaState | The state of any meta / modifier keys that were in effect when the event was generated. |
xPrecision | The precision of the X coordinate being reported. |
yPrecision | The precision of the Y coordinate being reported. |
deviceId | The id for the device that this event came from. An id of zero indicates that the event didn't come from a physical device; other numbers are arbitrary and you shouldn't depend on the values. |
edgeFlags | A bitfield indicating which edges, if any, where touched by this MotionEvent. |
Create a new MotionEvent, filling in all of the basic values that define the motion.
downTime | The time (in ms) when the user originally pressed down to start
a stream of position events. This must be obtained from uptimeMillis() . |
---|---|
eventTime | The the time (in ms) when this specific event was generated. This
must be obtained from uptimeMillis() . |
action | The kind of action being performed -- one of either
ACTION_DOWN , ACTION_MOVE , ACTION_UP , or
ACTION_CANCEL . |
pointers | The number of pointers that are active in this event. |
x | The X coordinate of this event. |
y | The Y coordinate of this event. |
pressure | The current pressure of this event. The pressure generally ranges from 0 (no pressure at all) to 1 (normal pressure), however values higher than 1 may be generated depending on the calibration of the input device. |
size | A scaled value of the approximate size of the area being pressed when touched with the finger. The actual value in pixels corresponding to the finger touch is normalized with a device specific range of values and scaled to a value between 0 and 1. |
metaState | The state of any meta / modifier keys that were in effect when the event was generated. |
xPrecision | The precision of the X coordinate being reported. |
yPrecision | The precision of the Y coordinate being reported. |
deviceId | The id for the device that this event came from. An id of zero indicates that the event didn't come from a physical device; other numbers are arbitrary and you shouldn't depend on the values. |
edgeFlags | A bitfield indicating which edges, if any, where touched by this MotionEvent. |
Create a new MotionEvent, copying from an existing one, but not including any historical point information.
Adjust this event's location.
deltaX | Amount to add to the current X coordinate of the event. |
---|---|
deltaY | Amount to add to the current Y coordinate of the event. |
Recycle the MotionEvent, to be re-used by a later caller. After calling this function you must not ever touch the event again.
Sets the bitfield indicating which edges, if any, where touched by this MotionEvent.
Set this event's location. Applies offsetLocation(float, float)
with a
delta from the current location to the given new location.
x | New absolute X location. |
---|---|
y | New absolute Y location. |
Returns a string containing a concise, human-readable description of this
object. Subclasses are encouraged to override this method and provide an
implementation that takes into account the object's type and data. The
default implementation simply concatenates the class name, the '@' sign
and a hexadecimal representation of the object's hashCode()
,
that is, it is equivalent to the following expression:
getClass().getName() + '@' + Integer.toHexString(hashCode())
Flatten this object in to a Parcel.
out | The Parcel in which the object should be written. |
---|---|
flags | Additional flags about how the object should be written.
May be 0 or PARCELABLE_WRITE_RETURN_VALUE .
|