| java.lang.Object | |
| ↳ | android.content.res.TypedArray |
Container for an array of values that were retrieved with
obtainStyledAttributes(AttributeSet, int[], int, int)
or obtainAttributes(AttributeSet, int[]). Be
sure to call recycle() when done with them.
The indices used to retrieve values from this structure correspond to
the positions of the attributes given to obtainStyledAttributes.
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Retrieve the boolean value for the attribute at index.
| |||||||||||
Return a mask of the configuration parameters for which the values in
this typed array may change.
| |||||||||||
Retrieve the color value for the attribute at index.
| |||||||||||
Retrieve the ColorStateList for the attribute at index.
| |||||||||||
Retrieve a dimensional unit attribute at index.
| |||||||||||
Retrieve a dimensional unit attribute at index for use
as an offset in raw pixels.
| |||||||||||
Retrieve a dimensional unit attribute at index for use
as a size in raw pixels.
| |||||||||||
Retrieve the Drawable for the attribute at index.
| |||||||||||
Retrieve the float value for the attribute at index.
| |||||||||||
Retrieves a fractional unit attribute at index.
| |||||||||||
Returns an index in the array that has data.
| |||||||||||
Return the number of indices in the array that actually have data.
| |||||||||||
Retrieve the integer value for the attribute at index.
| |||||||||||
Retrieve the integer value for the attribute at index.
| |||||||||||
Special version of
getDimensionPixelSize(int, int) for retrieving
ViewGroup's layout_width and layout_height
attributes.
| |||||||||||
Special version of
getDimensionPixelSize(int, int) for retrieving
ViewGroup's layout_width and layout_height
attributes.
| |||||||||||
Retrieves the string value for the attribute at index, but
only if that string comes from an immediate value in an XML file.
| |||||||||||
Returns a message about the parser state suitable for printing error messages.
| |||||||||||
Retrieves the resource identifier for the attribute at
index.
| |||||||||||
Returns the Resources object this array was loaded from.
| |||||||||||
Retrieves the string value for the attribute at index.
| |||||||||||
Retrieves the styled string value for the attribute at index.
| |||||||||||
Retrieve the CharSequence[] for the attribute at index.
| |||||||||||
Returns the type of attribute at the specified index.
| |||||||||||
Retrieve the raw TypedValue for the attribute at index.
| |||||||||||
Determines whether there is an attribute at index.
| |||||||||||
Determines whether there is an attribute at index, returning
true if the attribute was explicitly set to @empty and
false only if the attribute was undefined.
| |||||||||||
Returns the number of values in this array.
| |||||||||||
Retrieve the raw TypedValue for the attribute at index
and return a temporary object holding its data.
| |||||||||||
Recycles the TypedArray, to be re-used by a later caller.
| |||||||||||
Returns a string containing a concise, human-readable description of this
object.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Retrieve the boolean value for the attribute at index.
If the attribute is an integer value, this method will return whether
it is equal to zero. If the attribute is not a boolean or integer value,
this method will attempt to coerce it to an integer using
decode(String) and return whether it is equal to zero.
| index | Index of attribute to retrieve. |
|---|---|
| defValue | Value to return if the attribute is not defined or cannot be coerced to an integer. |
| RuntimeException | if the TypedArray has already been recycled. |
|---|
Return a mask of the configuration parameters for which the values in this typed array may change.
Developers
ActivityInfo.| RuntimeException | if the TypedArray has already been recycled. |
|---|
Retrieve the color value for the attribute at index. If
the attribute references a color resource holding a complex
ColorStateList, then the default color from
the set is returned.
This method will throw an exception if the attribute is defined but is not an integer color or color state list.
| index | Index of attribute to retrieve. |
|---|---|
| defValue | Value to return if the attribute is not defined or not a resource. |
| RuntimeException | if the TypedArray has already been recycled. |
|---|---|
| UnsupportedOperationException | if the attribute is defined but is not an integer color or color state list. |
Retrieve the ColorStateList for the attribute at index.
The value may be either a single solid color or a reference to
a color or complex ColorStateList
description.
This method will return null if the attribute is not defined or
is not an integer color or color state list.
| index | Index of attribute to retrieve. |
|---|
null if not
defined.| RuntimeException | if the attribute if the TypedArray has already been recycled. |
|---|---|
| UnsupportedOperationException | if the attribute is defined but is not an integer color or color state list. |
Retrieve a dimensional unit attribute at index. Unit
conversions are based on the current DisplayMetrics
associated with the resources this TypedArray object
came from.
This method will throw an exception if the attribute is defined but is not a dimension.
| index | Index of attribute to retrieve. |
|---|---|
| defValue | Value to return if the attribute is not defined or not a resource. |
| RuntimeException | if the TypedArray has already been recycled. |
|---|---|
| UnsupportedOperationException | if the attribute is defined but is not an integer. |
Retrieve a dimensional unit attribute at index for use
as an offset in raw pixels. This is the same as
getDimension(int, float), except the returned value is converted to
integer pixels for you. An offset conversion involves simply
truncating the base value to an integer.
This method will throw an exception if the attribute is defined but is not a dimension.
| index | Index of attribute to retrieve. |
|---|---|
| defValue | Value to return if the attribute is not defined or not a resource. |
| RuntimeException | if the TypedArray has already been recycled. |
|---|---|
| UnsupportedOperationException | if the attribute is defined but is not an integer. |
Retrieve a dimensional unit attribute at index for use
as a size in raw pixels. This is the same as
getDimension(int, float), 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.
This method will throw an exception if the attribute is defined but is not a dimension.
| index | Index of attribute to retrieve. |
|---|---|
| defValue | Value to return if the attribute is not defined or not a resource. |
| RuntimeException | if the TypedArray has already been recycled. |
|---|---|
| UnsupportedOperationException | if the attribute is defined but is not a dimension. |
Retrieve the Drawable for the attribute at index.
This method will throw an exception if the attribute is defined but is not a color or drawable resource.
| index | Index of attribute to retrieve. |
|---|
null if not defined.| RuntimeException | if the TypedArray has already been recycled. |
|---|---|
| UnsupportedOperationException | if the attribute is defined but is not a color or drawable resource. |
Retrieve the float value for the attribute at index.
If the attribute is not a float or an integer, this method will attempt
to coerce it to a float using parseFloat(String).
| index | Index of attribute to retrieve. |
|---|
| RuntimeException | if the TypedArray has already been recycled. |
|---|
Retrieves a fractional unit attribute at index.
| index | Index of attribute to retrieve. |
|---|---|
| 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. |
| defValue | Value to return if the attribute is not defined or not a resource. |
| RuntimeException | if the TypedArray has already been recycled. |
|---|---|
| UnsupportedOperationException | if the attribute is defined but is not a fraction. |
Returns an index in the array that has data.
| at | The index you would like to returned, ranging from 0 to
getIndexCount(). |
|---|
getValue(int, TypedValue) and related APIs.| RuntimeException | if the TypedArray has already been recycled. |
|---|
Return the number of indices in the array that actually have data.
| RuntimeException | if the TypedArray has already been recycled. |
|---|
Retrieve the integer value for the attribute at index.
If the attribute is not an integer, this method will attempt to coerce
it to an integer using decode(String).
| index | Index of attribute to retrieve. |
|---|---|
| defValue | Value to return if the attribute is not defined or cannot be coerced to an integer. |
| RuntimeException | if the TypedArray has already been recycled. |
|---|
Retrieve the integer value for the attribute at index.
Unlike getInt(int, int), this method will throw an exception if
the attribute is defined but is not an integer.
| index | Index of attribute to retrieve. |
|---|---|
| defValue | Value to return if the attribute is not defined or not a resource. |
| RuntimeException | if the TypedArray has already been recycled. |
|---|---|
| UnsupportedOperationException | if the attribute is defined but is not an integer. |
Special version of getDimensionPixelSize(int, int) for retrieving
ViewGroup's layout_width and layout_height
attributes. This is only here for performance reasons; applications
should use getDimensionPixelSize(int, int).
This method will throw an exception if the attribute is defined but is not a dimension or integer (enum).
| index | Index of the attribute to retrieve. |
|---|---|
| name | Textual name of attribute for error reporting. |
| RuntimeException | if the TypedArray has already been recycled. |
|---|---|
| UnsupportedOperationException | if the attribute is defined but is not a dimension or integer (enum). |
Special version of getDimensionPixelSize(int, int) for retrieving
ViewGroup's layout_width and layout_height
attributes. This is only here for performance reasons; applications
should use getDimensionPixelSize(int, int).
| index | Index of the attribute to retrieve. |
|---|---|
| defValue | The default value to return if this attribute is not default or contains the wrong type of data. |
| RuntimeException | if the TypedArray has already been recycled. |
|---|
Retrieves the string value for the attribute at index, but only if that string comes from an immediate value in an XML file. That is, this does not allow references to string resources, string attributes, or conversions from other types. As such, this method will only return strings for TypedArray objects that come from attributes in an XML file.
| index | Index of attribute to retrieve. |
|---|
null if the attribute is not defined or is not
an immediate string value.| RuntimeException | if the TypedArray has already been recycled. |
|---|
Returns a message about the parser state suitable for printing error messages.
| RuntimeException | if the TypedArray has already been recycled. |
|---|
Retrieves the resource identifier for the attribute at
index. Note that attribute resource as resolved when
the overall TypedArray object is retrieved. As a
result, this function will return the resource identifier of the
final resource value that was found, not necessarily the
original resource that was specified by the attribute.
| index | Index of attribute to retrieve. |
|---|---|
| defValue | Value to return if the attribute is not defined or not a resource. |
| RuntimeException | if the TypedArray has already been recycled. |
|---|
Returns the Resources object this array was loaded from.
| RuntimeException | if the TypedArray has already been recycled. |
|---|
Retrieves the string value for the attribute at index.
If the attribute is not a string, this method will attempt to coerce it to a string.
| index | Index of attribute to retrieve. |
|---|
null if the attribute is not defined or could
not be coerced to a string.| RuntimeException | if the TypedArray has already been recycled. |
|---|
Retrieves the styled string value for the attribute at index.
If the attribute is not a string, this method will attempt to coerce it to a string.
| index | Index of attribute to retrieve. |
|---|
null if the attribute is not defined or could not be
coerced to a string.| RuntimeException | if the TypedArray has already been recycled. |
|---|
Retrieve the CharSequence[] for the attribute at index.
This gets the resource ID of the selected attribute, and uses
Resources.getTextArray of the owning
Resources object to retrieve its String[].
This method will throw an exception if the attribute is defined but is not a text array resource.
| index | Index of attribute to retrieve. |
|---|
null if not
defined.| RuntimeException | if the TypedArray has already been recycled. |
|---|
Returns the type of attribute at the specified index.
| index | Index of attribute whose type to retrieve. |
|---|
| RuntimeException | if the TypedArray has already been recycled. |
|---|
Retrieve the raw TypedValue for the attribute at index.
| index | Index of attribute to retrieve. |
|---|---|
| outValue | TypedValue object in which to place the attribute's data. |
true if the value was retrieved, false otherwise.| RuntimeException | if the TypedArray has already been recycled. |
|---|
Determines whether there is an attribute at index.
Note: If the attribute was set to @empty or
@undefined, this method returns false.
| index | Index of attribute to retrieve. |
|---|
| RuntimeException | if the TypedArray has already been recycled. |
|---|
Determines whether there is an attribute at index, returning
true if the attribute was explicitly set to @empty and
false only if the attribute was undefined.
| index | Index of attribute to retrieve. |
|---|
| RuntimeException | if the TypedArray has already been recycled. |
|---|
Returns the number of values in this array.
| RuntimeException | if the TypedArray has already been recycled. |
|---|
Retrieve the raw TypedValue for the attribute at index
and return a temporary object holding its data. This object is only
valid until the next call on to TypedArray.
| index | Index of attribute to retrieve. |
|---|
| RuntimeException | if the TypedArray has already been recycled. |
|---|
Recycles the TypedArray, to be re-used by a later caller. After calling this function you must not ever touch the typed array again.
| RuntimeException | if the TypedArray has already been recycled. |
|---|
Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:
getClass().getName() + '@' + Integer.toHexString(hashCode())
See Writing a useful
toString method
if you intend implementing your own toString method.