ColorStateList

public class ColorStateList
extends Object implements Parcelable

Lets you map View state sets to colors.

ColorStateLists are created from XML resource files defined in the "color" subdirectory directory of an application's resource directory. The XML file contains a single "selector" element with a number of "item" elements inside. For example:

 <selector xmlns:android="http://schemas.android.com/apk/res/android">
   <item android:state_focused="true"
           android:color="@color/sample_focused" />
   <item android:state_pressed="true"
           android:state_enabled="false"
           android:color="@color/sample_disabled_pressed" />
   <item android:state_enabled="false"
           android:color="@color/sample_disabled_not_pressed" />
   <item android:color="@color/sample_default" />
 </selector>
 

State specs

Each item defines a set of state spec and color pairs, where the state spec is a series of attributes set to either true or false to represent inclusion or exclusion. If an attribute is not specified for an item, it may be any value.

For example, the following item will be matched whenever the focused state is set; any other states may be set or unset:

 <item android:state_focused="true"
         android:color="@color/sample_focused" />
 

Typically, a color state list will reference framework-defined state attributes such as android:state_focused or android:state_enabled; however, app-defined attributes may also be used.

Note: The list of state specs will be matched against in the order that they appear in the XML file. For this reason, more-specific items should be placed earlier in the file. An item with no state spec is considered to match any set of states and is generally useful as a final item to be used as a default.

If an item with no state spec is placed before other items, those items will be ignored.

Item attributes

Each item must define an android:color attribute, which may be an HTML-style hex color, a reference to a color resource, or -- in API 23 and above -- a theme attribute that resolves to a color.

Starting with API 23, items may optionally define an android:alpha attribute to modify the base color's opacity. This attribute takes a either floating-point value between 0 and 1 or a theme attribute that resolves as such. The item's overall color is calculated by multiplying by the base color's alpha channel by the alpha value. For example, the following item represents the theme's accent color at 50% opacity:

 <item android:state_enabled="false"
         android:color="?android:attr/colorAccent"
         android:alpha="0.5" />
 

Starting with API 31, items may optionally define an android:lStar attribute to modify the base color's perceptual luminance. This attribute takes either a floating-point value between 0 and 100 or a theme attribute that resolves as such. The item's overall color is calculated by converting the base color to an accessibility friendly color space and setting its L* to the value specified on the lStar attribute. For example, the following item represents the theme's accent color at 50% perceptual luminance:

 <item android:state_enabled="false"
         android:color="?android:attr/colorAccent"
         android:lStar="50" />
 

Developer guide

For more information, see the guide to Color State List Resource.

Summary

XML attributes

android:alpha

Alpha multiplier applied to the base color.

May be a floating point value, such as "1.2".

android:color

Base color for this state.

May be a color value, in the form of "#rgb", "#argb", "#rrggbb", or "#aarrggbb".

android:lStar

Perceptual luminance applied to the base color. From 0 to 100.

May be a floating point value, such as "1.2".

Fields

public static final Creator<ColorStateList> CREATOR

Public constructors

public ColorStateList (int[][] states, 
                int[] colors)

Public methods

public static ColorStateList createFromXml (Resources r, 
                XmlPullParser parser)

public static ColorStateList createFromXml (Resources r, 
                XmlPullParser parser, 
                Resources.Theme theme)

public int describeContents ()

public int getChangingConfigurations ()

public int getColorForState (int[] stateSet, 
                int defaultColor)

public int getDefaultColor ()

public boolean isOpaque ()

public boolean isStateful ()

public String toString ()

public static ColorStateList valueOf (int color)

public ColorStateList withAlpha (int alpha)

public ColorStateList withLStar (float lStar)

public void writeToParcel (Parcel dest, 
                int flags)