Skip to content

Most visited

Recently visited

navigation

BaseCardView

public class BaseCardView
extends FrameLayout

java.lang.Object
   ↳ android.view.View
     ↳ android.view.ViewGroup
       ↳ android.widget.FrameLayout
         ↳ android.support.v17.leanback.widget.BaseCardView
Known Direct Subclasses


A card style layout that responds to certain state changes. It arranges its children in a vertical column, with different regions becoming visible at different times.

A BaseCardView will draw its children based on its type, the region visibilities of the child types, and the state of the widget. A child may be marked as belonging to one of three regions: main, info, or extra. The main region is always visible, while the info and extra regions can be set to display based on the activated or selected state of the View. The card states are set by calling setActivated and setSelected.

See BaseCardView.LayoutParams for layout attributes.

Summary

Nested classes

class BaseCardView.LayoutParams

Per-child layout information associated with BaseCardView. 

Inherited XML attributes

From class android.widget.FrameLayout
From class android.view.ViewGroup
From class android.view.View

Constants

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.

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.

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.

int CARD_TYPE_MAIN_ONLY

A simple card type with a single layout area.

Inherited constants

From class android.view.ViewGroup
From class android.view.View

Inherited fields

From class android.view.View

Public constructors

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

Public methods

BaseCardView.LayoutParams generateLayoutParams(AttributeSet attrs)

Returns a new set of layout parameters based on the supplied attributes set.

int getCardType()

Returns the type of this Card.

int getExtraVisibility()

This method was deprecated in API level 25.1.0. Extra view's visibility is controlled by getInfoVisibility()

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.

void setActivated(boolean activated)

Sets the Activated state of this Card.

void setCardType(int type)

Sets the type of this Card.

void setExtraVisibility(int visibility)

This method was deprecated in API level 25.1.0. Extra view's visibility is controlled by setInfoVisibility(int)

void setInfoVisibility(int visibility)

Sets the visibility of the info region of the card.

void setSelected(boolean selected)

Sets the Selected state of this Card.

void setSelectedAnimationDelayed(boolean delay)

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.

boolean shouldDelayChildPressedState()

Return true if the pressed state should be delayed for children or descendants of this ViewGroup.

String toString()

Returns a string representation of the object.

Protected methods

boolean checkLayoutParams(ViewGroup.LayoutParams p)
BaseCardView.LayoutParams generateDefaultLayoutParams()

Returns a set of layout parameters with a width of MATCH_PARENT, and a height of MATCH_PARENT.

BaseCardView.LayoutParams generateLayoutParams(ViewGroup.LayoutParams lp)

Returns a safe set of layout parameters based on the supplied layout params.

int[] onCreateDrawableState(int extraSpace)

Generate the new Drawable state for this view.

void onDetachedFromWindow()

This is called when the view is detached from a window.

void onLayout(boolean changed, int left, int top, int right, int bottom)

Called from layout when this view should assign a size and position to each of its children.

void onMeasure(int widthMeasureSpec, int heightMeasureSpec)

Measure the view and its content to determine the measured width and the measured height.

Inherited methods

From class android.widget.FrameLayout
From class android.view.ViewGroup
From class android.view.View
From class java.lang.Object
From interface android.view.ViewParent
From interface android.view.ViewManager
From interface android.graphics.drawable.Drawable.Callback
From interface android.view.KeyEvent.Callback
From interface android.view.accessibility.AccessibilityEventSource

Constants

CARD_REGION_VISIBLE_ACTIVATED

added in version 22.0.0
int CARD_REGION_VISIBLE_ACTIVATED

Indicates that a card region is visible when the card is activated.

Constant Value: 1 (0x00000001)

CARD_REGION_VISIBLE_ALWAYS

added in version 22.0.0
int CARD_REGION_VISIBLE_ALWAYS

Indicates that a card region is always visible.

Constant Value: 0 (0x00000000)

CARD_REGION_VISIBLE_SELECTED

added in version 22.0.0
int CARD_REGION_VISIBLE_SELECTED

Indicates that a card region is visible when the card is selected.

Constant Value: 2 (0x00000002)

CARD_TYPE_INFO_OVER

added in version 22.0.0
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.

See also:

Constant Value: 1 (0x00000001)

CARD_TYPE_INFO_UNDER

added in version 22.0.0
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.

See also:

Constant Value: 2 (0x00000002)

CARD_TYPE_INFO_UNDER_WITH_EXTRA

added in version 22.0.0
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.

See also:

Constant Value: 3 (0x00000003)

CARD_TYPE_MAIN_ONLY

added in version 22.0.0
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.

See also:

Constant Value: 0 (0x00000000)

Public constructors

BaseCardView

added in version 22.0.0
BaseCardView (Context context)

Parameters
context Context

BaseCardView

added in version 22.0.0
BaseCardView (Context context, 
                AttributeSet attrs)

Parameters
context Context
attrs AttributeSet

BaseCardView

added in version 22.0.0
BaseCardView (Context context, 
                AttributeSet attrs, 
                int defStyleAttr)

Parameters
context Context
attrs AttributeSet
defStyleAttr int

Public methods

generateLayoutParams

BaseCardView.LayoutParams generateLayoutParams (AttributeSet attrs)

Returns a new set of layout parameters based on the supplied attributes set.

Parameters
attrs AttributeSet: the attributes to build the layout parameters from
Returns
BaseCardView.LayoutParams an instance of ViewGroup.LayoutParams or one of its descendants

getCardType

added in version 22.0.0
int getCardType ()

Returns the type of this Card.

Returns
int The type of this card.

getExtraVisibility

added in version 22.0.0
int getExtraVisibility ()

This method was deprecated in API level 25.1.0.
Extra view's visibility is controlled by getInfoVisibility()

Returns the visibility of the extra region of the card.

Returns
int

getInfoVisibility

added in version 22.0.0
int getInfoVisibility ()

Returns the visibility of the info region of the card.

Returns
int

isSelectedAnimationDelayed

added in version 22.0.0
boolean isSelectedAnimationDelayed ()

Returns a boolean indicating if the selected animation will run immediately or be delayed the next time the card is Selected.

Returns
boolean true if this card is set to delay the selected animation the next time it is selected, or false if the selected animation will run immediately the next time the card is selected.

setActivated

void setActivated (boolean activated)

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.

Parameters
activated boolean: True if the card is ACTIVE, or false if INACTIVE.

See also:

setCardType

added in version 22.0.0
void setCardType (int type)

Sets the type of this Card.

Parameters
type int: The desired card type.

setExtraVisibility

added in version 22.0.0
void setExtraVisibility (int visibility)

This method was deprecated in API level 25.1.0.
Extra view's visibility is controlled by setInfoVisibility(int)

Sets the visibility of the extra region of the card.

Parameters
visibility int: The region visibility to use for the extra region. Must be one of CARD_REGION_VISIBLE_ALWAYS, CARD_REGION_VISIBLE_SELECTED, or CARD_REGION_VISIBLE_ACTIVATED.

setInfoVisibility

added in version 22.0.0
void setInfoVisibility (int visibility)

Sets the visibility of the info region of the card.

Parameters
visibility int: The region visibility to use for the info region. Must be one of CARD_REGION_VISIBLE_ALWAYS, CARD_REGION_VISIBLE_SELECTED, or CARD_REGION_VISIBLE_ACTIVATED.

setSelected

void setSelected (boolean selected)

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.

Parameters
selected boolean: True if the card is Selected, or false otherwise.

See also:

setSelectedAnimationDelayed

added in version 22.0.0
void setSelectedAnimationDelayed (boolean delay)

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.

Parameters
delay boolean: True (default) if the selected animation should be delayed after the card is selected, or false if the animation should run immediately the next time the card is Selected.

shouldDelayChildPressedState

boolean shouldDelayChildPressedState ()

Return true if the pressed state should be delayed for children or descendants of this ViewGroup. Generally, this should be done for containers that can scroll, such as a List. This prevents the pressed state from appearing when the user is actually trying to scroll the content. The default implementation returns true for compatibility reasons. Subclasses that do not scroll should generally override this method and return false.

Returns
boolean

toString

String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

Protected methods

checkLayoutParams

boolean checkLayoutParams (ViewGroup.LayoutParams p)

Parameters
p ViewGroup.LayoutParams
Returns
boolean

generateDefaultLayoutParams

BaseCardView.LayoutParams generateDefaultLayoutParams ()

Returns a set of layout parameters with a width of MATCH_PARENT, and a height of MATCH_PARENT.

Returns
BaseCardView.LayoutParams a set of default layout parameters or null

generateLayoutParams

BaseCardView.LayoutParams generateLayoutParams (ViewGroup.LayoutParams lp)

Returns a safe set of layout parameters based on the supplied layout params. When a ViewGroup is passed a View whose layout params do not pass the test of checkLayoutParams(android.view.ViewGroup.LayoutParams), this method is invoked. This method should return a new set of layout params suitable for this ViewGroup, possibly by copying the appropriate attributes from the specified set of layout params.

Parameters
lp ViewGroup.LayoutParams: The layout parameters to convert into a suitable set of layout parameters for this ViewGroup.
Returns
BaseCardView.LayoutParams an instance of ViewGroup.LayoutParams or one of its descendants

onCreateDrawableState

int[] onCreateDrawableState (int extraSpace)

Generate the new Drawable state for this view. This is called by the view system when the cached Drawable state is determined to be invalid. To retrieve the current state, you should use getDrawableState().

Parameters
extraSpace int: if non-zero, this is the number of extra entries you would like in the returned array in which you can place your own states.
Returns
int[] Returns an array holding the current Drawable state of the view.

onDetachedFromWindow

void onDetachedFromWindow ()

This is called when the view is detached from a window. At this point it no longer has a surface for drawing.

onLayout

void onLayout (boolean changed, 
                int left, 
                int top, 
                int right, 
                int bottom)

Called from layout when this view should assign a size and position to each of its children. Derived classes with children should override this method and call layout on each of their children.

Parameters
changed boolean: This is a new size or position for this view
left int: Left position, relative to parent
top int: Top position, relative to parent
right int: Right position, relative to parent
bottom int: Bottom position, relative to parent

onMeasure

void onMeasure (int widthMeasureSpec, 
                int heightMeasureSpec)

Measure the view and its content to determine the measured width and the measured height. This method is invoked by measure(int, int) and should be overridden by subclasses to provide accurate and efficient measurement of their contents.

CONTRACT: When overriding this method, you must call setMeasuredDimension(int, int) to store the measured width and height of this view. Failure to do so will trigger an IllegalStateException, thrown by measure(int, int). Calling the superclass' onMeasure(int, int) is a valid use.

The base class implementation of measure defaults to the background size, unless a larger size is allowed by the MeasureSpec. Subclasses should override onMeasure(int, int) to provide better measurements of their content.

If this method is overridden, it is the subclass's responsibility to make sure the measured height and width are at least the view's minimum height and width (getSuggestedMinimumHeight() and getSuggestedMinimumWidth()).

Parameters
widthMeasureSpec int: horizontal space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.
heightMeasureSpec int: vertical space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.