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.
Requires API level 14 (Android 4.0, IceCreamSandwich)

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
Int

Returns a hash code value for the object.

Unit

Resets the pointer properties to their initial values.

Boolean
equals(other: Any?)

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

Unit

Copies the contents of another pointer properties object.

Properties
Int

The pointer id.

Int

The pointer tool type.

Public constructors

<init>

PointerProperties()

Creates a pointer properties object with an invalid pointer id.

<init>

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

hashCode

added in API level 14
fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the java.lang.Object#equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.) Requires API level 14 (Android 4.0, IceCreamSandwich)

Return
Int: a hash code value for this object.

clear

added in API level 14
fun clear(): Unit

Resets the pointer properties to their initial values.
Requires API level 14 (Android 4.0, IceCreamSandwich)

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes. Requires API level 14 (Android 4.0, IceCreamSandwich)

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

copyFrom

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

Copies the contents of another pointer properties object.
Requires API level 14 (Android 4.0, IceCreamSandwich)

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

Properties

id

added in API level 14
var id: Int

The pointer id. Initially set to #INVALID_POINTER_ID (-1).
Requires API level 14 (Android 4.0, IceCreamSandwich)

toolType

added in API level 14
var toolType: Int

The pointer tool type. Initially set to 0.
Requires API level 14 (Android 4.0, IceCreamSandwich)