Summary: Nested Classes | Ctors | Methods | Inherited Methods

GridRowBuilder

Kotlin |Java

public class GridRowBuilder
extends Object

java.lang.Object
↳	androidx.slice.builders.GridRowBuilder

Builder to construct a grid row which may be added as a row to ListBuilder.

A grid row supports cells of vertically laid out content in a single row. Each cell can contain a combination of text and images and is constructed using a GridRowBuilder.CellBuilder.

A grid supports a couple of image types:

ListBuilder.ICON_IMAGE - icon images are expected to be tintable and are shown at a standard icon size.
ListBuilder.SMALL_IMAGE - small images are not tinted and are shown at a small size.
ListBuilder.LARGE_IMAGE - large images are not tinted and are shown as large as they can be, in a ImageView.ScaleType.CENTER_CROP

If more cells are added to the grid row than can be displayed, the cells will be cut off. Using setSeeMoreAction(PendingIntent) you can specify an action to take the user to see the rest of the content, this will take up space as a cell item in a row if added.

See also:

ListBuilder.addGridRow(GridRowBuilder)

Summary

Nested classes
`class`	`GridRowBuilder.CellBuilder` Builder to construct a cell.

Public constructors
`GridRowBuilder()` Create a builder which will construct a slice displayed in a grid format.

Public methods
`GridRowBuilder`	`addCell(GridRowBuilder.CellBuilder builder)` Add a cell to the grid builder.
`GridRowBuilder`	`setContentDescription(CharSequence description)` Sets the content description for the entire grid row.
`GridRowBuilder`	`setLayoutDirection(int layoutDirection)` Sets the desired layout direction for the content in this row.
`GridRowBuilder`	`setPrimaryAction(SliceAction action)` Sets the intent to send when the whole grid row is clicked.
`GridRowBuilder`	`setSeeMoreAction(PendingIntent intent)` If all content in a slice cannot be shown, a "see more" affordance may be displayed where the content is cut off.
`GridRowBuilder`	`setSeeMoreAction(RemoteCallback callback)` If all content in a slice cannot be shown, a "see more" affordance may be displayed where the content is cut off.
`GridRowBuilder`	`setSeeMoreCell(GridRowBuilder.CellBuilder builder)` If all content in a slice cannot be shown, the cell added here may be displayed where the content is cut off.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Public constructors

GridRowBuilder

public GridRowBuilder ()

Create a builder which will construct a slice displayed in a grid format.

Public methods

addCell

public GridRowBuilder addCell (GridRowBuilder.CellBuilder builder)

Add a cell to the grid builder.

Parameters
`builder`	`GridRowBuilder.CellBuilder`

Returns
`GridRowBuilder`

setContentDescription

public GridRowBuilder setContentDescription (CharSequence description)

Sets the content description for the entire grid row.

Parameters
`description`	`CharSequence`

Returns
`GridRowBuilder`

setLayoutDirection

public GridRowBuilder setLayoutDirection (int layoutDirection)

Sets the desired layout direction for the content in this row.

Parameters
`layoutDirection`	`int`: the layout direction to set.

Returns
`GridRowBuilder`

setPrimaryAction

public GridRowBuilder setPrimaryAction (SliceAction action)

Sets the intent to send when the whole grid row is clicked.

If all the cells in the grid have specified a setPrimaryAction(SliceAction) then the action set here on the GridRowBuilder may not ever be invoked.

If this grid row is the first row in ListBuilder, the action set here will be used to represent the slice when presented in SliceView.MODE_SHORTCUT.

Parameters
`action`	`SliceAction`

Returns
`GridRowBuilder`

setSeeMoreAction

public GridRowBuilder setSeeMoreAction (PendingIntent intent)

If all content in a slice cannot be shown, a "see more" affordance may be displayed where the content is cut off. The action added here should take the user to an activity to see all of the content, and will be invoked when the "see more" affordance is tapped.

Only one see more affordance can be added, this throws IllegalStateException if a row or action has been previously added.

Parameters
`intent`	`PendingIntent`

Returns
`GridRowBuilder`

setSeeMoreAction

public GridRowBuilder setSeeMoreAction (RemoteCallback callback)

Only one see more affordance can be added, this throws IllegalStateException if a row or action has been previously added.

Parameters
`callback`	`RemoteCallback`

Returns
`GridRowBuilder`

setSeeMoreCell

public GridRowBuilder setSeeMoreCell (GridRowBuilder.CellBuilder builder)

If all content in a slice cannot be shown, the cell added here may be displayed where the content is cut off.

This method should only be used if you want to display a custom cell to indicate more content, consider using setSeeMoreAction(PendingIntent) otherwise. If you do choose to specify a custom cell, the cell should have GridRowBuilder.CellBuilder.setContentIntent(PendingIntent) specified to take the user to an activity to see all of the content.

Only one see more affordance can be added, this throws IllegalStateException if a row or action has been previously added.

Parameters
`builder`	`GridRowBuilder.CellBuilder`

Returns
`GridRowBuilder`

GridRowBuilder

Summary

Nested classes

Public constructors

Public methods

Inherited methods

Public constructors

GridRowBuilder

Public methods

addCell

setContentDescription

setLayoutDirection

setPrimaryAction

setSeeMoreAction

setSeeMoreAction

setSeeMoreCell