Added in API level 14

PointerProperties

class PointerProperties
kotlin.Any
   ↳ android.view.MotionEvent.PointerProperties

Transfer object for pointer properties. Objects of this type can be used to specify the pointer id and tool type when creating new MotionEvent objects and to query pointer properties in bulk.

Summary

Public constructors

Creates a pointer properties object with an invalid pointer id.

Creates a pointer properties object as a copy of the contents of another pointer properties object.

Public methods
Unit

Resets the pointer properties to their initial values.

Unit

Copies the contents of another pointer properties object.

Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.

Int

Properties
Int

The pointer id.

Int

The pointer tool type.

Public constructors

PointerProperties

Added in API level 14
PointerProperties()

Creates a pointer properties object with an invalid pointer id.

PointerProperties

Added in API level 14
PointerProperties(other: MotionEvent.PointerProperties!)

Creates a pointer properties object as a copy of the contents of another pointer properties object.

Parameters
other MotionEvent.PointerProperties!:

Public methods

clear

Added in API level 14
fun clear(): Unit

Resets the pointer properties to their initial values.

copyFrom

Added in API level 14
fun copyFrom(other: MotionEvent.PointerProperties!): Unit

Copies the contents of another pointer properties object.

Parameters
other MotionEvent.PointerProperties!: The pointer properties object to copy.

equals

Added in API level 14
fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj the reference object with which to compare.
other Any?: This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

hashCode

Added in API level 14
fun hashCode(): Int
Return
Int a hash code value for this object.

Properties

id

Added in API level 14
var id: Int

The pointer id. Initially set to INVALID_POINTER_ID (-1).