AccessibilityNodeInfo.CollectionItemInfo

public static final class AccessibilityNodeInfo.CollectionItemInfo
extends Object

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


Class with information if a node is a collection item.

A collection item is contained in a collection, it starts at a given row and column in the collection, and spans one or more rows and columns. For example, a header of two related table columns starts at the first row and the first column, spans one row and two columns.

Summary

Nested classes

class AccessibilityNodeInfo.CollectionItemInfo.Builder

Builder for creating CollectionItemInfo objects. 

Public constructors

CollectionItemInfo(int rowIndex, int rowSpan, int columnIndex, int columnSpan, boolean heading)

Creates a new instance.

CollectionItemInfo(int rowIndex, int rowSpan, int columnIndex, int columnSpan, boolean heading, boolean selected)

Creates a new instance.

Public methods

int getColumnIndex()

Gets the column index at which the item is located.

int getColumnSpan()

Gets the number of columns the item spans.

String getColumnTitle()

Gets the column title at which the item is located.

int getRowIndex()

Gets the row index at which the item is located.

int getRowSpan()

Gets the number of rows the item spans.

String getRowTitle()

Gets the row title at which the item is located.

boolean isHeading()

This method was deprecated in API level 28. Use AccessibilityNodeInfo#isHeading()

boolean isSelected()

Gets if the collection item is selected.

static AccessibilityNodeInfo.CollectionItemInfo obtain(int rowIndex, int rowSpan, int columnIndex, int columnSpan, boolean heading)

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

static AccessibilityNodeInfo.CollectionItemInfo obtain(int rowIndex, int rowSpan, int columnIndex, int columnSpan, boolean heading, boolean selected)

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

Inherited methods

Public constructors

CollectionItemInfo

Added in API level 19
public CollectionItemInfo (int rowIndex, 
                int rowSpan, 
                int columnIndex, 
                int columnSpan, 
                boolean heading)

Creates a new instance.

Parameters
rowIndex int: The row index at which the item is located.

rowSpan int: The number of rows the item spans.

columnIndex int: The column index at which the item is located.

columnSpan int: The number of columns the item spans.

heading boolean: Whether the item is a heading.

CollectionItemInfo

Added in API level 19
public CollectionItemInfo (int rowIndex, 
                int rowSpan, 
                int columnIndex, 
                int columnSpan, 
                boolean heading, 
                boolean selected)

Creates a new instance.

Parameters
rowIndex int: The row index at which the item is located.

rowSpan int: The number of rows the item spans.

columnIndex int: The column index at which the item is located.

columnSpan int: The number of columns the item spans.

heading boolean: Whether the item is a heading.

selected boolean: Whether the item is selected.

Public methods

getColumnIndex

Added in API level 19
public int getColumnIndex ()

Gets the column index at which the item is located.

Returns
int The column index.

getColumnSpan

Added in API level 19
public int getColumnSpan ()

Gets the number of columns the item spans.

Returns
int The column span.

getColumnTitle

Added in API level 33
public String getColumnTitle ()

Gets the column title at which the item is located.

Returns
String The column title. This value may be null.

getRowIndex

Added in API level 19
public int getRowIndex ()

Gets the row index at which the item is located.

Returns
int The row index.

getRowSpan

Added in API level 19
public int getRowSpan ()

Gets the number of rows the item spans.

Returns
int The row span.

getRowTitle

Added in API level 33
public String getRowTitle ()

Gets the row title at which the item is located.

Returns
String The row title. This value may be null.

isHeading

Added in API level 19
Deprecated in API level 28
public boolean isHeading ()

This method was deprecated in API level 28.
Use AccessibilityNodeInfo#isHeading()

Gets if the collection item is a heading. For example, section heading, table header, etc.

Returns
boolean If the item is a heading.

isSelected

Added in API level 21
public boolean isSelected ()

Gets if the collection item is selected.

Returns
boolean If the item is selected.

obtain

Added in API level 19
Deprecated in API level 33
public static AccessibilityNodeInfo.CollectionItemInfo obtain (int rowIndex, 
                int rowSpan, 
                int columnIndex, 
                int columnSpan, 
                boolean heading)

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

Instantiates a new CollectionItemInfo.

Parameters
rowIndex int: The row index at which the item is located.

rowSpan int: The number of rows the item spans.

columnIndex int: The column index at which the item is located.

columnSpan int: The number of columns the item spans.

heading boolean: Whether the item is a heading. (Prefer AccessibilityNodeInfo#setHeading(boolean)).

Returns
AccessibilityNodeInfo.CollectionItemInfo

obtain

Added in API level 21
Deprecated in API level 33
public static AccessibilityNodeInfo.CollectionItemInfo obtain (int rowIndex, 
                int rowSpan, 
                int columnIndex, 
                int columnSpan, 
                boolean heading, 
                boolean selected)

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

Instantiates a new CollectionItemInfo.

Parameters
rowIndex int: The row index at which the item is located.

rowSpan int: The number of rows the item spans.

columnIndex int: The column index at which the item is located.

columnSpan int: The number of columns the item spans.

heading boolean: Whether the item is a heading. (Prefer AccessibilityNodeInfo#setHeading(boolean)).

selected boolean: Whether the item is selected.

Returns
AccessibilityNodeInfo.CollectionItemInfo