public class

AccessibilityNodeInfoCompat.CollectionInfoCompat

extends java.lang.Object

 java.lang.Object

↳androidx.core.view.accessibility.AccessibilityNodeInfoCompat.CollectionInfoCompat

Overview

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

Fields
public static final intSELECTION_MODE_MULTIPLE

Selection mode where multiple items may be selected.

public static final intSELECTION_MODE_NONE

Selection mode where items are not selectable.

public static final intSELECTION_MODE_SINGLE

Selection mode where a single item may be selected.

Methods
public intgetColumnCount()

Gets the number of columns.

public intgetRowCount()

Gets the number of rows.

public intgetSelectionMode()

Gets the collection's selection mode.

public booleanisHierarchical()

Gets if the collection is a hierarchically ordered.

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

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

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

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

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Fields

public static final int SELECTION_MODE_NONE

Selection mode where items are not selectable.

public static final int SELECTION_MODE_SINGLE

Selection mode where a single item may be selected.

public static final int SELECTION_MODE_MULTIPLE

Selection mode where multiple items may be selected.

Methods

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: The number of rows.
columnCount: The number of columns.
hierarchical: Whether the collection is hierarchical.
selectionMode: The collection's selection mode, one of:


Returns:

An instance.

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: The number of rows, or -1 if count is unknown.
columnCount: The number of columns , or -1 if count is unknown.
hierarchical: Whether the collection is hierarchical.

Returns:

An instance.

public int getColumnCount()

Gets the number of columns.

Returns:

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

public int getRowCount()

Gets the number of rows.

Returns:

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

public boolean isHierarchical()

Gets if the collection is a hierarchically ordered.

Returns:

Whether the collection is hierarchical.

public int getSelectionMode()

Gets the collection's selection mode.

Returns:

The collection's selection mode, one of: