AccessibilityNodeInfoCompat.CollectionInfoCompat

Added in 1.1.0

class AccessibilityNodeInfoCompat.CollectionInfoCompat


Class with information if a node is a collection.

A collection of items has rows and columns and may be marked as hierarchical.

For example, a list where the items are placed in a vertical layout is a collection with one column and as many rows as the list items. This collection has 3 rows and 1 column and should not be marked as hierarchical since items do not exist at different levels/ranks and there are no nested collections.

  • Item 1
  • Item 2
  • Item 3

A table is a collection with several rows and several columns. This collection has 2 rows and 3 columns and is not marked as hierarchical:

Item 1 Item 2 Item 3
Item 4 Item 5 Item 6

Nested collections could be marked as hierarchical. To add outer and inner collections to the same hierarchy, mark them both as hierarchical.

For example, if you have a collection with two lists - this collection has an outer list with 3 rows and 1 column and an inner list within "Item 2" with 2 rows and 1 - you can mark both the outer list and the inner list as hierarchical to make them part of the same hierarchy. If a collection does not have any ancestor or descendant hierarchical collections, it does not need to be marked as hierarchical.

  • Item 1
  • Item 2
    • Item 2A
    • Item 2B
  • Item 3

To be a valid list, a collection has 1 row and any number of columns or 1 column and any number of rows.

Summary

Constants

const Int

Selection mode where multiple items may be selected.

const Int

Selection mode where items are not selectable.

const Int

Selection mode where a single item may be selected.

Public functions

Int

Gets the number of columns.

Int

Gets the number of rows.

Int

Gets the collection's selection mode.

Boolean

Gets if the collection is a hierarchically ordered.

java-static AccessibilityNodeInfoCompat.CollectionInfoCompat!
obtain(rowCount: Int, columnCount: Int, hierarchical: Boolean)

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

java-static AccessibilityNodeInfoCompat.CollectionInfoCompat!
obtain(
    rowCount: Int,
    columnCount: Int,
    hierarchical: Boolean,
    selectionMode: Int
)

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

Constants

SELECTION_MODE_MULTIPLE

Added in 1.1.0
const val SELECTION_MODE_MULTIPLE = 2: Int

Selection mode where multiple items may be selected.

SELECTION_MODE_NONE

Added in 1.1.0
const val SELECTION_MODE_NONE = 0: Int

Selection mode where items are not selectable.

SELECTION_MODE_SINGLE

Added in 1.1.0
const val SELECTION_MODE_SINGLE = 1: Int

Selection mode where a single item may be selected.

Public functions

getColumnCount

Added in 1.1.0
fun getColumnCount(): Int

Gets the number of columns.

Returns
Int

The column count, or -1 if count is unknown.

getRowCount

Added in 1.1.0
fun getRowCount(): Int

Gets the number of rows.

Returns
Int

The row count, or -1 if count is unknown.

getSelectionMode

Added in 1.1.0
fun getSelectionMode(): Int

Gets the collection's selection mode.

Returns
Int

The collection's selection mode, one of:

isHierarchical

Added in 1.1.0
fun isHierarchical(): Boolean

Gets if the collection is a hierarchically ordered.

Returns
Boolean

Whether the collection is hierarchical.

obtain

Added in 1.1.0
java-static fun obtain(rowCount: Int, columnCount: Int, hierarchical: Boolean): AccessibilityNodeInfoCompat.CollectionInfoCompat!

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

Parameters
rowCount: Int

The number of rows, or -1 if count is unknown.

columnCount: Int

The number of columns , or -1 if count is unknown.

hierarchical: Boolean

Whether the collection is hierarchical.

obtain

Added in 1.1.0
java-static fun obtain(
    rowCount: Int,
    columnCount: Int,
    hierarchical: Boolean,
    selectionMode: Int
): AccessibilityNodeInfoCompat.CollectionInfoCompat!

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: