Summary: Ctors | Methods | Inherited Methods

ListBuilder.RowBuilder

Kotlin |Java

public static class ListBuilder.RowBuilder
extends Object

java.lang.Object
↳	androidx.slice.builders.ListBuilder.RowBuilder

Builder to construct a row. A row can be added as an item to ListBuilder via ListBuilder.addRow(RowBuilder).

A row supports:

Title item - The title item can be a timestamp, image, or a SliceAction. It appears with at the start of the row. There can only be one title item added to a row.
Title - Single line of text formatted as a title, see setTitle(CharSequence).
Subtitle - Single line of text below the title (if one exists) and is formatted as normal text, see setSubtitle(CharSequence).
End item - End items appear at the end of the row. There can be multiple end items that show depending on available width. End items can be a timestamp, image, or a tappable icon.
Primary action - The primary action for the row, this is the action that will be sent when the row is clicked. This is set via setPrimaryAction(SliceAction). If this is the only row or first row of the slice, then the action set here will be used to represent the slice shown in SliceView.MODE_SMALL.

There are a couple of restrictions to how content can be added to a row:

End items cannot contain a mixture of SliceActions and Icons.
There can only be one timestamp added to the row.

See also:

ListBuilder.addRow(RowBuilder)

Summary

Public constructors
`RowBuilder()` Builder to construct a row.
`RowBuilder(Uri uri)` Builder to construct a normal row.

Public methods
`ListBuilder.RowBuilder`	`addEndItem(long timeStamp)` Adds a timestamp to the end items of the row builder.
`ListBuilder.RowBuilder`	`addEndItem(IconCompat icon, int imageMode)` Adds an icon to the end items of the row builder.
`ListBuilder.RowBuilder`	`addEndItem(SliceAction action, boolean isLoading)` Adds an action to the end items of the row builder.
`ListBuilder.RowBuilder`	`addEndItem(SliceAction action)` Adds an action to the end items of the row builder.
`ListBuilder.RowBuilder`	`addEndItem(IconCompat icon, int imageMode, boolean isLoading)` Adds an icon to the end items of the row builder.
`ListBuilder.RowBuilder`	`setContentDescription(CharSequence description)` Sets the content description for the row.
`ListBuilder.RowBuilder`	`setEndOfSection(boolean isEndOfSection)` Indicate that this row is an end for a section.
`ListBuilder.RowBuilder`	`setLayoutDirection(int layoutDirection)` Sets the desired layout direction for the content in this row.
`ListBuilder.RowBuilder`	`setPrimaryAction(SliceAction action)` The action specified here will be sent when the whole row is clicked.
`ListBuilder.RowBuilder`	`setSubtitle(CharSequence subtitle)` Sets the subtitle for the row builder.
`ListBuilder.RowBuilder`	`setSubtitle(CharSequence subtitle, boolean isLoading)` Sets the subtitle for the row builder.
`ListBuilder.RowBuilder`	`setTitle(CharSequence title)` Sets the title for the row builder.
`ListBuilder.RowBuilder`	`setTitle(CharSequence title, boolean isLoading)` Sets the title for the row builder.
`ListBuilder.RowBuilder`	`setTitleItem(SliceAction action)` Sets the title item to be a tappable icon.
`ListBuilder.RowBuilder`	`setTitleItem(long timeStamp)` Sets the title item to be the provided timestamp.
`ListBuilder.RowBuilder`	`setTitleItem(IconCompat icon, int imageMode, boolean isLoading)` Sets the title item to be the provided icon.
`ListBuilder.RowBuilder`	`setTitleItem(IconCompat icon, int imageMode)` Sets the title item to be the provided icon.
`ListBuilder.RowBuilder`	`setTitleItem(SliceAction action, boolean isLoading)` Sets the title item to be a tappable icon.

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

RowBuilder

public RowBuilder ()

Builder to construct a row.

RowBuilder

public RowBuilder (Uri uri)

Builder to construct a normal row.

Parameters
`uri`	`Uri`: Uri to tag for this slice.

Public methods

addEndItem

public ListBuilder.RowBuilder addEndItem (long timeStamp)

Adds a timestamp to the end items of the row builder. Only one timestamp can be added, if one is already added this will throw IllegalArgumentException.

Parameters
`timeStamp`	`long`

Returns
`ListBuilder.RowBuilder`

addEndItem

public ListBuilder.RowBuilder addEndItem (IconCompat icon, 
                int imageMode)

Adds an icon to the end items of the row builder.

Parameters
`icon`	`IconCompat`: the image to display.
`imageMode`	`int`: the mode that image should be displayed in.

Returns
`ListBuilder.RowBuilder`

See also:

addEndItem

public ListBuilder.RowBuilder addEndItem (SliceAction action, 
                boolean isLoading)

Adds an action to the end items of the row builder. A mixture of icons and actions is not permitted. If an icon has already been added, this will throw IllegalArgumentException.

Use this method to specify content that will appear in the template once it's been loaded.

Parameters
`action`	`SliceAction`
`isLoading`	`boolean`: indicates whether the app is doing work to load the added content in the background or not.

Returns
`ListBuilder.RowBuilder`

addEndItem

public ListBuilder.RowBuilder addEndItem (SliceAction action)

Adds an action to the end items of the row builder. A mixture of icons and actions is not permitted. If an icon has already been added, this will throw IllegalArgumentException.

Parameters
`action`	`SliceAction`

Returns
`ListBuilder.RowBuilder`

addEndItem

public ListBuilder.RowBuilder addEndItem (IconCompat icon, 
                int imageMode, 
                boolean isLoading)

Adds an icon to the end items of the row builder.

When set to true, the parameter isLoading indicates that the app is doing work to load this content in the background, in this case the template displays a placeholder until updated.

Parameters
`icon`	`IconCompat`: the image to display.
`imageMode`	`int`: the mode that image should be displayed in.
`isLoading`	`boolean`: whether this content is being loaded in the background.

Returns
`ListBuilder.RowBuilder`

See also:

setContentDescription

public ListBuilder.RowBuilder setContentDescription (CharSequence description)

Sets the content description for the row.

Parameters
`description`	`CharSequence`

Returns
`ListBuilder.RowBuilder`

setEndOfSection

public ListBuilder.RowBuilder setEndOfSection (boolean isEndOfSection)

Indicate that this row is an end for a section.

Parameters
`isEndOfSection`	`boolean`

Returns
`ListBuilder.RowBuilder`

setLayoutDirection

public ListBuilder.RowBuilder setLayoutDirection (int layoutDirection)

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

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

Returns
`ListBuilder.RowBuilder`

setPrimaryAction

public ListBuilder.RowBuilder setPrimaryAction (SliceAction action)

The action specified here will be sent when the whole row is clicked.

If this is the first row in a ListBuilder this action will also be used to define the SliceView.MODE_SHORTCUT representation of the slice.

Parameters
`action`	`SliceAction`

Returns
`ListBuilder.RowBuilder`

setSubtitle

public ListBuilder.RowBuilder setSubtitle (CharSequence subtitle)

Sets the subtitle for the row builder. A subtitle should fit on a single line and is ellipsized if too long.

Parameters
`subtitle`	`CharSequence`

Returns
`ListBuilder.RowBuilder`

setSubtitle

public ListBuilder.RowBuilder setSubtitle (CharSequence subtitle, 
                boolean isLoading)

Sets the subtitle for the row builder. A subtitle should fit on a single line and is ellipsized if too long.

Use this method to specify content that will appear in the template once it's been loaded.

Parameters
`subtitle`	`CharSequence`
`isLoading`	`boolean`: indicates whether the app is doing work to load the added content in the background or not.

Returns
`ListBuilder.RowBuilder`

setTitle

public ListBuilder.RowBuilder setTitle (CharSequence title)

Sets the title for the row builder. A title should fit on a single line and is ellipsized if too long.

Parameters
`title`	`CharSequence`

Returns
`ListBuilder.RowBuilder`

setTitle

public ListBuilder.RowBuilder setTitle (CharSequence title, 
                boolean isLoading)

Sets the title for the row builder. A title should fit on a single line and is ellipsized if too long.

Use this method to specify content that will appear in the template once it's been loaded.

Parameters
`title`	`CharSequence`
`isLoading`	`boolean`: indicates whether the app is doing work to load the added content in the background or not.

Returns
`ListBuilder.RowBuilder`

setTitleItem

public ListBuilder.RowBuilder setTitleItem (SliceAction action)

Sets the title item to be a tappable icon. There can only be one title item, this will replace any other title items that may have been set.

Parameters
`action`	`SliceAction`

Returns
`ListBuilder.RowBuilder`

setTitleItem

public ListBuilder.RowBuilder setTitleItem (long timeStamp)

Sets the title item to be the provided timestamp. Only one timestamp can be added, if one is already added this will throw IllegalArgumentException.

There can only be one title item, this will replace any other title items that may have been set.

Parameters
`timeStamp`	`long`

Returns
`ListBuilder.RowBuilder`

setTitleItem

public ListBuilder.RowBuilder setTitleItem (IconCompat icon, 
                int imageMode, 
                boolean isLoading)

Sets the title item to be the provided icon. There can only be one title item, this will replace any other title items that may have been set.

When set to true, the parameter isLoading indicates that the app is doing work to load this content in the background, in this case the template displays a placeholder until updated.

Parameters
`icon`	`IconCompat`: the image to display.
`imageMode`	`int`: the mode that image should be displayed in.
`isLoading`	`boolean`: whether this content is being loaded in the background.

Returns
`ListBuilder.RowBuilder`

See also:

setTitleItem

public ListBuilder.RowBuilder setTitleItem (IconCompat icon, 
                int imageMode)

Sets the title item to be the provided icon. There can only be one title item, this will replace any other title items that may have been set.

Parameters
`icon`	`IconCompat`: the image to display.
`imageMode`	`int`: the mode that image should be displayed in.

Returns
`ListBuilder.RowBuilder`

See also:

setTitleItem

public ListBuilder.RowBuilder setTitleItem (SliceAction action, 
                boolean isLoading)

Sets the title item to be a tappable icon. There can only be one title item, this will replace any other title items that may have been set.

Use this method to specify content that will appear in the template once it's been loaded.

Parameters
`action`	`SliceAction`
`isLoading`	`boolean`: indicates whether the app is doing work to load the added content in the background or not.

Returns
`ListBuilder.RowBuilder`