Skip to content

Most visited

Recently visited

navigation

Resources.Theme

public final class Resources.Theme
extends Object

java.lang.Object
   ↳ android.content.res.Resources.Theme


This class holds the current attribute values for a particular theme. In other words, a Theme is a set of values for resource attributes; these are used in conjunction with TypedArray to resolve the final value for an attribute.

The Theme's attributes come into play in two ways: (1) a styled attribute can explicit reference a value in the theme through the "?themeAttribute" syntax; (2) if no value has been defined for a particular styled attribute, as a last resort we will try to find that attribute's value in the Theme.

You will normally use the obtainStyledAttributes(AttributeSet, int[], int, int) APIs to retrieve XML attributes with style and theme information applied.

Summary

Public methods

void applyStyle(int resId, boolean force)

Place new attribute values into the theme.

void dump(int priority, String tag, String prefix)

Print contents of this theme out to the log.

int getChangingConfigurations()

Returns a bit mask of configuration changes that will impact this theme (and thus require completely reloading it).

Drawable getDrawable(int id)

Return a drawable object associated with a particular resource ID and styled for the Theme.

Resources getResources()

Returns the resources to which this theme belongs.

TypedArray obtainStyledAttributes(AttributeSet set, int[] attrs, int defStyleAttr, int defStyleRes)

Return a TypedArray holding the attribute values in set that are listed in attrs.

TypedArray obtainStyledAttributes(int[] attrs)

Return a TypedArray holding the values defined by Theme which are listed in attrs.

TypedArray obtainStyledAttributes(int resId, int[] attrs)

Return a TypedArray holding the values defined by the style resource resid which are listed in attrs.

boolean resolveAttribute(int resid, TypedValue outValue, boolean resolveRefs)

Retrieve the value of an attribute in the Theme.

void setTo(Resources.Theme other)

Set this theme to hold the same contents as the theme other.

Inherited methods

From class java.lang.Object

Public methods

applyStyle

Added in API level 1
void applyStyle (int resId, 
                boolean force)

Place new attribute values into the theme. The style resource specified by resid will be retrieved from this Theme's resources, its values placed into the Theme object.

The semantics of this function depends on the force argument: If false, only values that are not already defined in the theme will be copied from the system resource; otherwise, if any of the style's attributes are already defined in the theme, the current values in the theme will be overwritten.

Parameters
resId int: The resource ID of a style resource from which to obtain attribute values.
force boolean: If true, values in the style resource will always be used in the theme; otherwise, they will only be used if not already defined in the theme.

dump

Added in API level 1
void dump (int priority, 
                String tag, 
                String prefix)

Print contents of this theme out to the log. For debugging only.

Parameters
priority int: The log priority to use.
tag String: The log tag to use.
prefix String: Text to prefix each line printed.

getChangingConfigurations

Added in API level 23
int getChangingConfigurations ()

Returns a bit mask of configuration changes that will impact this theme (and thus require completely reloading it).

Returns
int a bit mask of configuration changes, as defined by ActivityInfo

See also:

getDrawable

Added in API level 21
Drawable getDrawable (int id)

Return a drawable object associated with a particular resource ID and styled for the Theme.

Parameters
id int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
Returns
Drawable Drawable An object that can be used to draw this resource.
Throws
Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

getResources

Added in API level 21
Resources getResources ()

Returns the resources to which this theme belongs.

Returns
Resources Resources to which this theme belongs.

obtainStyledAttributes

Added in API level 1
TypedArray obtainStyledAttributes (AttributeSet set, 
                int[] attrs, 
                int defStyleAttr, 
                int defStyleRes)

Return a TypedArray holding the attribute values in set that are listed in attrs. In addition, if the given AttributeSet specifies a style class (through the "style" attribute), that style will be applied on top of the base attributes it defines.

Be sure to call TypedArray.recycle() when you are done with the array.

When determining the final value of a particular attribute, there are four inputs that come into play:

  1. Any attribute values in the given AttributeSet.
  2. The style resource specified in the AttributeSet (named "style").
  3. The default style specified by defStyleAttr and defStyleRes
  4. The base values in this theme.

Each of these inputs is considered in-order, with the first listed taking precedence over the following ones. In other words, if in the AttributeSet you have supplied <Button textColor="#ff000000">, then the button's text will always be black, regardless of what is specified in any of the styles.

Parameters
set AttributeSet: The base set of attribute values. May be null.
attrs int: The desired attributes to be retrieved.
defStyleAttr int: An attribute in the current theme that contains a reference to a style resource that supplies defaults values for the TypedArray. Can be 0 to not look for defaults.
defStyleRes int: A resource identifier of a style resource that supplies default values for the TypedArray, used only if defStyleAttr is 0 or can not be found in the theme. Can be 0 to not look for defaults.
Returns
TypedArray Returns a TypedArray holding an array of the attribute values. Be sure to call TypedArray.recycle() when done with it.

See also:

obtainStyledAttributes

Added in API level 1
TypedArray obtainStyledAttributes (int[] attrs)

Return a TypedArray holding the values defined by Theme which are listed in attrs.

Be sure to call TypedArray.recycle() when you are done with the array.

Parameters
attrs int: The desired attributes.
Returns
TypedArray Returns a TypedArray holding an array of the attribute values. Be sure to call TypedArray.recycle() when done with it.
Throws
Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

See also:

obtainStyledAttributes

Added in API level 1
TypedArray obtainStyledAttributes (int resId, 
                int[] attrs)

Return a TypedArray holding the values defined by the style resource resid which are listed in attrs.

Be sure to call TypedArray.recycle() when you are done with the array.

Parameters
resId int: The desired style resource.
attrs int: The desired attributes in the style.
Returns
TypedArray Returns a TypedArray holding an array of the attribute values. Be sure to call TypedArray.recycle() when done with it.
Throws
Resources.NotFoundException Throws NotFoundException if the given ID does not exist.

See also:

resolveAttribute

Added in API level 1
boolean resolveAttribute (int resid, 
                TypedValue outValue, 
                boolean resolveRefs)

Retrieve the value of an attribute in the Theme. The contents of outValue are ultimately filled in by getValue(int, TypedValue, boolean).

Parameters
resid int: The resource identifier of the desired theme attribute.
outValue TypedValue: Filled in with the ultimate resource value supplied by the attribute.
resolveRefs boolean: If true, resource references will be walked; if false, outValue may be a TYPE_REFERENCE. In either case, it will never be a TYPE_ATTRIBUTE.
Returns
boolean boolean Returns true if the attribute was found and outValue is valid, else false.

setTo

Added in API level 1
void setTo (Resources.Theme other)

Set this theme to hold the same contents as the theme other. If both of these themes are from the same Resources object, they will be identical after this function returns. If they are from different Resources, only the resources they have in common will be set in this theme.

Parameters
other Resources.Theme: The existing Theme to copy from.
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.