CardColors

Artifact: androidx.wear.protolayout:protolayout-material3

Added in 1.3.0

Kotlin |Java

public final class CardColors

Represents colors used in card components, such as titleCard or appCard.

Summary

Public constructors
`CardColors( @NonNull LayoutColor backgroundColor, @NonNull LayoutColor titleColor, @NonNull LayoutColor contentColor, @NonNull LayoutColor timeColor, @NonNull LayoutColor labelColor, @NonNull LayoutColor secondaryIconColor, @NonNull LayoutColor secondaryTextColor, ProgressIndicatorColors graphicProgressIndicatorColors, LayoutColor graphicIconColor )`

Public methods
`final @NonNull CardColors`	`copy( @NonNull LayoutColor backgroundColor, @NonNull LayoutColor titleColor, @NonNull LayoutColor contentColor, @NonNull LayoutColor timeColor, @NonNull LayoutColor labelColor, @NonNull LayoutColor secondaryIconColor, @NonNull LayoutColor secondaryTextColor, ProgressIndicatorColors graphicProgressIndicatorColors, LayoutColor graphicIconColor )` Returns a copy of this `CardColors`, optionally overriding some of the values.
`final @NonNull LayoutColor`	`getBackgroundColor()` `LayoutColor` which is used to as the background color for the card.
`final @NonNull LayoutColor`	`getContentColor()` the content color for the card.
`final LayoutColor`	`getGraphicIconColor()` the color used for the icon to be put at the center of the progress indicator to compose the graphic.
`final ProgressIndicatorColors`	`getGraphicProgressIndicatorColors()` the color used for the progress indicator set as graphic of the card.
`final @NonNull LayoutColor`	`getLabelColor()` the color used for label for the card.
`final @NonNull LayoutColor`	`getSecondaryIconColor()` the color used for icon in the data card type.
`final @NonNull LayoutColor`	`getSecondaryTextColor()` the color used for secondary label for the data card type.
`final @NonNull LayoutColor`	`getTimeColor()` the color used for time for the card.
`final @NonNull LayoutColor`	`getTitleColor()` the color used for title for the card.

Public constructors

CardColors

Added in 1.3.0

public CardColors(
    @NonNull LayoutColor backgroundColor,
    @NonNull LayoutColor titleColor,
    @NonNull LayoutColor contentColor,
    @NonNull LayoutColor timeColor,
    @NonNull LayoutColor labelColor,
    @NonNull LayoutColor secondaryIconColor,
    @NonNull LayoutColor secondaryTextColor,
    ProgressIndicatorColors graphicProgressIndicatorColors,
    LayoutColor graphicIconColor
)

Parameters
`@NonNull LayoutColor backgroundColor`	`LayoutColor` which is used to as the background color for the card.
`@NonNull LayoutColor titleColor`	the color used for title for the card.
`@NonNull LayoutColor contentColor`	the content color for the card.
`@NonNull LayoutColor timeColor`	the color used for time for the card.
`@NonNull LayoutColor labelColor`	the color used for label for the card.
`@NonNull LayoutColor secondaryIconColor`	the color used for icon in the data card type.
`@NonNull LayoutColor secondaryTextColor`	the color used for secondary label for the data card type.
`ProgressIndicatorColors graphicProgressIndicatorColors`	the color used for the progress indicator set as graphic of the card. If null, uses the default color defined in `circularProgressIndicator` and `segmentedCircularProgressIndicator`, which is `filledProgressIndicatorColors`.
`LayoutColor graphicIconColor`	the color used for the icon to be put at the center of the progress indicator to compose the graphic. If null, uses the default icon color, which is `ColorScheme.primary`.

Public methods

copy

Added in 1.3.0

public final @NonNull CardColors copy(
    @NonNull LayoutColor backgroundColor,
    @NonNull LayoutColor titleColor,
    @NonNull LayoutColor contentColor,
    @NonNull LayoutColor timeColor,
    @NonNull LayoutColor labelColor,
    @NonNull LayoutColor secondaryIconColor,
    @NonNull LayoutColor secondaryTextColor,
    ProgressIndicatorColors graphicProgressIndicatorColors,
    LayoutColor graphicIconColor
)

Returns a copy of this CardColors, optionally overriding some of the values.

Parameters
`@NonNull LayoutColor backgroundColor`	`LayoutColor` which is used to as the background color for the card.
`@NonNull LayoutColor titleColor`	the color used for title for the card.
`@NonNull LayoutColor contentColor`	the content color for the card.
`@NonNull LayoutColor timeColor`	the color used for time for the card.
`@NonNull LayoutColor labelColor`	the color used for label for the card.
`@NonNull LayoutColor secondaryIconColor`	the color used for icon in the data card type.
`@NonNull LayoutColor secondaryTextColor`	the color used for secondary label for the data card type.
`ProgressIndicatorColors graphicProgressIndicatorColors`	the color used for the progress indicator set as graphic of the card. If null, uses the default color defined in `circularProgressIndicator` and `segmentedCircularProgressIndicator`, which is `filledProgressIndicatorColors`.
`LayoutColor graphicIconColor`	the color used for the icon to be put at the center of the progress indicator to compose the graphic. If null, uses the default icon color, which is `ColorScheme.primary`.

getBackgroundColor

Added in 1.3.0

public final @NonNull LayoutColor getBackgroundColor()

LayoutColor which is used to as the background color for the card.

getContentColor

Added in 1.3.0

public final @NonNull LayoutColor getContentColor()

the content color for the card.

getGraphicIconColor

Added in 1.3.0

public final LayoutColor getGraphicIconColor()

the color used for the icon to be put at the center of the progress indicator to compose the graphic. If null, uses the default icon color, which is ColorScheme.primary.

getGraphicProgressIndicatorColors

Added in 1.3.0

public final ProgressIndicatorColors getGraphicProgressIndicatorColors()

the color used for the progress indicator set as graphic of the card. If null, uses the default color defined in circularProgressIndicator and segmentedCircularProgressIndicator, which is filledProgressIndicatorColors.

getLabelColor

Added in 1.3.0

public final @NonNull LayoutColor getLabelColor()

the color used for label for the card.

getSecondaryIconColor

Added in 1.3.0

public final @NonNull LayoutColor getSecondaryIconColor()

the color used for icon in the data card type.

getSecondaryTextColor

Added in 1.3.0

public final @NonNull LayoutColor getSecondaryTextColor()

the color used for secondary label for the data card type.

getTimeColor

Added in 1.3.0

public final @NonNull LayoutColor getTimeColor()

the color used for time for the card.

getTitleColor

Added in 1.3.0

public final @NonNull LayoutColor getTitleColor()

the color used for title for the card.