GridSection

Artifact: androidx.car.app:app

View Source

Added in 1.7.0-beta01

---

Kotlin |Java

@ExperimentalCarApi
@CarProtocol
class GridSection : Section

kotlin.Any
↳	androidx.car.app.model.Section
	↳	androidx.car.app.model.GridSection

---

A section within the SectionedItemTemplate that contains GridItems - good for showcase large artwork or images for every entry.

Summary

Nested types
@ExperimentalCarApi class GridSection.Builder : Section.BaseBuilder A builder that constructs GridSection instances.

Constants
const Int	ITEM_IMAGE_SHAPE_CIRCLE = 2 Renders the image within the grid item in the shape of a circle by cropping it.
const Int	ITEM_IMAGE_SHAPE_UNSET = 1 Renders the image within the grid item as-is without modifying its shape - this is the default.
const Int	ITEM_SIZE_LARGE = 3 Renders the items within the section in a large format.
const Int	ITEM_SIZE_MEDIUM = 2 Renders the items within the section in a medium sized format.
const Int	ITEM_SIZE_SMALL = 1 Renders the items within the section in a small format - this is the default.

Public functions
Boolean	equals(other: Any?)
Int	getItemImageShape() Returns the shape which this section's grid item images should be rendered to.
Int	getItemSize() Returns the size which this section's grid items should be rendered at.
Int	hashCode()
String	toString()

Inherited functions
From androidx.car.app.model.Section (Mutable)List<T!> getItems() Returns the items added to this section. CarText? getNoItemsMessage() Returns the optional message that should appear if there are no items added to this section. CarText? getTitle() Returns the optional text that should appear with the items in this section.

Constants

ITEM_IMAGE_SHAPE_CIRCLE

Added in 1.7.0-beta01

const val ITEM_IMAGE_SHAPE_CIRCLE = 2: Int

Renders the image within the grid item in the shape of a circle by cropping it.

ITEM_IMAGE_SHAPE_UNSET

Added in 1.7.0-beta01

const val ITEM_IMAGE_SHAPE_UNSET = 1: Int

Renders the image within the grid item as-is without modifying its shape - this is the default.

ITEM_SIZE_LARGE

Added in 1.7.0-beta01

const val ITEM_SIZE_LARGE = 3: Int

Renders the items within the section in a large format.

ITEM_SIZE_MEDIUM

Added in 1.7.0-beta01

const val ITEM_SIZE_MEDIUM = 2: Int

Renders the items within the section in a medium sized format.

ITEM_SIZE_SMALL

Added in 1.7.0-beta01

const val ITEM_SIZE_SMALL = 1: Int

Renders the items within the section in a small format - this is the default.

Public functions

equals

fun equals(other: Any?): Boolean

getItemImageShape

Added in 1.7.0-beta01

fun getItemImageShape(): Int

Returns the shape which this section's grid item images should be rendered to.

getItemSize

Added in 1.7.0-beta01

fun getItemSize(): Int

Returns the size which this section's grid items should be rendered at.

hashCode

fun hashCode(): Int

toString

fun toString(): String