TypedArray

close

public void close ()

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

getBoolean

public boolean getBoolean (int index, 
                boolean defValue)

Retrieve the boolean value for the attribute at index.

If the attribute is an integer value, this method returns false if the attribute is equal to zero, and true otherwise. If the attribute is not a boolean or integer value, this method will attempt to coerce it to an integer using Integer#decode(String) and return whether it is equal to zero.

getChangingConfigurations

public int getChangingConfigurations ()

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

getColor

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

getColorStateList

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

getDimension

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

getDimensionPixelOffset

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

getDimensionPixelSize

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

getDrawable

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

getFloat

public 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 Float#parseFloat(String).

getFont

public Typeface getFont (int index)

Retrieve the Typeface for the attribute at index.

This method will throw an exception if the attribute is defined but is not a font.

getFraction

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

Retrieves a fractional unit attribute at index.

getIndex

public int getIndex (int at)

Returns an index in the array that has data. Attributes with a value of @empty are included, as this is an explicit indicator.

getIndexCount

public int getIndexCount ()

Returns the number of indices in the array that actually have data. Attributes with a value of @empty are included, as this is an explicit indicator.

getInt

public 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 Integer#decode(String).

getInteger

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

getLayoutDimension

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

getLayoutDimension

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

getNonResourceString

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

getPositionDescription

public String getPositionDescription ()

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

getResourceId

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

getResources

public Resources getResources ()

Returns the Resources object this array was loaded from.

getSourceResourceId

public int getSourceResourceId (int index, 
                int defaultValue)

Returns the resource ID of the style or layout against which the specified attribute was resolved, otherwise returns defValue. For example, if you we resolving two attributes android:attribute1 and android:attribute2 and you were inflating a View from layout/my_layout.xml:

     <View
         style="@style/viewStyle"
         android:layout_width="wrap_content"
         android:layout_height="wrap_content"
         android:attribute1="foo"/>
 

     <style android:name="viewStyle">
         <item name="android:attribute2">bar<item/>
     <style/>
 

getString

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

getText

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

getTextArray

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

getType

public int getType (int index)

Returns the type of attribute at the specified index.

getValue

public boolean getValue (int index, 
                TypedValue outValue)

Retrieve the raw TypedValue for the attribute at index.

hasValue

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

hasValueOrEmpty

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

length

public int length ()

Returns the number of values in this array.

peekValue

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

recycle

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

toString

public String toString ()

Returns a string representation of the object.