Added in API level 19

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

AccessibilityNodeInfo.CollectionItemInfo

Kotlin |Java

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.

Constants
`int`	`SORT_DIRECTION_ASCENDING` Items are sorted in ascending order (e.g., A-Z, 0-9).
`int`	`SORT_DIRECTION_DESCENDING` Items are sorted in descending order (e.g., Z-A, 9-0).
`int`	`SORT_DIRECTION_NONE` There is no sort direction.
`int`	`SORT_DIRECTION_OTHER` Items are sorted, but using a method other than ascending or descending (e.g., based on relevance or a custom algorithm).

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.
`int`	`getSortDirection()` Gets the sort direction applied to the data associated with this node.
`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

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

SORT_DIRECTION_ASCENDING

Added in Android Baklava

public static final int SORT_DIRECTION_ASCENDING

Items are sorted in ascending order (e.g., A-Z, 0-9).

See also:

Constant Value: 1 (0x00000001)

SORT_DIRECTION_DESCENDING

Added in Android Baklava

public static final int SORT_DIRECTION_DESCENDING

Items are sorted in descending order (e.g., Z-A, 9-0).

See also:

Constant Value: 2 (0x00000002)

SORT_DIRECTION_NONE

Added in Android Baklava

public static final int SORT_DIRECTION_NONE

There is no sort direction.

See also:

Constant Value: 0 (0x00000000)

SORT_DIRECTION_OTHER

Added in Android Baklava

public static final int SORT_DIRECTION_OTHER

Items are sorted, but using a method other than ascending or descending (e.g., based on relevance or a custom algorithm).

See also:

Constant Value: 3 (0x00000003)

Public constructors

CollectionItemInfo

Added in API level 30

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 30

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`.

getSortDirection

Added in Android Baklava

public int getSortDirection ()

Gets the sort direction applied to the data associated with this node.

This item can only be set on a heading node within a table collection. Given the heading node's collection item, a subsequent collection item uses this sort direction if it has the same row or column index, and a greater index in the other dimension. For example, an item at row 2, column 2 can reference a heading at row 2, column 1 for its sort direction.

Returns

Returns
`int`	The current sort direction, one of: `SORT_DIRECTION_NONE` `SORT_DIRECTION_ASCENDING` `SORT_DIRECTION_DESCENDING` `SORT_DIRECTION_OTHER` Value is `SORT_DIRECTION_NONE`, `SORT_DIRECTION_ASCENDING`, `SORT_DIRECTION_DESCENDING`, or `SORT_DIRECTION_OTHER`

int

The current sort direction, one of:

Value is SORT_DIRECTION_NONE, SORT_DIRECTION_ASCENDING, SORT_DIRECTION_DESCENDING, or SORT_DIRECTION_OTHER

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`

AccessibilityNodeInfo.CollectionItemInfo

Summary

Nested classes

Constants

Public constructors

Public methods

Inherited methods

Constants

SORT_DIRECTION_ASCENDING

SORT_DIRECTION_DESCENDING

SORT_DIRECTION_NONE

SORT_DIRECTION_OTHER

Public constructors

CollectionItemInfo

CollectionItemInfo

Public methods

getColumnIndex

getColumnSpan

getColumnTitle

getRowIndex

getRowSpan

getRowTitle

getSortDirection

isHeading

isSelected

obtain

obtain