Android - An Open Handset Alliance Project

android.content
public class

android.content.Resources

java.lang.Object
	android.content.Resources

Class for accessing an application's resources. This sits on top of the asset manager of the application (accessible through getAssets()) and provides a higher-level API for getting typed data from the assets.

Nested Classes

Resources.Configuration	This class describes all device configuration information that can impact the resources the application retrieves.
Resources.NotFoundException	This exception is thrown by the resource APIs when a requested resource can not be found.
Resources.StyledAttributes	Container for an array of values that were retrieved with obtainStyledAttributes(AttributeSet, int[], int, int) or obtainAttributes(AttributeSet, int[]).
Resources.Theme	This class holds the current attribute values for a particular theme.

Summary

Public Constructors

					Resources(AssetManager assets, DisplayMetrics metrics, Configuration config)
					Create a new Resources object on top of an existing set of assets in an AssetManager.

Public Methods

final		void	flushLayoutCache()
			Call this to remove all cached loaded layout resources from the Resources object.
		XmlPullParser	getAnimation(int id)
			Return an XmlPullParser through which you can read an animation description for the given resource ID.
final		AssetManager	getAssets()
			Retrieve underlying AssetManager storage for these resources.
		int	getColor(int id)
			Return a color integer associated with a particular resource ID.
		ColorStateList	getColorStateList(int id)
			Return a color state list associated with a particular resource ID.
		Configuration	getConfiguration()
			Return the current configuration that is in effect for this resource object.
		float	getDimension(int id)
			Retrieve a dimensional for a particular resource ID.
		int	getDimensionPixelOffset(int id)
			Retrieve a dimensional for a particular resource ID for use as an offset in raw pixels.
		int	getDimensionPixelSize(int id)
			Retrieve a dimensional for a particular resource ID for use as a size in raw pixels.
		DisplayMetrics	getDisplayMetrics()
			Return the current display metrics that are in effect for this resource object.
		Drawable	getDrawable(int id)
			Return a drawable object associated with a particular resource ID.
		int	getIdentifier(String name, String defType, String defPackage)
			Return a resource identifier for the given resource name.
		XmlPullParser	getLayout(int id)
			Return an XmlPullParser through which you can read a view layout description for the given resource ID.
		Movie	getMovie(int id)
			Return a movie object associated with the particular resource ID.
		String	getResourceEntryName(int resid)
			Return the entry name for a given resource identifier.
		String	getResourceName(int resid)
			Return the full name for a given resource identifier.
		String	getResourcePackageName(int resid)
			Return the package name for a given resource identifier.
		String	getResourceTypeName(int resid)
			Return the type name for a given resource identifier.
		String	getString(int id, Object[] formatArgs)
			Return the string value associated with a particular resource ID, substituting the format arguments as defined in Formatter and format(String, Object...). It will be stripped of any styled text information.
		String	getString(int id)
			Return the string value associated with a particular resource ID. It will be stripped of any styled text information.
		String[]	getStringArray(int id)
			Return the string array associated with a particular resource ID.
	static	Resources	getSystem()
			Return a global shared Resources object that provides access to only system resources (no application resources), and is not configured for the current screen (can not use dimension units, does not change based on orientation, etc).
		CharSequence	getText(int id, CharSequence def)
			Return the string value associated with a particular resource ID.
		CharSequence	getText(int id)
			Return the string value associated with a particular resource ID. The returned object will be a String if this is a plain string; it will be some other type of CharSequence if it is styled.
		CharSequence[]	getTextArray(int id)
			Return the styled text array associated with a particular resource ID.
		void	getValue(String name, TypedValue outValue, boolean resolveRefs)
			Return the raw data associated with a particular resource ID.
		void	getValue(int id, TypedValue outValue, boolean resolveRefs)
			Return the raw data associated with a particular resource ID.
		XmlPullParser	getXml(int id)
			Return an XmlPullParser through which you can read a generic XML resource for the given resource ID.
final		Theme	newTheme()
			Generate a new Theme object for this set of Resources.
		StyledAttributes	obtainAttributes(AttributeSet set, int[] attrs)
			Retrieve a set of basic attribute values from an AttributeSet, not performing styling of them using a theme and/or style resources.
		InputStream	openRawResource(int id)
			Open a data stream for reading a raw resource.
		void	updateConfiguration(Configuration config, DisplayMetrics metrics)
			Store the newly updated configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Details

Public Constructors

public Resources(AssetManager assets, DisplayMetrics metrics, Configuration config)

Create a new Resources object on top of an existing set of assets in an AssetManager.

Parameters

assets	Previously created AssetManager.
metrics	Current display metrics to consider when selecting/computing resource values.
config	Desired device configuration to consider when selecting/computing resource values (optional).

Public Methods

public final void flushLayoutCache()

Call this to remove all cached loaded layout resources from the Resources object. Only intended for use with performance testing tools.

public XmlPullParser getAnimation(int id)

Return an XmlPullParser through which you can read an animation description for the given resource ID. This parser has limited functionality -- in particular, you can't change its input, and only the high-level events are available.

This function is really a simple wrapper for calling getXml(int) with an animation resource.

Parameters

id	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

XmlPullParser A new parser object through which you can read the XML data.

Throws

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

public final AssetManager getAssets()

Retrieve underlying AssetManager storage for these resources.

public int getColor(int id)

Return a color integer associated with a particular resource ID. If the resource holds a complex ColorStateList, then the default color from the set is returned.

Parameters

id	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

Returns a single color value in the form 0xAARRGGBB.

Throws

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

public ColorStateList getColorStateList(int id)

Return a color state list associated with a particular resource ID. The resource may contain either a single raw color value, or a complex ColorStateList holding multiple possible colors.

Parameters

id	The desired resource identifier of a ColorStateList, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.

Returns

Returns a ColorStateList object containing either a single solid color or multiple colors that can be selected based on a state.

Throws

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

public Configuration getConfiguration()

Return the current configuration that is in effect for this resource object. The returned object should be treated as read-only.

Returns

The resource's current configuration.

public float getDimension(int id)

Retrieve a dimensional for a particular resource ID. Unit conversions are based on the current DisplayMetrics associated with the resources.

Parameters

id	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

Resource dimension value multiplied by the appropriate metric.CharSequence The string data associated with the resource, plus

Throws

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

public int getDimensionPixelOffset(int id)

Retrieve a dimensional for a particular resource ID for use as an offset in raw pixels. This is the same as getDimension(int), except the returned value is converted to integer pixels for you. An offset conversion involves simply truncating the base value to an integer.

Parameters

id	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

Resource dimension value multiplied by the appropriate metric and truncated to integer pixels.CharSequence The string data associated with the resource, plus

Throws

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

public int getDimensionPixelSize(int id)

Retrieve a dimensional for a particular resource ID for use as a size in raw pixels. This is the same as getDimension(int), except the returned value is converted to integer pixels for use as a size. A size conversion involves rounding the base value, and ensuring that a non-zero base value is at least one pixel in size.

Parameters

id	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

Resource dimension value multiplied by the appropriate metric and truncated to integer pixels.CharSequence The string data associated with the resource, plus

Throws

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

public DisplayMetrics getDisplayMetrics()

Return the current display metrics that are in effect for this resource object. The returned object should be treated as read-only.

Returns

The resource's current display metrics.

public Drawable getDrawable(int id)

Return a drawable object associated with a particular resource ID. Various types of objects will be returned depending on the underlying resource -- for example, a solid color, PNG image, scalable image, etc. The Drawable API hides these implementation details.

Parameters

id	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 An object that can be used to draw this resource.

Throws

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

public int getIdentifier(String name, String defType, String defPackage)

Return a resource identifier for the given resource name. A fully qualified resource name is of the form "package:type/entry". The first two components (package and type) are optional if defType and defPackage, respectively, are specified here.

Note: use of this function is discouraged. It is much more efficient to retrieve resources by identifier than by name.

Parameters

name	The name of the desired resource.
defType	Optional default resource type to find, if "type/" is not included in the name. Can be null to require an explicit type.
defPackage	Optional default package to find, if "package:" is not included in the name. Can be null to require an explicit package.

Returns

int The associated resource identifier. Returns 0 if no such resource was found. (0 is not a valid resource ID.)

public XmlPullParser getLayout(int id)

Return an XmlPullParser through which you can read a view layout description for the given resource ID. This parser has limited functionality -- in particular, you can't change its input, and only the high-level events are available.

This function is really a simple wrapper for calling getXml(int) with a layout resource.

Parameters

id	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

XmlPullParser A new parser object through which you can read the XML data.

Throws

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

public Movie getMovie(int id)

Return a movie object associated with the particular resource ID.

Parameters

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

Throws

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

public String getResourceEntryName(int resid)

Return the entry name for a given resource identifier.

Parameters

resid	The resource identifier whose entry name is to be retrieved.

Returns

A string holding the entry name of the resource.

Throws

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

public String getResourceName(int resid)

Return the full name for a given resource identifier. This name is a single string of the form "package:type/entry".

Parameters

resid	The resource identifier whose name is to be retrieved.

Returns

A string holding the name of the resource.

Throws

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

public String getResourcePackageName(int resid)

Return the package name for a given resource identifier.

Parameters

resid	The resource identifier whose package name is to be retrieved.

Returns

A string holding the package name of the resource.

Throws

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

public String getResourceTypeName(int resid)

Return the type name for a given resource identifier.

Parameters

resid	The resource identifier whose type name is to be retrieved.

Returns

A string holding the type name of the resource.

Throws

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

public String getString(int id, Object[] formatArgs)

Return the string value associated with a particular resource ID, substituting the format arguments as defined in Formatter and format(String, Object...). It will be stripped of any styled text information.

Parameters

id	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.
formatArgs	The format arguments that will be used for substitution.

Returns

String The string data associated with the resource, stripped of styled text information.

Throws

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

public String getString(int id)

Return the string value associated with a particular resource ID. It will be stripped of any styled text information.

Parameters

id	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

String The string data associated with the resource, stripped of styled text information.

Throws

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

public String[] getStringArray(int id)

Return the string array associated with a particular resource ID.

Parameters

id	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

Sting[] The string array associated with the resource.

Throws

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

public static Resources getSystem()

Return a global shared Resources object that provides access to only system resources (no application resources), and is not configured for the current screen (can not use dimension units, does not change based on orientation, etc).

public CharSequence getText(int id, CharSequence def)

Return the string value associated with a particular resource ID. The returned object will be a String if this is a plain string; it will be some other type of CharSequence if it is styled.

Parameters

id	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.
def	The default CharSequence to return.

Returns

CharSequence The string data associated with the resource, plus possibly styled text information, or def if id is 0 or not found.

public CharSequence getText(int id)

Return the string value associated with a particular resource ID. The returned object will be a String if this is a plain string; it will be some other type of CharSequence if it is styled.

Parameters

id	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

CharSequence The string data associated with the resource, plus possibly styled text information.

Throws

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

public CharSequence[] getTextArray(int id)

Return the styled text array associated with a particular resource ID.

Parameters

id	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

CharSequence[] The styled text array associated with the resource.

Throws

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

public void getValue(String name, TypedValue outValue, boolean resolveRefs)

Return the raw data associated with a particular resource ID. See getIdentifier() for information on how names are mapped to resource IDs, and getString(int) for information on how string resources are retrieved.

Note: use of this function is discouraged. It is much more efficient to retrieve resources by identifier than by name.

Parameters

name	The name of the desired resource. This is passed to getIdentifier() with a default type of "string".
outValue	Object in which to place the resource data.
resolveRefs	If true, a resource that is a reference to another resource will be followed so that you receive the actual final resource data. If false, the TypedValue will be filled in with the reference itself.

Throws

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

public void getValue(int id, TypedValue outValue, boolean resolveRefs)

Return the raw data associated with a particular resource ID.

Parameters

id	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.
outValue	Object in which to place the resource data.
resolveRefs	If true, a resource that is a reference to another resource will be followed so that you receive the actual final resource data. If false, the TypedValue will be filled in with the reference itself.

Throws

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

public XmlPullParser getXml(int id)

Return an XmlPullParser through which you can read a generic XML resource for the given resource ID. The returned parser is a special implementation that reads its data from a compiled representation of the XML resource, to provide both improved performance and additional features. These advanced capabilities can be accessed by casting the returned parser to a AttributeSet interface:

 XmlPullParser parser = resoruces.getXml(myResouce);
 AttributeSet attributes = (AttributeSet)parser;

The XmlPullParser implementation returned here also has some limited functionality. In particular, you can't change its input, and only high-level parsing events are available (since the document was pre-parsed for you at build time, which involved merging text and stripping comments).

Parameters

id	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

XmlPullParser A new parser object through which you can read the XML data.

Throws

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

public final Theme newTheme()

Generate a new Theme object for this set of Resources. It initially starts out empty.

Returns

Theme The newly created Theme container.

public StyledAttributes obtainAttributes(AttributeSet set, int[] attrs)

Retrieve a set of basic attribute values from an AttributeSet, not performing styling of them using a theme and/or style resources.

Parameters

set	The current attribute values to retrieve.
attrs	The specific attributes to be retrieved.

Returns

StyledAttributes holding an array of the attribute values.

public InputStream openRawResource(int id)

Open a data stream for reading a raw resource. This can only be used with resources that are the names of asset files -- that is, it can be used to open drawable, sound, and raw resources; it will fail on string and color resources.

Parameters

id	The resource identifier to open, as generated by the appt tool.

Returns

InputStream Access to the resource data.

Throws

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

public void updateConfiguration(Configuration config, DisplayMetrics metrics)

Store the newly updated configuration.


e.g. "intent" or "activity"

Android - An Open Handset Alliance Project

Documentation

Goodies

android.content.Resources

Nested Classes

Summary

Public Constructors

Public Methods

Methods inherited from class java.lang.Object

Details

Public Constructors

public Resources(AssetManager assets, DisplayMetrics metrics, Configuration config)

Parameters

Public Methods

public final void flushLayoutCache()

public XmlPullParser getAnimation(int id)

Parameters

Returns

Throws

See Also

public final AssetManager getAssets()

public int getColor(int id)

Parameters

Returns

Throws

public ColorStateList getColorStateList(int id)

Parameters

Returns

Throws

public Configuration getConfiguration()

Returns

public float getDimension(int id)

Parameters

Returns

Throws

See Also

public int getDimensionPixelOffset(int id)

Parameters

Returns

Throws

See Also

public int getDimensionPixelSize(int id)

Parameters

Returns

Throws

See Also

public DisplayMetrics getDisplayMetrics()

Returns

public Drawable getDrawable(int id)

Parameters

Returns

Throws

public int getIdentifier(String name, String defType, String defPackage)

Parameters

Returns

public XmlPullParser getLayout(int id)

Parameters

Returns

Throws

See Also

public Movie getMovie(int id)

Parameters

Throws

public String getResourceEntryName(int resid)

Parameters

Returns

Throws

See Also

public String getResourceName(int resid)

Parameters

Returns

Throws

See Also

public String getResourcePackageName(int resid)

Parameters

Returns

Throws

See Also

public String getResourceTypeName(int resid)

Parameters