Join us on the livestream at Android Dev Summit on 7-8 November 2018, starting at 10AM PDT!
added in version 1.0.0
belongs to Maven artifact androidx.leanback:leanback:1.0.0

ImageCardView

public class ImageCardView
extends BaseCardView

java.lang.Object
   ↳ 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:

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

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):

 new ImageCardView(new ContextThemeWrapper(context, R.style.CustomImageCardTheme));
 
 

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:

 <style name="CustomImageCardViewStyle" parent="Widget.Leanback.ImageCardViewStyle">
        ...
        <item name="lbImageCardViewType">Title|Content|IconOnLeft</item>
        ...
    </style>
 
 <style name="CustomImageCardViewStyle" parent="Widget.Leanback.ImageCardViewStyle">
        ...
        <item name="lbImageCardViewType">ImageOnly</item>
        ...
    </style>
 

Summary

XML attributes

LeanbackTheme_imageCardViewBadgeStyle  
LeanbackTheme_imageCardViewContentStyle  
LeanbackTheme_imageCardViewImageStyle  
LeanbackTheme_imageCardViewInfoAreaStyle  
LeanbackTheme_imageCardViewStyle  
LeanbackTheme_imageCardViewTitleStyle  
lbImageCardView_lbImageCardViewType  

Constants

int CARD_TYPE_FLAG_CONTENT

int CARD_TYPE_FLAG_ICON_LEFT

int CARD_TYPE_FLAG_ICON_RIGHT

int CARD_TYPE_FLAG_IMAGE_ONLY

int CARD_TYPE_FLAG_TITLE

Inherited constants

Inherited fields

Public constructors

ImageCardView(Context context, int themeResId)

This constructor was deprecated in API level 1.0.0. Calling this constructor inefficiently creates one ContextThemeWrapper per card, you should share it in card Presenter: wrapper = new ContextThemeWrapper(context, themResId); return new ImageCardView(wrapper);

ImageCardView(Context context, AttributeSet attrs, int defStyleAttr)
ImageCardView(Context context)
ImageCardView(Context context, AttributeSet attrs)

Public methods

Drawable getBadgeImage()

Returns the badge image drawable.

CharSequence getContentText()

Returns the content text.

Drawable getInfoAreaBackground()

Returns the info area background drawable.

Drawable getMainImage()

Returns the ImageView drawable.

final ImageView getMainImageView()

Returns the main image view.

CharSequence getTitleText()

Returns the title text.

boolean hasOverlappingRendering()
void setBadgeImage(Drawable drawable)

Sets the badge image drawable.

void setContentText(CharSequence text)

Sets the content text.

void setInfoAreaBackground(Drawable drawable)

Sets the info area background drawable.

void setInfoAreaBackgroundColor(int color)

Sets the info area background color.

void setMainImage(Drawable drawable, boolean fade)

Sets the image drawable with optional fade-in animation.

void setMainImage(Drawable drawable)

Sets the image drawable with fade-in animation.

void setMainImageAdjustViewBounds(boolean adjustViewBounds)

Enables or disables adjustment of view bounds on the main image.

void setMainImageDimensions(int width, int height)

Sets the layout dimensions of the ImageView.

void setMainImageScaleType(ImageView.ScaleType scaleType)

Sets the ScaleType of the main image.

void setTitleText(CharSequence text)

Sets the title text.

Protected methods

void onAttachedToWindow()
void onDetachedFromWindow()

Inherited methods

XML attributes

LeanbackTheme_imageCardViewBadgeStyle

LeanbackTheme_imageCardViewContentStyle

LeanbackTheme_imageCardViewImageStyle

LeanbackTheme_imageCardViewInfoAreaStyle

LeanbackTheme_imageCardViewStyle

LeanbackTheme_imageCardViewTitleStyle

lbImageCardView_lbImageCardViewType

Constants

CARD_TYPE_FLAG_CONTENT

added in version 1.0.0
public static final int CARD_TYPE_FLAG_CONTENT

Constant Value: 2 (0x00000002)

CARD_TYPE_FLAG_ICON_LEFT

added in version 1.0.0
public static final int CARD_TYPE_FLAG_ICON_LEFT

Constant Value: 8 (0x00000008)

CARD_TYPE_FLAG_ICON_RIGHT

added in version 1.0.0
public static final int CARD_TYPE_FLAG_ICON_RIGHT

Constant Value: 4 (0x00000004)

CARD_TYPE_FLAG_IMAGE_ONLY

added in version 1.0.0
public static final int CARD_TYPE_FLAG_IMAGE_ONLY

Constant Value: 0 (0x00000000)

CARD_TYPE_FLAG_TITLE

added in version 1.0.0
public static final int CARD_TYPE_FLAG_TITLE

Constant Value: 1 (0x00000001)

Public constructors

ImageCardView

added in version 1.0.0
public ImageCardView (Context context, 
                int themeResId)

This constructor was deprecated in API level 1.0.0.
Calling this constructor inefficiently creates one ContextThemeWrapper per card, you should share it in card Presenter: wrapper = new ContextThemeWrapper(context, themResId); return new ImageCardView(wrapper);

Create an ImageCardView using a given theme for customization.

Parameters
context Context: The Context the view is running in, through which it can access the current theme, resources, etc.

themeResId int: The resourceId of the theme you want to apply to the ImageCardView. The theme includes attributes "imageCardViewStyle", "imageCardViewTitleStyle", "imageCardViewContentStyle" etc. to customize individual part of ImageCardView.

ImageCardView

added in version 1.0.0
public ImageCardView (Context context, 
                AttributeSet attrs, 
                int defStyleAttr)

Parameters
context Context

attrs AttributeSet

defStyleAttr int

ImageCardView

added in version 1.0.0
public ImageCardView (Context context)

Parameters
context Context

See also:

ImageCardView

added in version 1.0.0
public ImageCardView (Context context, 
                AttributeSet attrs)

Parameters
context Context

attrs AttributeSet

Public methods

getBadgeImage

added in version 1.0.0
public Drawable getBadgeImage ()

Returns the badge image drawable.

Returns
Drawable

getContentText

added in version 1.0.0
public CharSequence getContentText ()

Returns the content text.

Returns
CharSequence

getInfoAreaBackground

added in version 1.0.0
public Drawable getInfoAreaBackground ()

Returns the info area background drawable.

Returns
Drawable

getMainImage

added in version 1.0.0
public Drawable getMainImage ()

Returns the ImageView drawable.

Returns
Drawable

getMainImageView

added in version 1.0.0
public final ImageView getMainImageView ()

Returns the main image view.

Returns
ImageView

getTitleText

added in version 1.0.0
public CharSequence getTitleText ()

Returns the title text.

Returns
CharSequence

hasOverlappingRendering

public boolean hasOverlappingRendering ()

Returns
boolean

setBadgeImage

added in version 1.0.0
public void setBadgeImage (Drawable drawable)

Sets the badge image drawable.

Parameters
drawable Drawable

setContentText

added in version 1.0.0
public void setContentText (CharSequence text)

Sets the content text.

Parameters
text CharSequence

setInfoAreaBackground

added in version 1.0.0
public void setInfoAreaBackground (Drawable drawable)

Sets the info area background drawable.

Parameters
drawable Drawable

setInfoAreaBackgroundColor

added in version 1.0.0
public void setInfoAreaBackgroundColor (int color)

Sets the info area background color.

Parameters
color int

setMainImage

added in version 1.0.0
public void setMainImage (Drawable drawable, 
                boolean fade)

Sets the image drawable with optional fade-in animation.

Parameters
drawable Drawable

fade boolean

setMainImage

added in version 1.0.0
public void setMainImage (Drawable drawable)

Sets the image drawable with fade-in animation.

Parameters
drawable Drawable

setMainImageAdjustViewBounds

added in version 1.0.0
public void setMainImageAdjustViewBounds (boolean adjustViewBounds)

Enables or disables adjustment of view bounds on the main image.

Parameters
adjustViewBounds boolean

setMainImageDimensions

added in version 1.0.0
public void setMainImageDimensions (int width, 
                int height)

Sets the layout dimensions of the ImageView.

Parameters
width int

height int

setMainImageScaleType

added in version 1.0.0
public void setMainImageScaleType (ImageView.ScaleType scaleType)

Sets the ScaleType of the main image.

Parameters
scaleType ImageView.ScaleType

setTitleText

added in version 1.0.0
public void setTitleText (CharSequence text)

Sets the title text.

Parameters
text CharSequence

Protected methods

onAttachedToWindow

protected void onAttachedToWindow ()

onDetachedFromWindow

protected void onDetachedFromWindow ()