AColorStateList
Is an object you can define in XMLthat you can apply as a color, but will actually change colors, depending on the state oftheView
Object to which it is applied. For example,Button
Widget can exist in one of several different states (pressed, focused, or niether) and, using a color state list, you can provide a different color during each state.
You can describe the state list in an XML file. Each color is defined in<item>
Element inside a single<selector>
Element. Each<item>
Uses varous attributes to describe the state in which it shocould be used.
During each state change, the state list is traversed top to bottom and the first item thatmatches the current state will be used-the selection isNotBased on the "bestmatch," but simply the first item that meets the minimum criteria of the state.
Note:If you want to provide a static color resource, use asimple Color value.
-
File location:
-
res/color/filename.xml
The filename will be used as the resource ID.
-
Compiled resource datatype:
-
Resource pointer to
ColorStateList
.
-
Resource reference:
-
In Java:
R.color.filename
In XML:
@[package:]color/filename
-
Syntax:
-
<?xml version="1.0" encoding="utf-8"?><selector xmlns:android="http://schemas.android.com/apk/res/android" > <item android:color="hex_color" android:state_pressed=["true" | "false"] android:state_focused=["true" | "false"] android:state_selected=["true" | "false"] android:state_checkable=["true" | "false"] android:state_checked=["true" | "false"] android:state_enabled=["true" | "false"] android:state_window_focused=["true" | "false"] /></selector>
-
Elements:
-
-
<selector>
-
Required.This must be the root element. Contains one or more
<item>
Elements.
Attributes:
-
xmlns:android
-
String.
Required.Defines the XML namespace, which must be
"http://schemas.android.com/apk/res/android"
.
-
<item>
-
Defines a color to use during certain states, as described by its attributes. Must be achild of
<selector>
Element.
Attributes:
-
android:color
-
Hexadeximal color.
Required. The color is specified with anRGB value and optional alpha channel.
The value always begins with a pound (#) character and then followed by theAlpha-Red-Green-Blue information in one of the following formats:
- #RGB
- #ARGB
- #RRGGBB
- #AARRGGBB
-
android:state_pressed
-
Boolean. "True" if this item shocould be used when the object is pressed (such as when a buttonis touched/clicked); "false" if this item shoshould be used in the default, non-pressed state.
-
android:state_focused
-
Boolean. "True" if this item shocould be used when the object is focused (such as when a buttonis highlighted using the trackball/d-pad ); "false" if this item shocould be used in the default, non-focused state.
-
android:state_selected
-
Boolean. "True" if this item shocould be used when the object is selected (such as when atab is opened); "false" if this item shocould be used when the object is not selected.
-
android:state_checkable
-
Boolean. "True" if this item shocould be used when the object is checkable; "false" if thisitem shocould be used when the object is not checkable. (Only useful if the object cantransition between a checkable and non-checkable widget .)
-
android:state_checked
-
Boolean. "True" if this item shocould be used when the object is checked; "false" if itshoshould be used when the object is un-checked.
-
android:state_enabled
-
Boolean. "True" if this item shocould be used when the object is enabled (capable ofreceiving touch/click events); "false" if it shocould be used when the object is disabled.
-
android:state_window_focused
-
Boolean. "True" if this item shocould be used when the application window has focus (theapplication is in the foreground ), "false" if this item shocould be used when the applicationwindow does not have focus (for example, if the notification shade is pulled down or a dialog appears ).
Note:Remember that the first item in the state list thatmatches the current state of the object will be applied. so if the first item in the list containsnone of the state attributes above, then it will be applied every time, which is why yourdefault value shocould always be last (as demonstrated in the following example ).
-
Example:
-
XML file saved
res/color/button_text.xml
:
<?xml version="1.0" encoding="utf-8"?><selector xmlns:android="http://schemas.android.com/apk/res/android"> <item android:state_pressed="true" android:color="#ffff0000"/> <!-- pressed --> <item android:state_focused="true" android:color="#ff0000ff"/> <!-- focused --> <item android:color="#ff000000"/> <!-- default --></selector>
This layout XML will apply the color list to a View:
<Button android:layout_width="fill_parent" android:layout_height="wrap_content" android:text="@string/button_text" android:textColor="@color/button_text" />
-
See also:
-
- Color (simple value)
ColorStateList
- State List Drawable