# Print output for @column tags ?>
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. Use
CollectionItemInfo#obtain(int, int, int, int, boolean)
to get an instance. Recycling is handled by the AccessibilityNodeInfo
to which this
object is attached.
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.
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. |
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 |
boolean
|
isSelected()
Gets if the collection item is selected. |
static
AccessibilityNodeInfo.CollectionItemInfo
|
obtain(int rowIndex, int rowSpan, int columnIndex, int columnSpan, boolean heading)
Obtains a pooled instance. |
static
AccessibilityNodeInfo.CollectionItemInfo
|
obtain(int rowIndex, int rowSpan, int columnIndex, int columnSpan, boolean heading, boolean selected)
Obtains a pooled instance. |
Inherited methods | |
---|---|
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. |
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 int getColumnIndex ()
Gets the column index at which the item is located.
Returns | |
---|---|
int |
The column index. |
public int getColumnSpan ()
Gets the number of columns the item spans.
Returns | |
---|---|
int |
The column span. |
public int getRowIndex ()
Gets the row index at which the item is located.
Returns | |
---|---|
int |
The row index. |
public int getRowSpan ()
Gets the number of rows the item spans.
Returns | |
---|---|
int |
The row span. |
public boolean isHeading ()
This method is deprecated.
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. |
public boolean isSelected ()
Gets if the collection item is selected.
Returns | |
---|---|
boolean |
If the item is selected. |
public static AccessibilityNodeInfo.CollectionItemInfo obtain (int rowIndex, int rowSpan, int columnIndex, int columnSpan, boolean heading)
Obtains a pooled instance.
In most situations object pooling is not beneficial. Create a new instance using the
constructor AccessibilityNodeInfo.CollectionItemInfo#CollectionItemInfo(int,
int, int, int, boolean)
instead.
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 |
public static AccessibilityNodeInfo.CollectionItemInfo obtain (int rowIndex, int rowSpan, int columnIndex, int columnSpan, boolean heading, boolean selected)
Obtains a pooled instance.
In most situations object pooling is not beneficial. Creates a new instance using the
constructor AccessibilityNodeInfo.CollectionItemInfo#CollectionItemInfo(int,
int, int, int, boolean, boolean)
instead.
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 |