AccessibilityNodeInfo.SelectionPosition


public static final class AccessibilityNodeInfo.SelectionPosition
extends Object implements Parcelable

java.lang.Object
   ↳ android.view.accessibility.AccessibilityNodeInfo.SelectionPosition


A class which defines either the start or end of a selection that can span across multiple AccessibilityNodeInfo objects.

Summary

Inherited constants

Fields

public static final Creator<AccessibilityNodeInfo.SelectionPosition> CREATOR

Public constructors

SelectionPosition(AccessibilityNodeInfo node, int offset)

Instantiates a new SelectionPosition.

SelectionPosition(View view, int offset)

Instantiates a new SelectionPosition.

SelectionPosition(View view, int virtualDescendantId, int offset)

Instantiates a new SelectionPosition.

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object other)

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

AccessibilityNodeInfo getNode()

Gets the node for this SelectionPosition
Note: This api can only be called from AccessibilityService.

int getOffset()

Gets the offset for this SelectionPosition.

int hashCode()

Returns a hash code value for the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

Public constructors

SelectionPosition

public SelectionPosition (AccessibilityNodeInfo node, 
                int offset)

Instantiates a new SelectionPosition.

Parameters
node AccessibilityNodeInfo: The AccessibilityNodeInfo for the node of this selection. This value cannot be null.

offset int: The offset for a SelectionPosition within view's text content, which should be a value between 0 and the length of view's text.

SelectionPosition

public SelectionPosition (View view, 
                int offset)

Instantiates a new SelectionPosition.

Parameters
view View: The View containing the text associated with this selection position. This value cannot be null.

offset int: The offset for a selection position within view's text content, which should be a value between 0 and the length of view's text.

SelectionPosition

public SelectionPosition (View view, 
                int virtualDescendantId, 
                int offset)

Instantiates a new SelectionPosition.

Parameters
view View: The view whose virtual descendant is associated with the selection position. This value cannot be null.

virtualDescendantId int: The ID of the virtual descendant within view's virtual subtree that contains the selection position.

offset int: The offset for a selection position within the virtual descendant's text content, which should be a value between 0 and the length of the descendant's text.

Public methods

describeContents

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

public boolean equals (Object other)

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
other Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getNode

public AccessibilityNodeInfo getNode ()

Gets the node for this SelectionPosition
Note: This api can only be called from AccessibilityService.

Returns
AccessibilityNodeInfo The node associated with this SelectionPosition This value may be null.

getOffset

public int getOffset ()

Gets the offset for this SelectionPosition.

Returns
int A value from 0 to the length of getNode()'s content representing the offset of the SelectionPosition

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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 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 equals 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.

Returns
int a hash code value for this object.

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES