java.lang.Object | |
↳ | android.content.res.Resources |
Known Direct Subclasses |
Class for accessing an application's resources. This sits on top of the
asset manager of the application (accessible through getAssets()
) and
provides a high-level API for getting typed data from the assets.
The Android resource system keeps track of all non-code assets associated with an
application. You can use this class to access your application's resources. You can generally
acquire the Resources
instance associated with your application
with getResources()
.
The Android SDK tools compile your application's resources into the application binary
at build time. To use a resource, you must install it correctly in the source tree (inside
your project's res/
directory) and build your application. As part of the build
process, the SDK tools generate symbols for each resource, which you can use in your application
code to access the resources.
Using application resources makes it easy to update various characteristics of your application without modifying code, and—by providing sets of alternative resources—enables you to optimize your application for a variety of device configurations (such as for different languages and screen sizes). This is an important aspect of developing Android applications that are compatible on different types of devices.
For more information about using resources, see the documentation about Application Resources.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Resources.NotFoundException | This exception is thrown by the resource APIs when a requested resource can not be found. | ||||||||||
Resources.Theme | This class holds the current attribute values for a particular theme. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Create a new Resources object on top of an existing set of assets in an
AssetManager.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Called by zygote when it is done preloading resources, to change back
to normal Resources operation.
| |||||||||||
Call this to remove all cached loaded layout resources from the
Resources object.
| |||||||||||
Return an XmlResourceParser through which you can read an animation
description for the given resource ID.
| |||||||||||
Retrieve underlying AssetManager storage for these resources.
| |||||||||||
Return a boolean associated with a particular resource ID.
| |||||||||||
Return a color integer associated with a particular resource ID.
| |||||||||||
Return a color state list associated with a particular resource ID.
| |||||||||||
Return the current configuration that is in effect for this resource
object.
| |||||||||||
Retrieve a dimensional for a particular resource ID.
| |||||||||||
Retrieve a dimensional for a particular resource ID for use
as an offset in raw pixels.
| |||||||||||
Retrieve a dimensional for a particular resource ID for use
as a size in raw pixels.
| |||||||||||
Return the current display metrics that are in effect for this resource
object.
| |||||||||||
Return a drawable object associated with a particular resource ID.
| |||||||||||
Return a drawable object associated with a particular resource ID and
styled for the specified theme.
| |||||||||||
Return a drawable object associated with a particular resource ID for the
given screen density in DPI.
| |||||||||||
Return a drawable object associated with a particular resource ID for the
given screen density in DPI and styled for the specified theme.
| |||||||||||
Retrieve a fractional unit for a particular resource ID.
| |||||||||||
Return a resource identifier for the given resource name.
| |||||||||||
Return the int array associated with a particular resource ID.
| |||||||||||
Return an integer associated with a particular resource ID.
| |||||||||||
Return an XmlResourceParser through which you can read a view layout
description for the given resource ID.
| |||||||||||
Return a movie object associated with the particular resource ID.
| |||||||||||
Formats the string necessary for grammatically correct pluralization
of the given resource ID for the given quantity, using the given arguments.
| |||||||||||
Returns the string necessary for grammatically correct pluralization
of the given resource ID for the given quantity.
| |||||||||||
Returns the character sequence necessary for grammatically correct pluralization
of the given resource ID for the given quantity.
| |||||||||||
Return the entry name for a given resource identifier.
| |||||||||||
Return the full name for a given resource identifier.
| |||||||||||
Return the package name for a given resource identifier.
| |||||||||||
Return the type name for a given resource identifier.
| |||||||||||
Return the string value associated with a particular resource ID. It
will be stripped of any styled text information.
| |||||||||||
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.
| |||||||||||
Return the string array associated with a particular resource ID.
| |||||||||||
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).
| |||||||||||
Return the string value associated with a particular resource 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.
| |||||||||||
Return the styled text array associated with a particular resource ID.
| |||||||||||
Return the raw data associated with a particular resource ID.
| |||||||||||
Return the raw data associated with a particular resource ID.
| |||||||||||
Get the raw value associated with a resource with associated density.
| |||||||||||
Return an XmlResourceParser through which you can read a generic XML
resource for the given resource ID.
| |||||||||||
Generate a new Theme object for this set of Resources.
| |||||||||||
Retrieve a set of basic attribute values from an AttributeSet, not
performing styling of them using a theme and/or style resources.
| |||||||||||
Return an array of heterogeneous values.
| |||||||||||
Open a data stream for reading a raw resource.
| |||||||||||
Open a data stream for reading a raw resource.
| |||||||||||
Open a file descriptor for reading a raw resource.
| |||||||||||
Parse a name/value pair out of an XML tag holding that data.
| |||||||||||
Parse a series of
<extra> tags from
an XML file. | |||||||||||
Store the newly updated configuration.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Create a new Resources object on top of an existing set of assets in an AssetManager.
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). |
Called by zygote when it is done preloading resources, to change back to normal Resources operation.
Call this to remove all cached loaded layout resources from the Resources object. Only intended for use with performance testing tools.
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.
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. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
Retrieve underlying AssetManager storage for these resources.
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.
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. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
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.
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. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
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.
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. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
Return the current configuration that is in effect for this resource object. The returned object should be treated as read-only.
Retrieve a dimensional for a particular resource ID. Unit
conversions are based on the current DisplayMetrics
associated
with the resources.
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. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
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.
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. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
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.
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. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
Return the current display metrics that are in effect for this resource object. The returned object should be treated as read-only.
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 retrieve the Drawable through
TypedArray.getDrawable
. Use
Context.obtainStyledAttributes
with
an array containing the resource ID of interest to create the TypedArray.
Note: To obtain a themed drawable, use
Context.getDrawable(int)
or getDrawable(int, Theme)
passing the desired theme.
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. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
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.
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. |
---|---|
theme | The theme used to style the drawable attributes, may be null . |
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
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.
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. |
---|---|
density | the desired screen density indicated by the resource as
found in DisplayMetrics . |
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
Return a drawable object associated with a particular resource ID for the given screen density in DPI and styled for the specified theme.
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. |
---|---|
density | The desired screen density indicated by the resource as
found in DisplayMetrics . |
theme | The theme used to style the drawable attributes, may be null . |
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
Retrieve a fractional unit for a particular resource ID.
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. |
---|---|
base | The base value of this fraction. In other words, a standard fraction is multiplied by this value. |
pbase | The parent base value of this fraction. In other words, a parent fraction (nn%p) is multiplied by this value. |
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
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.
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. |
Return the int array associated with a particular resource ID.
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. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
Return an integer associated with a particular resource ID.
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. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
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.
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. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
Return a movie object associated with the particular resource ID.
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. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
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.
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. |
---|---|
quantity | The number used to get the correct string for the current language's plural rules. |
formatArgs | The format arguments that will be used for substitution. |
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
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.
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. |
---|---|
quantity | The number used to get the correct string for the current language's plural rules. |
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
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.
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. |
---|---|
quantity | The number used to get the correct string for the current language's plural rules. |
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
Return the entry name for a given resource identifier.
resid | The resource identifier whose entry name is to be retrieved. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
Return the full name for a given resource identifier. This name is a single string of the form "package:type/entry".
resid | The resource identifier whose name is to be retrieved. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
Return the package name for a given resource identifier.
resid | The resource identifier whose package name is to be retrieved. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
Return the type name for a given resource identifier.
resid | The resource identifier whose type name is to be retrieved. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
Return the string value associated with a particular resource ID. It will be stripped of any styled text information.
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. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
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.
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. |
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
Return the string array associated with a particular resource ID.
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. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
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).
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.
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. |
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.
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. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
Return the styled text array associated with a particular resource ID.
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. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
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.
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. |
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
Return the raw data associated with a particular resource ID.
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. |
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
Get the raw value associated with a resource with associated density.
id | resource identifier |
---|---|
density | density in DPI |
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. |
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
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).
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. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
Generate a new Theme object for this set of Resources. It initially starts out empty.
Retrieve a set of basic attribute values from an AttributeSet, not performing styling of them using a theme and/or style resources.
set | The current attribute values to retrieve. |
---|---|
attrs | The specific attributes to be retrieved. |
TypedArray.recycle()
when done with it.Return an array of heterogeneous values.
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. |
---|
TypedArray.recycle()
when done with it.
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
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.
id | The resource identifier to open, as generated by the appt tool. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
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.
id | The resource identifier to open, as generated by the appt tool. |
---|---|
value | The TypedValue object to hold the resource information. |
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
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.
id | The resource identifier to open, as generated by the appt tool. |
---|
Resources.NotFoundException | Throws NotFoundException if the given ID does not exist. |
---|
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:
tagName | The name of the tag these attributes come from; this is only used for reporting error messages. |
---|---|
attrs | The attributes from which to retrieve the name/value pair. |
outBundle | The Bundle in which to place the parsed value. |
XmlPullParserException | If the attributes are not valid. |
---|
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.
parser | The parser from which to retrieve the extras. |
---|---|
outBundle | A Bundle in which to place all parsed extras. |
XmlPullParserException | |
IOException | |
XmlPullParserException |
Store the newly updated configuration.