belongs to Maven artifact com.android.support:support-compat:28.0.0-alpha1
ResourcesCompat
public
final
class
ResourcesCompat
extends Object
java.lang.Object | |
↳ | android.support.v4.content.res.ResourcesCompat |
Helper for accessing features in Resources
.
Summary
Nested classes | |
---|---|
class |
ResourcesCompat.FontCallback
Interface used to receive asynchronous font fetching events. |
Public methods | |
---|---|
static
int
|
getColor(Resources res, int id, Resources.Theme theme)
Returns a themed color integer associated with a particular resource ID. |
static
ColorStateList
|
getColorStateList(Resources res, int id, Resources.Theme theme)
Returns a themed color state list associated with a particular resource ID. |
static
Drawable
|
getDrawable(Resources res, int id, Resources.Theme theme)
Return a drawable object associated with a particular resource ID and styled for the specified theme. |
static
Drawable
|
getDrawableForDensity(Resources res, 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. |
static
Typeface
|
getFont(Context context, int id)
Returns a font Typeface associated with a particular resource ID. |
static
void
|
getFont(Context context, int id, ResourcesCompat.FontCallback fontCallback, Handler handler)
Returns a font Typeface associated with a particular resource ID asynchronously. |
Inherited methods | |
---|---|
From
class
java.lang.Object
|
Public methods
getColor
int getColor (Resources res, 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.
Prior to API level 23, the theme will not be applied and this method
calls through to getColor(int)
.
Parameters | |
---|---|
res |
Resources |
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. |
theme |
Resources.Theme : The theme used to style the color attributes, may be
null . |
Returns | |
---|---|
int |
A single color value in the form 0xAARRGGBB . |
Throws | |
---|---|
Resources.NotFoundException |
Throws NotFoundException if the given ID does not exist. |
getColorStateList
ColorStateList getColorStateList (Resources res, 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.
Prior to API level 23, the theme will not be applied and this method
calls through to getColorStateList(int)
.
Parameters | |
---|---|
res |
Resources |
id |
int : 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. |
theme |
Resources.Theme : The theme used to style the color attributes, may be
null . |
Returns | |
---|---|
ColorStateList |
A themed 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. |
getDrawable
Drawable getDrawable (Resources res, 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.
Prior to API level 21, the theme will not be applied and this method
simply calls through to getDrawable(int)
.
Parameters | |
---|---|
res |
Resources |
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. |
theme |
Resources.Theme : The theme used to style the drawable attributes, may be
null . |
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. |
getDrawableForDensity
Drawable getDrawableForDensity (Resources res, 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.
Prior to API level 15, the theme and density will not be applied and
this method simply calls through to getDrawable(int)
.
Prior to API level 21, the theme will not be applied and this method calls through to Resources#getDrawableForDensity(int, int).
Parameters | |
---|---|
res |
Resources |
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. |
density |
int : The desired screen density indicated by the resource as
found in DisplayMetrics . |
theme |
Resources.Theme : The theme used to style the drawable attributes, may be
null . |
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. |
getFont
Typeface getFont (Context context, int id)
Returns a font Typeface associated with a particular resource ID.
This method will block the calling thread to retrieve the requested font, including if it
is from a font provider. If you wish to not have this behavior, use
getFont(Context, int, FontCallback, Handler)
instead.
Prior to API level 23, font resources with more than one font in a family will only load the font closest to a regular weight typeface.
Parameters | |
---|---|
context |
Context : A context to retrieve the Resources from. |
id |
int : The desired resource identifier of a Typeface ,
as generated by the aapt tool. This integer encodes the
package, type, and resource entry. The value 0 is an invalid
identifier. |
Returns | |
---|---|
Typeface |
A font Typeface object. |
Throws | |
---|---|
Resources.NotFoundException |
Throws NotFoundException if the given ID does not exist. |
getFont
void getFont (Context context, int id, ResourcesCompat.FontCallback fontCallback, Handler handler)
Returns a font Typeface associated with a particular resource ID asynchronously.
Prior to API level 23, font resources with more than one font in a family will only load the font closest to a regular weight typeface.
Parameters | |
---|---|
context |
Context : A context to retrieve the Resources from. |
id |
int : The desired resource identifier of a Typeface , as generated by the aapt
tool. This integer encodes the package, type, and resource entry. The value 0 is an
invalid identifier. |
fontCallback |
ResourcesCompat.FontCallback : A callback to receive async fetching of this font. The callback will be
triggered on the UI thread. |
handler |
Handler : A handler for the thread the callback should be called on. If null, the
callback will be called on the UI thread. |
Throws | |
---|---|
Resources.NotFoundException |
Throws NotFoundException if the given ID does not exist. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-04-11 UTC.