Join us on the livestream at Android Dev Summit on 7-8 November 2018, starting at 10AM PDT!

AccessibilityNodeInfo.CollectionInfo

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. Use obtain(int, int, boolean) to get an instance. Recycling is handled by the AccessibilityNodeInfo to which this object is attached.

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

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.

Public methods

int getColumnCount()

Gets the number of columns.

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)

Obtains a pooled instance.

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

Obtains a pooled instance.

Inherited methods

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)

Public methods

getColumnCount

added in API level 19
public int getColumnCount ()

Gets the number of columns.

Returns
int The column count.

getRowCount

added in API level 19
public int getRowCount ()

Gets the number of rows.

Returns
int The row count.

getSelectionMode

added in API level 21
public int getSelectionMode ()

Gets the collection's selection mode.

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

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
public static AccessibilityNodeInfo.CollectionInfo obtain (int rowCount, 
                int columnCount, 
                boolean hierarchical, 
                int selectionMode)

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:

Returns
AccessibilityNodeInfo.CollectionInfo

obtain

added in API level 19
public static AccessibilityNodeInfo.CollectionInfo obtain (int rowCount, 
                int columnCount, 
                boolean hierarchical)

Obtains a pooled instance.

Parameters
rowCount int: The number of rows.

columnCount int: The number of columns.

hierarchical boolean: Whether the collection is hierarchical.

Returns
AccessibilityNodeInfo.CollectionInfo