lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey

belongs to Maven artifact androidx.core:core:1.0.0-alpha3

AccessibilityNodeInfoCompat.CollectionItemInfoCompat

public static class AccessibilityNodeInfoCompat.CollectionItemInfoCompat
extends Object

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


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

Public methods

int getColumnIndex()

Gets the column index at which the item is located.

int getColumnSpan()

Gets the number of columns the item spans.

int getRowIndex()

Gets the row index at which the item is located.

int getRowSpan()

Gets the number of rows the item spans.

boolean isHeading()

This method is deprecated. Use AccessibilityNodeInfoCompat.isHeading()

boolean isSelected()

Gets if the collection item is selected.

static AccessibilityNodeInfoCompat.CollectionItemInfoCompat obtain(int rowIndex, int rowSpan, int columnIndex, int columnSpan, boolean heading)

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

static AccessibilityNodeInfoCompat.CollectionItemInfoCompat obtain(int rowIndex, int rowSpan, int columnIndex, int columnSpan, boolean heading, boolean selected)

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

Inherited methods

Public methods

getColumnIndex

public int getColumnIndex ()

Gets the column index at which the item is located.

Returns
int The column index.

getColumnSpan

public int getColumnSpan ()

Gets the number of columns the item spans.

Returns
int The column span.

getRowIndex

public int getRowIndex ()

Gets the row index at which the item is located.

Returns
int The row index.

getRowSpan

public int getRowSpan ()

Gets the number of rows the item spans.

Returns
int The row span.

isHeading

public boolean isHeading ()

This method is deprecated.
Use AccessibilityNodeInfoCompat.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

public boolean isSelected ()

Gets if the collection item is selected.

Returns
boolean If the item is selected.

obtain

public static AccessibilityNodeInfoCompat.CollectionItemInfoCompat obtain (int rowIndex, 
                int rowSpan, 
                int columnIndex, 
                int columnSpan, 
                boolean heading)

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

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. This should be set to false and the newer AccessibilityNodeInfoCompat.setHeading(boolean) used to identify headings.

Returns
AccessibilityNodeInfoCompat.CollectionItemInfoCompat An instance.

obtain

public static AccessibilityNodeInfoCompat.CollectionItemInfoCompat obtain (int rowIndex, 
                int rowSpan, 
                int columnIndex, 
                int columnSpan, 
                boolean heading, 
                boolean selected)

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

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. This should be set to false and the newer AccessibilityNodeInfoCompat.setHeading(boolean) used to identify headings.

selected boolean: Whether the item is selected.

Returns
AccessibilityNodeInfoCompat.CollectionItemInfoCompat An instance.