Added in API level 1

Summary: Methods | Inherited Methods

Resources.Theme

---

Kotlin |Java

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.
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
int[]	getAttributeResolutionStack(int defStyleAttr, int defStyleRes, int explicitStyleRes) Returns the ordered list of resource ID that are considered when resolving attribute values when making an equivalent call to obtainStyledAttributes(android.util.AttributeSet, int[], int, int) .
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.
int	getExplicitStyle(AttributeSet set) Returns the resource ID for the style specified using style="..." in the AttributeSet's backing XML element or Resources#ID_NULL otherwise if not specified or otherwise not applicable.
Resources	getResources() Returns the resources to which this theme belongs.
int	hashCode() Returns a hash code value for the object.
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.
void	rebase() Rebases the theme against the parent Resource object's current configuration by re-applying the styles passed to applyStyle(int, boolean).
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.
String	toString() Returns a string representation of the object.

Inherited methods

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

applyStyle

Added in API level 1

public 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

public 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.

equals

Added in API level 1

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o	Object: This value may be null.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

getAttributeResolutionStack

Added in API level 29

public int[] getAttributeResolutionStack (int defStyleAttr, 
                int defStyleRes, 
                int explicitStyleRes)

Returns the ordered list of resource ID that are considered when resolving attribute values when making an equivalent call to obtainStyledAttributes(android.util.AttributeSet, int[], int, int) . The list will include a set of explicit styles (explicitStyleRes and it will include the default styles (defStyleAttr and defStyleRes).

Parameters
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.
explicitStyleRes	int: A resource identifier of an explicit style resource.

Returns
int[]	ordered list of resource ID that are considered when resolving attribute values. This value cannot be null.

getChangingConfigurations

Added in API level 23

public 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 Value is either 0 or a combination of ActivityInfo.CONFIG_MCC, ActivityInfo.CONFIG_MNC, ActivityInfo.CONFIG_LOCALE, ActivityInfo.CONFIG_TOUCHSCREEN, ActivityInfo.CONFIG_KEYBOARD, ActivityInfo.CONFIG_KEYBOARD_HIDDEN, ActivityInfo.CONFIG_NAVIGATION, ActivityInfo.CONFIG_ORIENTATION, ActivityInfo.CONFIG_SCREEN_LAYOUT, ActivityInfo.CONFIG_UI_MODE, ActivityInfo.CONFIG_SCREEN_SIZE, ActivityInfo.CONFIG_SMALLEST_SCREEN_SIZE, ActivityInfo.CONFIG_DENSITY, ActivityInfo.CONFIG_LAYOUT_DIRECTION, ActivityInfo.CONFIG_COLOR_MODE, ActivityInfo.CONFIG_FONT_SCALE, and ActivityInfo.CONFIG_GRAMMATICAL_GENDER

See also:

• ActivityInfo

getDrawable

Added in API level 21

public 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.

getExplicitStyle

Added in API level 29

public int getExplicitStyle (AttributeSet set)

Returns the resource ID for the style specified using style="..." in the AttributeSet's backing XML element or Resources#ID_NULL otherwise if not specified or otherwise not applicable.

Each View can have an explicit style specified in the layout file. This style is used first during the View attribute resolution, then if an attribute is not defined there the resource system looks at default style and theme as fallbacks.

Parameters
set	AttributeSet: The base set of attribute values. This value may be null.

Returns
int	The resource ID for the style specified using style="..." in the AttributeSet's backing XML element or Resources#ID_NULL otherwise if not specified or otherwise not applicable.

getResources

Added in API level 21

public Resources getResources ()

Returns the resources to which this theme belongs.

Returns
Resources	Resources to which this theme belongs.

hashCode

Added in API level 1

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int	a hash code value for this object.

obtainStyledAttributes

Added in API level 1

public 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. These attribute IDs must be sorted in ascending order. This value cannot be null.
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. This value cannot be null.

See also:

• Resources.obtainAttributes(AttributeSet, int)
• obtainStyledAttributes(int[])
• obtainStyledAttributes(int, int[])

obtainStyledAttributes

Added in API level 1

public 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. These attribute IDs must be sorted in ascending order. This value cannot be null.

Returns
TypedArray	Returns a TypedArray holding an array of the attribute values. Be sure to call TypedArray.recycle() when done with it. This value cannot be null.

Throws
Resources.NotFoundException	Throws NotFoundException if the given ID does not exist.

See also:

• Resources.obtainAttributes(AttributeSet, int)
• obtainStyledAttributes(int, int[])
• obtainStyledAttributes(AttributeSet, int[], int, int)

obtainStyledAttributes

Added in API level 1

public 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. These attribute IDs must be sorted in ascending order. This value cannot be null.

Returns
TypedArray	Returns a TypedArray holding an array of the attribute values. Be sure to call TypedArray.recycle() when done with it. This value cannot be null.

Throws
Resources.NotFoundException	Throws NotFoundException if the given ID does not exist.

See also:

• Resources.obtainAttributes(AttributeSet, int)
• obtainStyledAttributes(int[])
• obtainStyledAttributes(AttributeSet, int[], int, int)

rebase

Added in API level 29

public void rebase ()

Rebases the theme against the parent Resource object's current configuration by re-applying the styles passed to applyStyle(int, boolean).

resolveAttribute

Added in API level 1

public 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 Resources#getValue.

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

public 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.

toString

Added in API level 1

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.