CardView
class CardView : FrameLayout
| kotlin.Any | ||||
| ↳ | android.view.View | |||
| ↳ | android.view.ViewGroup | |||
| ↳ | android.widget.FrameLayout | |||
| ↳ | androidx.cardview.widget.CardView |
A FrameLayout with a rounded corner background and shadow.
CardView uses elevation property on Lollipop for shadows and falls back to a custom emulated shadow implementation on older platforms.
Due to expensive nature of rounded corner clipping, on platforms before Lollipop, CardView does not clip its children that intersect with rounded corners. Instead, it adds padding to avoid such intersection (See setPreventCornerOverlap to change this behavior).
Before Lollipop, CardView adds padding to its content and draws shadows to that area. This padding amount is equal to maxCardElevation + (1 - cos45) * cornerRadius on the sides and maxCardElevation * 1.5 + (1 - cos45) * cornerRadius on top and bottom.
Since padding is used to offset content for shadows, you cannot set padding on CardView. Instead, you can use content padding attributes in XML or setContentPadding in code to set the padding between the edges of the CardView and children of CardView.
Note that, if you specify exact dimensions for the CardView, because of the shadows, its content area will be different between platforms before Lollipop and after Lollipop. By using api version specific resource values, you can avoid these changes. Alternatively, If you want CardView to add inner padding on platforms Lollipop and after as well, you can call setUseCompatPadding and pass true.
To change CardView's elevation in a backward compatible way, use setCardElevation. CardView will use elevation API on Lollipop and before Lollipop, it will change the shadow size. To avoid moving the View while shadow size is changing, shadow size is clamped by getMaxCardElevation. If you want to change elevation dynamically, you should call setMaxCardElevation when CardView is initialized.
ref androidx.cardview.R.styleable#CardView_cardBackgroundColor
ref androidx.cardview.R.styleable#CardView_cardCornerRadius
ref androidx.cardview.R.styleable#CardView_cardElevation
ref androidx.cardview.R.styleable#CardView_cardMaxElevation
ref androidx.cardview.R.styleable#CardView_cardUseCompatPadding
ref androidx.cardview.R.styleable#CardView_cardPreventCornerOverlap
ref androidx.cardview.R.styleable#CardView_contentPadding
ref androidx.cardview.R.styleable#CardView_contentPaddingLeft
ref androidx.cardview.R.styleable#CardView_contentPaddingTop
ref androidx.cardview.R.styleable#CardView_contentPaddingRight
ref androidx.cardview.R.styleable#CardView_contentPaddingBottom
Summary
Public constructors |
|---|
CardView(context: Context, attrs: AttributeSet?) |
CardView(context: Context, attrs: AttributeSet?, defStyleAttr: Int) |
Public functions |
|
|---|---|
ColorStateList |
Returns the background color state list of the CardView. |
Float |
Returns the backward compatible elevation of the CardView. |
@Px Int |
Returns the inner padding before the Card's bottom edge |
@Px Int |
Returns the inner padding after the Card's left edge |
@Px Int |
Returns the inner padding before the Card's right edge |
@Px Int |
Returns the inner padding after the Card's top edge |
Float |
Returns the backward compatible maximum elevation of the CardView. |
Boolean |
Returns whether CardView should add extra padding to content to avoid overlaps with rounded corners on pre-Lollipop platforms. |
Float |
Returns the corner radius of the CardView. |
Boolean |
Returns whether CardView will add inner padding on platforms Lollipop and after. |
Unit |
setCardBackgroundColor(color: ColorStateList?)Updates the background ColorStateList of the CardView |
Unit |
setCardBackgroundColor(color: @ColorInt Int)Updates the background color of the CardView |
Unit |
setCardElevation(elevation: Float)Updates the backward compatible elevation of the CardView. |
Unit |
Sets the padding between the Card's edges and the children of CardView. |
Unit |
setMaxCardElevation(maxElevation: Float)Updates the backward compatible maximum elevation of the CardView. |
Unit |
setMinimumHeight(minHeight: Int) |
Unit |
setMinimumWidth(minWidth: Int) |
Unit |
setPadding(left: Int, top: Int, right: Int, bottom: Int) |
Unit |
setPaddingRelative(start: Int, top: Int, end: Int, bottom: Int) |
Unit |
setPreventCornerOverlap(preventCornerOverlap: Boolean)On pre-Lollipop platforms, CardView does not clip the bounds of the Card for the rounded corners. |
Unit |
Updates the corner radius of the CardView. |
Unit |
setUseCompatPadding(useCompatPadding: Boolean)CardView adds additional padding to draw shadows on platforms before Lollipop. |
Inherited Constants |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Public constructors
Public functions
getCardBackgroundColor
fun getCardBackgroundColor(): ColorStateList
Returns the background color state list of the CardView.
| Returns | |
|---|---|
ColorStateList |
The background color state list of the CardView. |
getCardElevation
fun getCardElevation(): Float
Returns the backward compatible elevation of the CardView.
| Returns | |
|---|---|
Float |
Elevation of the CardView |
| See also | |
|---|---|
setCardElevation |
|
getMaxCardElevation |
getContentPaddingBottom
fun getContentPaddingBottom(): @Px Int
Returns the inner padding before the Card's bottom edge
getContentPaddingLeft
fun getContentPaddingLeft(): @Px Int
Returns the inner padding after the Card's left edge
getContentPaddingRight
fun getContentPaddingRight(): @Px Int
Returns the inner padding before the Card's right edge
getContentPaddingTop
fun getContentPaddingTop(): @Px Int
Returns the inner padding after the Card's top edge
getMaxCardElevation
fun getMaxCardElevation(): Float
Returns the backward compatible maximum elevation of the CardView.
| Returns | |
|---|---|
Float |
Maximum elevation of the CardView |
| See also | |
|---|---|
setMaxCardElevation |
|
getCardElevation |
getPreventCornerOverlap
fun getPreventCornerOverlap(): Boolean
Returns whether CardView should add extra padding to content to avoid overlaps with rounded corners on pre-Lollipop platforms.
| Returns | |
|---|---|
Boolean |
True if CardView prevents overlaps with rounded corners on platforms before Lollipop. Default value is |
getRadius
fun getRadius(): Float
Returns the corner radius of the CardView.
| Returns | |
|---|---|
Float |
Corner radius of the CardView |
| See also | |
|---|---|
getRadius |
getUseCompatPadding
fun getUseCompatPadding(): Boolean
Returns whether CardView will add inner padding on platforms Lollipop and after.
| Returns | |
|---|---|
Boolean |
|
setCardBackgroundColor
fun setCardBackgroundColor(color: ColorStateList?): Unit
Updates the background ColorStateList of the CardView
ref androidx.cardview.R.styleable#CardView_cardBackgroundColor
| Parameters | |
|---|---|
color: ColorStateList? |
The new ColorStateList to set for the card background |
setCardBackgroundColor
fun setCardBackgroundColor(color: @ColorInt Int): Unit
Updates the background color of the CardView
ref androidx.cardview.R.styleable#CardView_cardBackgroundColor
setCardElevation
fun setCardElevation(elevation: Float): Unit
Updates the backward compatible elevation of the CardView.
ref androidx.cardview.R.styleable#CardView_cardElevation
| Parameters | |
|---|---|
elevation: Float |
The backward compatible elevation in pixels. |
| See also | |
|---|---|
getCardElevation |
|
setMaxCardElevation |
setContentPadding
fun setContentPadding(left: @Px Int, top: @Px Int, right: @Px Int, bottom: @Px Int): Unit
Sets the padding between the Card's edges and the children of CardView.
Depending on platform version or getUseCompatPadding settings, CardView may update these values before calling setPadding.
ref androidx.cardview.R.styleable#CardView_contentPadding
ref androidx.cardview.R.styleable#CardView_contentPaddingLeft
ref androidx.cardview.R.styleable#CardView_contentPaddingTop
ref androidx.cardview.R.styleable#CardView_contentPaddingRight
ref androidx.cardview.R.styleable#CardView_contentPaddingBottom
setMaxCardElevation
fun setMaxCardElevation(maxElevation: Float): Unit
Updates the backward compatible maximum elevation of the CardView.
Calling this method has no effect if device OS version is Lollipop or newer and getUseCompatPadding is false.
ref androidx.cardview.R.styleable#CardView_cardMaxElevation
| Parameters | |
|---|---|
maxElevation: Float |
The backward compatible maximum elevation in pixels. |
| See also | |
|---|---|
setCardElevation |
|
getMaxCardElevation |
setPreventCornerOverlap
fun setPreventCornerOverlap(preventCornerOverlap: Boolean): Unit
On pre-Lollipop platforms, CardView does not clip the bounds of the Card for the rounded corners. Instead, it adds padding to content so that it won't overlap with the rounded corners. You can disable this behavior by setting this field to false.
Setting this value on Lollipop and above does not have any effect unless you have enabled compatibility padding.
ref androidx.cardview.R.styleable#CardView_cardPreventCornerOverlap
| Parameters | |
|---|---|
preventCornerOverlap: Boolean |
Whether CardView should add extra padding to content to avoid overlaps with the CardView corners. |
| See also | |
|---|---|
setUseCompatPadding |
setRadius
fun setRadius(radius: Float): Unit
Updates the corner radius of the CardView.
ref androidx.cardview.R.styleable#CardView_cardCornerRadius
| Parameters | |
|---|---|
radius: Float |
The radius in pixels of the corners of the rectangle shape |
| See also | |
|---|---|
setRadius |
setUseCompatPadding
fun setUseCompatPadding(useCompatPadding: Boolean): Unit
CardView adds additional padding to draw shadows on platforms before Lollipop.
This may cause Cards to have different sizes between Lollipop and before Lollipop. If you need to align CardView with other Views, you may need api version specific dimension resources to account for the changes. As an alternative, you can set this flag to true and CardView will add the same padding values on platforms Lollipop and after.
Since setting this flag to true adds unnecessary gaps in the UI, default value is false.
ref androidx.cardview.R.styleable#CardView_cardUseCompatPadding
| Parameters | |
|---|---|
useCompatPadding: Boolean |
|