ImageCardView

open class ImageCardView : BaseCardView

kotlin.Any
↳	android.view.View
	↳	android.view.ViewGroup
		↳	android.widget.FrameLayout
			↳	androidx.leanback.widget.BaseCardView
				↳	androidx.leanback.widget.ImageCardView

A subclass of BaseCardView with an ImageView as its main region. The ImageCardView is highly customizable and can be used for various use-cases by adjusting the ImageViewCard's type to any combination of Title, Content, Badge or ImageOnly.

Styling

There are two different ways to style the ImageCardView.
No matter what way you use, all your styles applied to an ImageCardView have to extend the style R.style#Widget_Leanback_ImageCardViewStyle.

Example:

<code>&lt;style name="CustomImageCardViewStyle" parent="Widget.Leanback.ImageCardViewStyle"&gt;
        &lt;item name="cardBackground"&gt;#F0F&lt;/item&gt;
        &lt;item name="lbImageCardViewType"&gt;Title|Content&lt;/item&gt;
   &lt;/style&gt;
   &lt;style name="CustomImageCardTheme" parent="Theme.Leanback"&gt;
        &lt;item name="imageCardViewStyle"&gt;@style/CustomImageCardViewStyle&lt;/item&gt;
        &lt;item name="imageCardViewInfoAreaStyle"&gt;@style/ImageCardViewColoredInfoArea&lt;/item&gt;
        &lt;item name="imageCardViewTitleStyle"&gt;@style/ImageCardViewColoredTitle&lt;/item&gt;
    &lt;/style&gt;</code>

The first possibility is to set custom Styles in the Leanback Theme's attributes imageCardViewStyle, imageCardViewTitleStyle etc. The styles set here, is the default style for all ImageCardViews.

The second possibility allows you to style a particular ImageCardView. This is useful if you want to create multiple types of cards. E.g. you might want to display a card with only a title and another one with title and content. Thus you need to define two different ImageCardViewStyles and two different themes and apply them to the ImageCardViews. You can do this by using a the ImageCardView(Context) constructor and passing a ContextThemeWrapper with the custom ImageCardView theme id.

Example (using constructor):

<code>new ImageCardView(new ContextThemeWrapper(context, R.style.CustomImageCardTheme));
  </code>

You can style all ImageCardView's components such as the title, content, badge, infoArea and the image itself by extending the corresponding style and overriding the specific attribute in your custom ImageCardView theme.

Components

The ImageCardView contains three components which can be combined in any combination:

• Title: The card's title
• Content: A short description
• Badge: An icon which can be displayed on the right or left side of the card.

In order to choose the components you want to use in your ImageCardView, you have to specify them in the lbImageCardViewType attribute of your custom ImageCardViewStyle. You can combine the following values: Title, Content, IconOnRight, IconOnLeft, ImageOnly.

Examples:

<code>&lt;style name="CustomImageCardViewStyle" parent="Widget.Leanback.ImageCardViewStyle"&gt;
        ...
        &lt;item name="lbImageCardViewType"&gt;Title|Content|IconOnLeft&lt;/item&gt;
        ...
    &lt;/style&gt;</code>

<code>&lt;style name="CustomImageCardViewStyle" parent="Widget.Leanback.ImageCardViewStyle"&gt;
        ...
        &lt;item name="lbImageCardViewType"&gt;ImageOnly&lt;/item&gt;
        ...
    &lt;/style&gt;</code>

androidx.leanback.R.attr#imageCardViewStyle androidx.leanback.R.attr#lbImageCardViewType androidx.leanback.R.attr#imageCardViewTitleStyle androidx.leanback.R.attr#imageCardViewContentStyle androidx.leanback.R.attr#imageCardViewBadgeStyle androidx.leanback.R.attr#imageCardViewImageStyle androidx.leanback.R.attr#imageCardViewInfoAreaStyle

Summary

Constants
static Int	CARD_TYPE_FLAG_CONTENT
static Int	CARD_TYPE_FLAG_ICON_LEFT
static Int	CARD_TYPE_FLAG_ICON_RIGHT
static Int	CARD_TYPE_FLAG_IMAGE_ONLY
static Int	CARD_TYPE_FLAG_TITLE

Inherited constants

From class BaseCardView Int CARD_REGION_VISIBLE_ACTIVATED Indicates that a card region is visible when the card is activated. Int CARD_REGION_VISIBLE_ALWAYS Indicates that a card region is always visible. Int CARD_REGION_VISIBLE_SELECTED Indicates that a card region is visible when the card is selected. Int CARD_TYPE_INFO_OVER A Card type with 2 layout areas: A main area which is always visible, and an info area that fades in over the main area when it is visible. The card height will not change. Int CARD_TYPE_INFO_UNDER A Card type with 2 layout areas: A main area which is always visible, and an info area that appears below the main area. When the info area is visible the total card height will change. Int CARD_TYPE_INFO_UNDER_WITH_EXTRA A Card type with 3 layout areas: A main area which is always visible; an info area which will appear below the main area, and an extra area that only appears after a short delay. The info area appears below the main area, causing the total card height to change. The extra area animates in at the bottom of the card, shifting up the info view without affecting the card height. Int CARD_TYPE_MAIN_ONLY A simple card type with a single layout area. This card type does not change its layout or size as it transitions between Activated/Not-Activated or Selected/Unselected states.

Public constructors
<init>(context: Context!, themeResId: Int) Create an ImageCardView using a given theme for customization.
<init>(context: Context!, attrs: AttributeSet!, defStyleAttr: Int)
<init>(context: Context!)
<init>(context: Context!, attrs: AttributeSet!)

Public methods
open Drawable!	getBadgeImage() Returns the badge image drawable.
open CharSequence!	getContentText() Returns the content text.
open Drawable!	getInfoAreaBackground() Returns the info area background drawable.
open Drawable!	getMainImage() Returns the ImageView drawable.
ImageView!	getMainImageView() Returns the main image view.
open CharSequence!	getTitleText() Returns the title text.
open Boolean	hasOverlappingRendering()
open Unit	setBadgeImage(drawable: