Banner
@ExperimentalCarApi
@CarProtocol
@RequiresCarApi(value = 9)
class Banner : Item
A banner element that's meant to be visually distinct from other normal elements on the screen.
For example, a banner can be used to tell the user whether the app is running in an online vs offline mode, or promote a specific event or announcement.
Summary
Nested types |
|---|
@RequiresCarApi(value = 9)A builder of |
Constants |
|
|---|---|
const Int |
IMAGE_TYPE_LARGE = 3Represents a large edge-to-edge image to be displayed in the banner. |
const Int |
Represents a medium padded artwork image to be displayed in the banner. |
const Int |
IMAGE_TYPE_SMALL = 1Represents a small icon-sized image to be displayed in the banner. |
Public functions |
|
|---|---|
Boolean |
|
(Mutable)List<Action!> |
Returns the list of actions below the title and subtitle. |
BannerElement? |
Returns the leading element of the banner. |
OnClickDelegate? |
Returns the |
BannerStyle? |
getStyle()Returns the |
CarText? |
Returns the subtitle of the banner. |
CarText? |
getTitle()Returns the title of the banner. |
(Mutable)List<BannerElement!> |
Returns the list of trailing elements of the banner. |
Int |
hashCode() |
String |
toString() |
Constants
IMAGE_TYPE_LARGE
const val IMAGE_TYPE_LARGE = 3: Int
Represents a large edge-to-edge image to be displayed in the banner. Scales the image to fill the container and potentially clip within the bounds if a shape is applied.
This image type cannot be used in combination with addBelowAction.
IMAGE_TYPE_MEDIUM
const val IMAGE_TYPE_MEDIUM = 2: Int
Represents a medium padded artwork image to be displayed in the banner.
The host renders it with standard padding and scales the image to fit within the bounds.
IMAGE_TYPE_SMALL
const val IMAGE_TYPE_SMALL = 1: Int
Represents a small icon-sized image to be displayed in the banner.
The host renders it with standard padding and scales the image to fit within the bounds.
Public functions
getBelowActions
fun getBelowActions(): (Mutable)List<Action!>
Returns the list of actions below the title and subtitle.
| See also | |
|---|---|
addBelowAction |
getLeadingElement
fun getLeadingElement(): BannerElement?
Returns the leading element of the banner.
This is currently restricted to icons and images only.
| See also | |
|---|---|
setLeadingImage |
|
setLeadingImage |
getOnClickDelegate
fun getOnClickDelegate(): OnClickDelegate?
Returns the OnClickDelegate to be called back when the banner is clicked.
| See also | |
|---|---|
setOnClickListener |
getStyle
fun getStyle(): BannerStyle?
Returns the BannerStyle of the banner, or null if not set.
| See also | |
|---|---|
setStyle |
getSubtitle
fun getSubtitle(): CarText?
Returns the subtitle of the banner.
The subtitle is automatically truncated if it's too long; however, shorter variants can be added via addVariant.
| See also | |
|---|---|
setSubtitle |
getTitle
fun getTitle(): CarText?
Returns the title of the banner.
The title is automatically truncated if it's too long; however, shorter variants can be added via addVariant.
| See also | |
|---|---|
setTitle |
getTrailingElements
fun getTrailingElements(): (Mutable)List<BannerElement!>
Returns the list of trailing elements of the banner.