Skip to content

Most visited

Recently visited

navigation

TypedArray

public class TypedArray
extends Object

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.

Summary

Public methods

boolean getBoolean(int index, boolean defValue)

Retrieve the boolean value for the attribute at index.

int getChangingConfigurations()

Return a mask of the configuration parameters for which the values in this typed array may change.

int getColor(int index, int defValue)

Retrieve the color value for the attribute at index.

ColorStateList getColorStateList(int index)

Retrieve the ColorStateList for the attribute at index.

float getDimension(int index, float defValue)

Retrieve a dimensional unit attribute at index.

int getDimensionPixelOffset(int index, int defValue)

Retrieve a dimensional unit attribute at index for use as an offset in raw pixels.

int getDimensionPixelSize(int index, int defValue)

Retrieve a dimensional unit attribute at index for use as a size in raw pixels.

Drawable getDrawable(int index)

Retrieve the Drawable for the attribute at index.

float getFloat(int index, float defValue)

Retrieve the float value for the attribute at index.

float getFraction(int index, int base, int pbase, float defValue)

Retrieves a fractional unit attribute at index.

int getIndex(int at)

Returns an index in the array that has data.

int getIndexCount()

Return the number of indices in the array that actually have data.

int getInt(int index, int defValue)

Retrieve the integer value for the attribute at index.

int getInteger(int index, int defValue)

Retrieve the integer value for the attribute at index.

int getLayoutDimension(int index, int defValue)

Special version of getDimensionPixelSize(int, int) for retrieving ViewGroup's layout_width and layout_height attributes.

int getLayoutDimension(int index, String name)

Special version of getDimensionPixelSize(int, int) for retrieving ViewGroup's layout_width and layout_height attributes.

String getNonResourceString(int index)

Retrieves the string value for the attribute at index, but only if that string comes from an immediate value in an XML file.

String getPositionDescription()

Returns a message about the parser state suitable for printing error messages.

int getResourceId(int index, int defValue)

Retrieves the resource identifier for the attribute at index.

Resources getResources()

Returns the Resources object this array was loaded from.

String getString(int index)

Retrieves the string value for the attribute at index.

CharSequence getText(int index)

Retrieves the styled string value for the attribute at index.

CharSequence[] getTextArray(int index)

Retrieve the CharSequence[] for the attribute at index.

int getType(int index)

Returns the type of attribute at the specified index.

boolean getValue(int index, TypedValue outValue)

Retrieve the raw TypedValue for the attribute at index.

boolean hasValue(int index)

Determines whether there is an attribute at index.

boolean hasValueOrEmpty(int 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.

int length()

Returns the number of values in this array.

TypedValue peekValue(int index)

Retrieve the raw TypedValue for the attribute at index and return a temporary object holding its data.

void recycle()

Recycles the TypedArray, to be re-used by a later caller.

String toString()

Returns a string representation of the object.

Inherited methods

From class java.lang.Object

Public methods

getBoolean

Added in API level 1
boolean getBoolean (int index, 
                boolean defValue)

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.

Parameters
index int: Index of attribute to retrieve.
defValue boolean: Value to return if the attribute is not defined or cannot be coerced to an integer.
Returns
boolean Boolean value of the attribute, or defValue if the attribute was not defined or could not be coerced to an integer.
Throws
RuntimeException if the TypedArray has already been recycled.

getChangingConfigurations

Added in API level 21
int getChangingConfigurations ()

Return a mask of the configuration parameters for which the values in this typed array may change.

Returns
int Returns a mask of the changing configuration parameters, as defined by ActivityInfo.
Throws
RuntimeException if the TypedArray has already been recycled.

See also:

getColor

Added in API level 1
int getColor (int index, 
                int defValue)

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.

Parameters
index int: Index of attribute to retrieve.
defValue int: Value to return if the attribute is not defined or not a resource.
Returns
int Attribute color value, or defValue if not defined.
Throws
RuntimeException if the TypedArray has already been recycled.
UnsupportedOperationException if the attribute is defined but is not an integer color or color state list.

getColorStateList

Added in API level 1
ColorStateList getColorStateList (int index)

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.

Parameters
index int: Index of attribute to retrieve.
Returns
ColorStateList ColorStateList for the attribute, or null if not defined.
Throws
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.

getDimension

Added in API level 1
float getDimension (int index, 
                float defValue)

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.

Parameters
index int: Index of attribute to retrieve.
defValue float: Value to return if the attribute is not defined or not a resource.
Returns
float Attribute dimension value multiplied by the appropriate metric, or defValue if not defined.
Throws
RuntimeException if the TypedArray has already been recycled.
UnsupportedOperationException if the attribute is defined but is not an integer.

See also:

getDimensionPixelOffset

Added in API level 1
int getDimensionPixelOffset (int index, 
                int defValue)

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.

Parameters
index int: Index of attribute to retrieve.
defValue int: Value to return if the attribute is not defined or not a resource.
Returns
int Attribute dimension value multiplied by the appropriate metric and truncated to integer pixels, or defValue if not defined.
Throws
RuntimeException if the TypedArray has already been recycled.
UnsupportedOperationException if the attribute is defined but is not an integer.

See also:

getDimensionPixelSize

Added in API level 1
int getDimensionPixelSize (int index, 
                int defValue)

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.

Parameters
index int: Index of attribute to retrieve.
defValue int: Value to return if the attribute is not defined or not a resource.
Returns
int Attribute dimension value multiplied by the appropriate metric and truncated to integer pixels, or defValue if not defined.
Throws
RuntimeException if the TypedArray has already been recycled.
UnsupportedOperationException if the attribute is defined but is not a dimension.

See also:

getDrawable

Added in API level 1
Drawable getDrawable (int index)

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.

Parameters
index int: Index of attribute to retrieve.
Returns
Drawable Drawable for the attribute, or null if not defined.
Throws
RuntimeException if the TypedArray has already been recycled.
UnsupportedOperationException if the attribute is defined but is not a color or drawable resource.

getFloat

Added in API level 1
float getFloat (int index, 
                float defValue)

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

Parameters
index int: Index of attribute to retrieve.
defValue float
Returns
float Attribute float value, or defValue if the attribute was not defined or could not be coerced to a float.
Throws
RuntimeException if the TypedArray has already been recycled.

getFraction

Added in API level 1
float getFraction (int index, 
                int base, 
                int pbase, 
                float defValue)

Retrieves a fractional unit attribute at index.

Parameters
index int: Index of attribute to retrieve.
base int: The base value of this fraction. In other words, a standard fraction is multiplied by this value.
pbase int: The parent base value of this fraction. In other words, a parent fraction (nn%p) is multiplied by this value.
defValue float: Value to return if the attribute is not defined or not a resource.
Returns
float Attribute fractional value multiplied by the appropriate base value, or defValue if not defined.
Throws
RuntimeException if the TypedArray has already been recycled.
UnsupportedOperationException if the attribute is defined but is not a fraction.

getIndex

Added in API level 1
int getIndex (int at)

Returns an index in the array that has data.

Parameters
at int: The index you would like to returned, ranging from 0 to getIndexCount().
Returns
int The index at the given offset, which can be used with getValue(int, TypedValue) and related APIs.
Throws
RuntimeException if the TypedArray has already been recycled.

getIndexCount

Added in API level 1
int getIndexCount ()

Return the number of indices in the array that actually have data.

Returns
int
Throws
RuntimeException if the TypedArray has already been recycled.

getInt

Added in API level 1
int getInt (int index, 
                int defValue)

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

Parameters
index int: Index of attribute to retrieve.
defValue int: Value to return if the attribute is not defined or cannot be coerced to an integer.
Returns
int Integer value of the attribute, or defValue if the attribute was not defined or could not be coerced to an integer.
Throws
RuntimeException if the TypedArray has already been recycled.

getInteger

Added in API level 1
int getInteger (int index, 
                int defValue)

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.

Parameters
index int: Index of attribute to retrieve.
defValue int: Value to return if the attribute is not defined or not a resource.
Returns
int Attribute integer value, or defValue if not defined.
Throws
RuntimeException if the TypedArray has already been recycled.
UnsupportedOperationException if the attribute is defined but is not an integer.

getLayoutDimension

Added in API level 3
int getLayoutDimension (int index, 
                int defValue)

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

Parameters
index int: Index of the attribute to retrieve.
defValue int: The default value to return if this attribute is not default or contains the wrong type of data.
Returns
int Attribute dimension value multiplied by the appropriate metric and truncated to integer pixels.
Throws
RuntimeException if the TypedArray has already been recycled.

getLayoutDimension

Added in API level 1
int getLayoutDimension (int index, 
                String name)

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

Parameters
index int: Index of the attribute to retrieve.
name String: Textual name of attribute for error reporting.
Returns
int Attribute dimension value multiplied by the appropriate metric and truncated to integer pixels.
Throws
RuntimeException if the TypedArray has already been recycled.
UnsupportedOperationException if the attribute is defined but is not a dimension or integer (enum).

getNonResourceString

Added in API level 1
String getNonResourceString (int index)

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.

Parameters
index int: Index of attribute to retrieve.
Returns
String String holding string data. Any styling information is removed. Returns null if the attribute is not defined or is not an immediate string value.
Throws
RuntimeException if the TypedArray has already been recycled.

getPositionDescription

Added in API level 1
String getPositionDescription ()

Returns a message about the parser state suitable for printing error messages.

Returns
String Human-readable description of current parser state.
Throws
RuntimeException if the TypedArray has already been recycled.

getResourceId

Added in API level 1
int getResourceId (int index, 
                int defValue)

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.

Parameters
index int: Index of attribute to retrieve.
defValue int: Value to return if the attribute is not defined or not a resource.
Returns
int Attribute resource identifier, or defValue if not defined.
Throws
RuntimeException if the TypedArray has already been recycled.

getResources

Added in API level 1
Resources getResources ()

Returns the Resources object this array was loaded from.

Returns
Resources
Throws
RuntimeException if the TypedArray has already been recycled.

getString

Added in API level 1
String getString (int index)

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.

Parameters
index int: Index of attribute to retrieve.
Returns
String String holding string data. Any styling information is removed. Returns null if the attribute is not defined or could not be coerced to a string.
Throws
RuntimeException if the TypedArray has already been recycled.

getText

Added in API level 1
CharSequence getText (int index)

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.

Parameters
index int: Index of attribute to retrieve.
Returns
CharSequence CharSequence holding string data. May be styled. Returns null if the attribute is not defined or could not be coerced to a string.
Throws
RuntimeException if the TypedArray has already been recycled.

getTextArray

Added in API level 1
CharSequence[] getTextArray (int index)

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.

Parameters
index int: Index of attribute to retrieve.
Returns
CharSequence[] CharSequence[] for the attribute, or null if not defined.
Throws
RuntimeException if the TypedArray has already been recycled.

getType

Added in API level 21
int getType (int index)

Returns the type of attribute at the specified index.

Parameters
index int: Index of attribute whose type to retrieve.
Returns
int Attribute type.
Throws
RuntimeException if the TypedArray has already been recycled.

getValue

Added in API level 1
boolean getValue (int index, 
                TypedValue outValue)

Retrieve the raw TypedValue for the attribute at index.

Parameters
index int: Index of attribute to retrieve.
outValue TypedValue: TypedValue object in which to place the attribute's data.
Returns
boolean true if the value was retrieved, false otherwise.
Throws
RuntimeException if the TypedArray has already been recycled.

hasValue

Added in API level 1
boolean hasValue (int index)

Determines whether there is an attribute at index.

Note: If the attribute was set to @empty or @undefined, this method returns false.

Parameters
index int: Index of attribute to retrieve.
Returns
boolean True if the attribute has a value, false otherwise.
Throws
RuntimeException if the TypedArray has already been recycled.

hasValueOrEmpty

Added in API level 22
boolean hasValueOrEmpty (int 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.

Parameters
index int: Index of attribute to retrieve.
Returns
boolean True if the attribute has a value or is empty, false otherwise.
Throws
RuntimeException if the TypedArray has already been recycled.

length

Added in API level 1
int length ()

Returns the number of values in this array.

Returns
int
Throws
RuntimeException if the TypedArray has already been recycled.

peekValue

Added in API level 1
TypedValue peekValue (int index)

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.

Parameters
index int: Index of attribute to retrieve.
Returns
TypedValue Returns a TypedValue object if the attribute is defined, containing its data; otherwise returns null. (You will not receive a TypedValue whose type is TYPE_NULL.)
Throws
RuntimeException if the TypedArray has already been recycled.

recycle

Added in API level 1
void recycle ()

Recycles the TypedArray, to be re-used by a later caller. After calling this function you must not ever touch the typed array again.

Throws
RuntimeException if the TypedArray has already been recycled.

toString

Added in API level 1
String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.