AccessibilityNodeInfoCompat.CollectionInfoCompat

public static class AccessibilityNodeInfoCompat.CollectionInfoCompat
extends Object

java.lang.Object
   ↳ androidx.core.view.accessibility.AccessibilityNodeInfoCompat.CollectionInfoCompat


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

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 AccessibilityNodeInfoCompat.CollectionInfoCompat obtain(int rowCount, int columnCount, boolean hierarchical, int selectionMode)

Returns a cached instance if such is available otherwise a new one.

static AccessibilityNodeInfoCompat.CollectionInfoCompat obtain(int rowCount, int columnCount, boolean hierarchical)

Returns a cached instance if such is available otherwise a new one.

Inherited methods

Constants

SELECTION_MODE_MULTIPLE

public static final int SELECTION_MODE_MULTIPLE

Selection mode where multiple items may be selected.

Constant Value: 2 (0x00000002)

SELECTION_MODE_NONE

public static final int SELECTION_MODE_NONE

Selection mode where items are not selectable.

Constant Value: 0 (0x00000000)

SELECTION_MODE_SINGLE

public static final int SELECTION_MODE_SINGLE

Selection mode where a single item may be selected.

Constant Value: 1 (0x00000001)

Public methods

getColumnCount

public int getColumnCount ()

Gets the number of columns.

Returns
int The column count.

getRowCount

public int getRowCount ()

Gets the number of rows.

Returns
int The row count.

getSelectionMode

public int getSelectionMode ()

Gets the collection's selection mode.

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

isHierarchical

public boolean isHierarchical ()

Gets if the collection is a hierarchically ordered.

Returns
boolean Whether the collection is hierarchical.

obtain

public static AccessibilityNodeInfoCompat.CollectionInfoCompat obtain (int rowCount, 
                int columnCount, 
                boolean hierarchical, 
                int selectionMode)

Returns a cached instance if such is available otherwise a new one.

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
AccessibilityNodeInfoCompat.CollectionInfoCompat An instance.

obtain

public static AccessibilityNodeInfoCompat.CollectionInfoCompat obtain (int rowCount, 
                int columnCount, 
                boolean hierarchical)

Returns a cached instance if such is available otherwise a new one.

Parameters
rowCount int: The number of rows.

columnCount int: The number of columns.

hierarchical boolean: Whether the collection is hierarchical.

Returns
AccessibilityNodeInfoCompat.CollectionInfoCompat An instance.