Added in API level 19

Summary: Nested Classes | Constants | Ctors | Methods | Inherited Methods

AccessibilityNodeInfo.CollectionInfo

---

Kotlin |Java

public static final class AccessibilityNodeInfo.CollectionInfo
extends Object

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

---

Class with information if a node is a collection.

A collection of items has rows and columns and may be hierarchical. For example, a horizontal list is a collection with one column, as many rows as the list items, and is not hierarchical; A table is a collection with several rows, several columns, and is not hierarchical; A vertical tree is a hierarchical collection with one column and as many rows as the first level children.

Summary

Nested classes
class	AccessibilityNodeInfo.CollectionInfo.Builder The builder for CollectionInfo.

Constants
int	SELECTION_MODE_MULTIPLE Selection mode where multiple items may be selected.
int	SELECTION_MODE_NONE Selection mode where items are not selectable.
int	SELECTION_MODE_SINGLE Selection mode where a single item may be selected.
int	UNDEFINED Constant to denote a missing collection count.

Public constructors
CollectionInfo(int rowCount, int columnCount, boolean hierarchical) Creates a new instance.
CollectionInfo(int rowCount, int columnCount, boolean hierarchical, int selectionMode) Creates a new instance.

Public methods
int	getColumnCount() Gets the number of columns.
int	getImportantForAccessibilityItemCount() Gets the number of items in the collection considered important for accessibility.
int	getItemCount() Gets the number of items in the collection.
int	getRowCount() Gets the number of rows.
int	getSelectionMode() Gets the collection's selection mode.
boolean	isHierarchical() Gets if the collection is a hierarchically ordered.
static AccessibilityNodeInfo.CollectionInfo	obtain(int rowCount, int columnCount, boolean hierarchical, int selectionMode) This method was deprecated in API level 33. Object pooling has been discontinued. Create a new instance using the constructor CollectionInfo(int, int, boolean, int) instead.
static AccessibilityNodeInfo.CollectionInfo	obtain(int rowCount, int columnCount, boolean hierarchical) This method was deprecated in API level 33. Object pooling has been discontinued. Create a new instance using the constructor CollectionInfo(int, int, boolean) instead.

Inherited methods

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

SELECTION_MODE_MULTIPLE

Added in API level 21

public static final int SELECTION_MODE_MULTIPLE

Selection mode where multiple items may be selected.

Constant Value: 2 (0x00000002)

SELECTION_MODE_NONE

Added in API level 21

public static final int SELECTION_MODE_NONE

Selection mode where items are not selectable.

Constant Value: 0 (0x00000000)

SELECTION_MODE_SINGLE

Added in API level 21

public static final int SELECTION_MODE_SINGLE

Selection mode where a single item may be selected.

Constant Value: 1 (0x00000001)

UNDEFINED

Added in API level 35

public static final int UNDEFINED

Constant to denote a missing collection count. This should be used for mItemCount and mImportantForAccessibilityItemCount when values for those fields are not known.

Constant Value: -1 (0xffffffff)

Public constructors

CollectionInfo

Added in API level 30

public CollectionInfo (int rowCount, 
                int columnCount, 
                boolean hierarchical)

Creates a new instance.

Parameters
rowCount	int: The number of rows.
columnCount	int: The number of columns.
hierarchical	boolean: Whether the collection is hierarchical.

CollectionInfo

Added in API level 30

public CollectionInfo (int rowCount, 
                int columnCount, 
                boolean hierarchical, 
                int selectionMode)

Creates a new instance.

Parameters
rowCount	int: The number of rows.
columnCount	int: The number of columns.
hierarchical	boolean: Whether the collection is hierarchical.
selectionMode	int: The collection's selection mode.

Public methods

getColumnCount

Added in API level 19

public int getColumnCount ()

Gets the number of columns.

Returns
int	The column count, or -1 if count is unknown.

getImportantForAccessibilityItemCount

Added in API level 35

public int getImportantForAccessibilityItemCount ()

Gets the number of items in the collection considered important for accessibility.

Returns
int	The count of items important for accessibility, which may be UNDEFINED if the count is not known.

getItemCount

Added in API level 35

public int getItemCount ()

Gets the number of items in the collection.

Returns
int	The count of items, which may be UNDEFINED if the count is not known.

getRowCount

Added in API level 19

public int getRowCount ()

Gets the number of rows.

Returns
int	The row count, or -1 if count is unknown.

getSelectionMode

Added in API level 21

public int getSelectionMode ()

Gets the collection's selection mode.

Returns
int	The collection's selection mode, one of: SELECTION_MODE_NONE SELECTION_MODE_SINGLE SELECTION_MODE_MULTIPLE

isHierarchical

Added in API level 19

public boolean isHierarchical ()

Gets if the collection is a hierarchically ordered.

Returns
boolean	Whether the collection is hierarchical.

obtain

Added in API level 21
Deprecated in API level 33

public static AccessibilityNodeInfo.CollectionInfo obtain (int rowCount, 
                int columnCount, 
                boolean hierarchical, 
                int selectionMode)

This method was deprecated in API level 33.
Object pooling has been discontinued. Create a new instance using the constructor CollectionInfo(int, int, boolean, int) instead.

Obtains a pooled instance.

Parameters
rowCount	int: The number of rows.
columnCount	int: The number of columns.
hierarchical	boolean: Whether the collection is hierarchical.
selectionMode	int: The collection's selection mode, one of: SELECTION_MODE_NONE SELECTION_MODE_SINGLE SELECTION_MODE_MULTIPLE

Returns
AccessibilityNodeInfo.CollectionInfo

obtain

Added in API level 19
Deprecated in API level 33

public static AccessibilityNodeInfo.CollectionInfo obtain (int rowCount, 
                int columnCount, 
                boolean hierarchical)

This method was deprecated in API level 33.
Object pooling has been discontinued. Create a new instance using the constructor CollectionInfo(int, int, boolean) instead.

Obtains a pooled instance.

Parameters
rowCount	int: The number of rows, or -1 if count is unknown.
columnCount	int: The number of columns, or -1 if count is unknown.
hierarchical	boolean: Whether the collection is hierarchical.

Returns
AccessibilityNodeInfo.CollectionInfo