android.content.res.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
Summary
Public Constructors
Public Methods
|
|
final |
|
|
void |
finishPreloading() |
|
|
final |
|
|
void |
flushLayoutCache() |
|
|
|
|
|
XmlResourceParser |
getAnimation(int id) |
|
|
final |
|
|
AssetManager |
getAssets() |
|
|
|
|
|
int |
getColor(int id) |
|
|
|
|
|
ColorStateList |
getColorStateList(int id) |
|
|
|
|
|
Configuration |
getConfiguration() |
|
|
|
|
|
float |
getDimension(int id) |
|
|
|
|
|
int |
getDimensionPixelOffset(int id) |
|
|
|
|
|
int |
getDimensionPixelSize(int id) |
|
|
|
|
|
DisplayMetrics |
getDisplayMetrics() |
|
|
|
|
|
Drawable |
getDrawable(int id) |
|
|
|
|
|
int |
getIdentifier(String name, String defType, String defPackage) |
|
|
|
|
|
int[] |
getIntArray(int id) |
|
|
|
|
|
int |
getInteger(int id) |
|
|
|
|
|
XmlResourceParser |
getLayout(int id) |
|
|
|
|
|
Movie |
getMovie(int id) |
|
|
|
|
|
String |
getQuantityString(int id, int quantity, Object[] formatArgs) |
|
|
|
|
|
String |
getQuantityString(int id, int quantity) |
|
|
|
|
|
CharSequence |
getQuantityText(int id, int quantity) |
|
|
|
|
|
String |
getResourceEntryName(int resid) |
|
|
|
|
|
String |
getResourceName(int resid) |
|
|
|
|
|
String |
getResourcePackageName(int resid) |
|
|
|
|
|
String |
getResourceTypeName(int resid) |
|
|
|
|
|
String |
getString(int id, Object[] formatArgs) |
|
|
|
|
|
String |
getString(int id) |
|
|
|
|
|
String[] |
getStringArray(int id) |
|
|
|
static |
|
Resources |
getSystem() |
|
|
|
|
|
CharSequence |
getText(int id, CharSequence def) |
|
|
|
|
|
CharSequence |
getText(int id) |
|
|
|
|
|
CharSequence[] |
getTextArray(int id) |
|
|
|
|
|
void |
getValue(String name, TypedValue outValue, boolean resolveRefs) |
|
|
|
|
|
void |
getValue(int id, TypedValue outValue, boolean resolveRefs) |
|
|
|
|
|
XmlResourceParser |
getXml(int id) |
|
|
final |
|
|
Resources.Theme |
newTheme() |
|
|
|
|
|
TypedArray |
obtainAttributes(AttributeSet set, int[] attrs) |
|
|
|
|
|
TypedArray |
obtainTypedArray(int id) |
|
|
|
|
|
InputStream |
openRawResource(int id) |
|
|
|
|
|
AssetFileDescriptor |
openRawResourceFd(int id) |
|
|
|
|
|
void |
updateConfiguration(Configuration config, DisplayMetrics metrics) |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
Details
Public Constructors
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
finishPreloading()
Called by zygote when it is done preloading resources, to change back
to normal Resources operation.
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.
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.
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
- A new parser object through which you can read
the XML data.
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.
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.
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
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
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
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.
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
int[]
getIntArray(int id)
Return the int 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
- The int array associated with the resource.
public
int
getInteger(int id)
Return an integer 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
- Returns the integer value contained in the resource.
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.
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
- A new parser object through which you can read
the XML data.
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. |
public
String
getQuantityString(int id, int quantity, Object[] formatArgs)
Return the string value associated with a particular resource ID for a particular
numerical quantity, 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. |
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. |
Returns
- String The string data associated with the resource,
stripped of styled text information.
public
String
getQuantityString(int id, int quantity)
Return the string value associated with a particular resource ID for a particular
numerical quantity.
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. |
quantity
| The number used to get the correct string for the current language's
plural rules. |
Returns
- String The string data associated with the resource,
stripped of styled text information.
public
CharSequence
getQuantityText(int id, int quantity)
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.
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.
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.
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.
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.
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.
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.
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
- The string array associated with the resource.
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).
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.
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.
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
- The styled text array associated with the resource.
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. |
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. |
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).
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
- A new parser object through which you can read
the XML data.
Generate a new Theme object for this set of Resources. It initially
starts out empty.
Returns
- Theme The newly created Theme container.
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
- Returns a TypedArray holding an array of the attribute values.
Be sure to call TypedArray.recycle()
when done with it.
public
TypedArray
obtainTypedArray(int id)
Return an array of heterogeneous values.
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 TypedArray holding an array of the array values.
Be sure to call TypedArray.recycle()
when done with it.
public
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.
Parameters
id
| The resource identifier to open, as generated by the appt
tool. |
Returns
- InputStream Access to the resource data.
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.
Parameters
id
| The resource identifier to open, as generated by the appt
tool. |
Returns
- AssetFileDescriptor A new file descriptor you can use to read
the resource. This includes the file descriptor itself, as well as the
offset and length of data where the resource appears in the file. A
null is returned if the file exists but is compressed.
Store the newly updated configuration.