ImageCardView

Kotlin |Java

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: Drawable!)` Sets the badge image drawable.
open Unit	`setContentText(text: CharSequence!)` Sets the content text.
open Unit	`setInfoAreaBackground(drawable: Drawable!)` Sets the info area background drawable.
open Unit	`setInfoAreaBackgroundColor(color: Int)` Sets the info area background color.
open Unit	`setMainImage(drawable: Drawable!)` Sets the image drawable with fade-in animation.
open Unit	`setMainImage(drawable: Drawable!, fade: Boolean)` Sets the image drawable with optional fade-in animation.
open Unit	`setMainImageAdjustViewBounds(adjustViewBounds: Boolean)` Enables or disables adjustment of view bounds on the main image.
open Unit	`setMainImageDimensions(width: Int, height: Int)` Sets the layout dimensions of the ImageView.
open Unit	`setMainImageScaleType(scaleType: ScaleType!)` Sets the ScaleType of the main image.
open Unit	`setTitleText(text: CharSequence!)` Sets the title text.

Protected methods
open Unit	`onAttachedToWindow()`
open Unit	`onDetachedFromWindow()`

Inherited functions

From class BaseCardView

`Boolean`	`checkLayoutParams(p: LayoutParams!)`
`BaseCardView.LayoutParams!`	`generateDefaultLayoutParams()`
`BaseCardView.LayoutParams!`	`generateLayoutParams(attrs: AttributeSet!)`
`BaseCardView.LayoutParams!`	`generateLayoutParams(lp: LayoutParams!)`
`Int`	`getCardType()` Returns the type of this Card.
`Int`	`getExtraVisibility()` Returns the visibility of the extra region of the card.
`Int`	`getInfoVisibility()` Returns the visibility of the info region of the card.
`Boolean`	`isSelectedAnimationDelayed()` Returns a boolean indicating if the selected animation will run immediately or be delayed the next time the card is Selected.
`IntArray!`	`onCreateDrawableState(extraSpace: Int)`
`Unit`	`onLayout(changed: Boolean, left: Int, top: Int, right: Int, bottom: Int)`
`Unit`	`onMeasure(widthMeasureSpec: Int, heightMeasureSpec: Int)`
`Unit`	`setActivated(activated: Boolean)` Sets the Activated state of this Card. This can trigger changes in the card layout, resulting in views to become visible or hidden. A card is normally set to Activated state when its parent container (like a Row) receives focus, and then activates all of its children.
`Unit`	`setCardType(type: Int)` Sets the type of this Card.
`Unit`	`setExtraVisibility(visibility: Int)` Sets the visibility of the extra region of the card.
`Unit`	`setInfoVisibility(visibility: Int)` Sets the visibility of the info region of the card.
`Unit`	`setSelected(selected: Boolean)` Sets the Selected state of this Card. This can trigger changes in the card layout, resulting in views to become visible or hidden. A card is normally set to Selected state when it receives input focus.
`Unit`	`setSelectedAnimationDelayed(delay: Boolean)` Sets a flag indicating if the Selected animation (if the selected card type implements one) should run immediately after the card is selected, or if it should be delayed. The default behavior is to delay this animation. This is a one-shot override. If set to false, after the card is selected and the selected animation is triggered, this flag is automatically reset to true. This is useful when you want to change the default behavior, and have the selected animation run immediately. One such case could be when focus moves from one row to the other, when instead of delaying the selected animation until the user pauses on a card, it may be desirable to trigger the animation for that card immediately.
`Boolean`	`shouldDelayChildPressedState()`
`String`	`toString()`

Constants

CARD_TYPE_FLAG_CONTENT

static val CARD_TYPE_FLAG_CONTENT: Int

Value: 2

CARD_TYPE_FLAG_ICON_LEFT

static val CARD_TYPE_FLAG_ICON_LEFT: Int

Value: 8

CARD_TYPE_FLAG_ICON_RIGHT

static val CARD_TYPE_FLAG_ICON_RIGHT: Int

Value: 4

CARD_TYPE_FLAG_IMAGE_ONLY

static val CARD_TYPE_FLAG_IMAGE_ONLY: Int

Value: 0

CARD_TYPE_FLAG_TITLE

static val CARD_TYPE_FLAG_TITLE: Int

Value: 1

Public constructors

<init>

ImageCardView(context: Context!, themeResId: Int)

Deprecated: 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`	Context!: 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.

<init>

ImageCardView(context: Context!, attrs: AttributeSet!, defStyleAttr: Int)

See Also

View#View(Context, AttributeSet, int)

<init>

ImageCardView(context: Context!)

See Also

View#View(Context)

<init>

ImageCardView(context: Context!, attrs: AttributeSet!)

See Also

View#View(Context, AttributeSet)

Public methods

getBadgeImage

open fun getBadgeImage(): Drawable!

Returns the badge image drawable.

getContentText

open fun getContentText(): CharSequence!

Returns the content text.

getInfoAreaBackground

open fun getInfoAreaBackground(): Drawable!

Returns the info area background drawable.

getMainImage

open fun getMainImage(): Drawable!

Returns the ImageView drawable.

getMainImageView

fun getMainImageView(): ImageView!

Returns the main image view.

getTitleText

open fun getTitleText(): CharSequence!

Returns the title text.

hasOverlappingRendering

open fun hasOverlappingRendering(): Boolean

setBadgeImage

open fun setBadgeImage(drawable: Drawable!): Unit

Sets the badge image drawable.

setContentText

open fun setContentText(text: CharSequence!): Unit

Sets the content text.

setInfoAreaBackground

open fun setInfoAreaBackground(drawable: Drawable!): Unit

Sets the info area background drawable.

setInfoAreaBackgroundColor

open fun setInfoAreaBackgroundColor(color: Int): Unit

Sets the info area background color.

setMainImage

open fun setMainImage(drawable: Drawable!): Unit

Sets the image drawable with fade-in animation.

setMainImage

open fun setMainImage(drawable: Drawable!, fade: Boolean): Unit

Sets the image drawable with optional fade-in animation.

setMainImageAdjustViewBounds

open fun setMainImageAdjustViewBounds(adjustViewBounds: Boolean): Unit

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

setMainImageDimensions

open fun setMainImageDimensions(width: Int, height: Int): Unit

Sets the layout dimensions of the ImageView.

setMainImageScaleType

open fun setMainImageScaleType(scaleType: ScaleType!): Unit

Sets the ScaleType of the main image.

setTitleText

open fun setTitleText(text: CharSequence!): Unit

Sets the title text.

Protected methods

onAttachedToWindow

protected open fun onAttachedToWindow(): Unit

onDetachedFromWindow

protected open fun onDetachedFromWindow(): Unit