Resources

Resources

Resources (AssetManager assets, 
                DisplayMetrics metrics, 
                Configuration config)

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

finishPreloading

void finishPreloading ()

Called by zygote when it is done preloading resources, to change back to normal Resources operation.

flushLayoutCache

void flushLayoutCache ()

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

getAnimation

XmlResourceParser getAnimation (int id)

Return an XmlResourceParser 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.

getAssets

AssetManager getAssets ()

Retrieve underlying AssetManager storage for these resources.

getBoolean

boolean getBoolean (int id)

Return a boolean associated with a particular resource ID. This can be used with any integral resource value, and will return true if it is non-zero.

getColor

int getColor (int id)

This method was deprecated in API level 23.
Use getColor(int, Theme) instead.

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

getColor

int getColor (int id, 
                Resources.Theme theme)

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

getColorStateList

ColorStateList getColorStateList (int id, 
                Resources.Theme theme)

Returns a themed 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.

getColorStateList

ColorStateList getColorStateList (int id)

This method was deprecated in API level 23.
Use getColorStateList(int, Theme) instead.

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

getConfiguration

Configuration getConfiguration ()

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

getDimension

float getDimension (int id)

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

getDimensionPixelOffset

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.

getDimensionPixelSize

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.

getDisplayMetrics

DisplayMetrics getDisplayMetrics ()

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

getDrawable

Drawable getDrawable (int id, 
                Resources.Theme theme)

Return a drawable object associated with a particular resource ID and styled for the specified theme. Various types of objects will be returned depending on the underlying resource -- for example, a solid color, PNG image, scalable image, etc.

getDrawable

Drawable getDrawable (int id)

This method was deprecated in API level 22.
Use getDrawable(int, Theme) instead.

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.

Note: Prior to JELLY_BEAN, this function would not correctly retrieve the final configuration density when the resource ID passed here is an alias to another Drawable resource. This means that if the density configuration of the alias resource is different than the actual resource, the density of the returned Drawable would be incorrect, resulting in bad scaling. To work around this, you can instead manually resolve the aliased reference by using getValue(int, TypedValue, boolean) and passing true for resolveRefs. The resulting resourceId value may be passed to this method.

Note: To obtain a themed drawable, use Context.getDrawable(int) or getDrawable(int, Theme) passing the desired theme.

getDrawableForDensity

Drawable getDrawableForDensity (int id, 
                int density)

This method was deprecated in API level 22.
Use getDrawableForDensity(int, int, Theme) instead.

Return a drawable object associated with a particular resource ID for the given screen density in DPI. This will set the drawable's density to be the device's density multiplied by the ratio of actual drawable density to requested density. This allows the drawable to be scaled up to the correct size if needed. 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.

Note: To obtain a themed drawable, use Context.getDrawable(int) or getDrawableForDensity(int, int, Theme) passing the desired theme.

getDrawableForDensity

Drawable getDrawableForDensity (int id, 
                int density, 
                Resources.Theme theme)

Return a drawable object associated with a particular resource ID for the given screen density in DPI and styled for the specified theme.

getFraction

float getFraction (int id, 
                int base, 
                int pbase)

Retrieve a fractional unit for a particular resource ID.

getIdentifier

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.

getIntArray

int[] getIntArray (int id)

Return the int array associated with a particular resource ID.

getInteger

int getInteger (int id)

Return an integer associated with a particular resource ID.

getLayout

XmlResourceParser getLayout (int id)

Return an XmlResourceParser 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.

getMovie

Movie getMovie (int id)

Return a movie object associated with the particular resource ID.

getQuantityString

String getQuantityString (int id, 
                int quantity)

Returns the string necessary for grammatically correct pluralization of the given resource ID for the given quantity. Note that the string is selected based solely on grammatical necessity, and that such rules differ between languages. Do not assume you know which string will be returned for a given quantity. See String Resources for more detail.

getQuantityString

String getQuantityString (int id, 
                int quantity, 
                Object... formatArgs)

Formats the string necessary for grammatically correct pluralization of the given resource ID for the given quantity, using the given arguments. Note that the string is selected based solely on grammatical necessity, and that such rules differ between languages. Do not assume you know which string will be returned for a given quantity. See String Resources for more detail.

Substitution of format arguments works as if using Formatter and format(String, Object...). The resulting string will be stripped of any styled text information.

getQuantityText

CharSequence getQuantityText (int id, 
                int quantity)

Returns the character sequence necessary for grammatically correct pluralization of the given resource ID for the given quantity. Note that the character sequence is selected based solely on grammatical necessity, and that such rules differ between languages. Do not assume you know which string will be returned for a given quantity. See String Resources for more detail.

getResourceEntryName

String getResourceEntryName (int resid)

Return the entry name for a given resource identifier.

getResourceName

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

getResourcePackageName

String getResourcePackageName (int resid)

Return the package name for a given resource identifier.

getResourceTypeName

String getResourceTypeName (int resid)

Return the type name for a given resource identifier.

getString

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.

getString

String getString (int id)

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

getStringArray

String[] getStringArray (int id)

Return the string array associated with a particular resource ID.

getSystem

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

getText

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.

getText

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.

getTextArray

CharSequence[] getTextArray (int id)

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

getValue

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.

getValue

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

Return the raw data associated with a particular resource ID.

getValueForDensity

void getValueForDensity (int id, 
                int density, 
                TypedValue outValue, 
                boolean resolveRefs)

Get the raw value associated with a resource with associated density.

getXml

XmlResourceParser getXml (int id)

Return an XmlResourceParser through which you can read a generic XML resource for the given resource ID.

The XmlPullParser implementation returned here 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).

newTheme

Resources.Theme newTheme ()

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

obtainAttributes

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

obtainTypedArray

TypedArray obtainTypedArray (int id)

Return an array of heterogeneous values.

openRawResource

InputStream openRawResource (int id, 
                TypedValue value)

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

openRawResource

InputStream openRawResource (int id)

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

openRawResourceFd

AssetFileDescriptor openRawResourceFd (int id)

Open a file descriptor for reading a raw resource. This can only be used with resources whose value is the name of an asset files -- that is, it can be used to open drawable, sound, and raw resources; it will fail on string and color resources.

This function only works for resources that are stored in the package as uncompressed data, which typically includes things like mp3 files and png images.

parseBundleExtra

void parseBundleExtra (String tagName, 
                AttributeSet attrs, 
                Bundle outBundle)

Parse a name/value pair out of an XML tag holding that data. The AttributeSet must be holding the data defined by Extra. The following value types are supported:

• TYPE_STRING: Bundle.putCharSequence()
• TYPE_INT_BOOLEAN: Bundle.putBoolean()
• TYPE_FIRST_INT-TYPE_LAST_INT: Bundle.putBoolean()
• TYPE_FLOAT: Bundle.putFloat()

parseBundleExtras

void parseBundleExtras (XmlResourceParser parser, 
                Bundle outBundle)

Parse a series of <extra> tags from an XML file. You call this when you are at the parent tag of the extra tags, and it will return once all of the child tags have been parsed. This will call parseBundleExtra(String, AttributeSet, Bundle) for each extra tag encountered.

updateConfiguration

void updateConfiguration (Configuration config, 
                DisplayMetrics metrics)

Store the newly updated configuration.