TypedArray

close

open fun close(): Unit

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

open fun getBoolean(
    index: Int, 
    defValue: Boolean
): Boolean

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

open fun getChangingConfigurations(): Int

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

getColor

open fun getColor(
    index: Int, 
    defValue: Int
): Int

Retrieve the color value for the attribute at index. If the attribute references a color resource holding a complex android.content.res.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

open fun getColorStateList(index: Int): ColorStateList?

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 android.content.res.ColorStateList description.

This method will return null if the attribute is not defined or is not an integer color or color state list.

getDimension

open fun getDimension(
    index: Int, 
    defValue: Float
): Float

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

open fun getDimensionPixelOffset(
    index: Int, 
    defValue: Int
): Int

Retrieve a dimensional unit attribute at index for use as an offset in raw pixels. This is the same as getDimension, 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

open fun getDimensionPixelSize(
    index: Int, 
    defValue: Int
): Int

Retrieve a dimensional unit attribute at index for use as a size in raw pixels. This is the same as getDimension, 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

open fun getDrawable(index: Int): Drawable?

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

open fun getFloat(
    index: Int, 
    defValue: Float
): Float

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

open fun getFont(index: Int): Typeface?

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

open fun getFraction(
    index: Int, 
    base: Int, 
    pbase: Int, 
    defValue: Float
): Float

Retrieves a fractional unit attribute at index.

getIndex

open fun getIndex(at: Int): Int

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

getIndexCount

open fun getIndexCount(): Int

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

open fun getInt(
    index: Int, 
    defValue: Int
): Int

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

open fun getInteger(
    index: Int, 
    defValue: Int
): Int

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

open fun getLayoutDimension(
    index: Int, 
    defValue: Int
): Int

Special version of getDimensionPixelSize for retrieving android.view.ViewGroup's layout_width and layout_height attributes. This is only here for performance reasons; applications should use getDimensionPixelSize.

getLayoutDimension

open fun getLayoutDimension(
    index: Int, 
    name: String!
): Int

Special version of getDimensionPixelSize for retrieving android.view.ViewGroup's layout_width and layout_height attributes. This is only here for performance reasons; applications should use getDimensionPixelSize.

This method will throw an exception if the attribute is defined but is not a dimension or integer (enum).

getNonResourceString

open fun getNonResourceString(index: Int): String!

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

open fun getPositionDescription(): String!

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

getResourceId

open fun getResourceId(
    index: Int, 
    defValue: Int
): Int

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

open fun getResources(): Resources!

Returns the Resources object this array was loaded from.

getSourceResourceId

open fun getSourceResourceId(
    index: Int, 
    defaultValue: Int
): Int

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 android.view.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

open fun getString(index: Int): String?

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

open fun getText(index: Int): CharSequence!

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

open fun getTextArray(index: Int): Array<CharSequence!>!

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

open fun getType(index: Int): Int

Returns the type of attribute at the specified index.

getValue

open fun getValue(
    index: Int, 
    outValue: TypedValue!
): Boolean

Retrieve the raw TypedValue for the attribute at index.

hasValue

open fun hasValue(index: Int): Boolean

Determines whether there is an attribute at index.

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

hasValueOrEmpty

open fun hasValueOrEmpty(index: Int): Boolean

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

open fun length(): Int

Returns the number of values in this array.

peekValue

open fun peekValue(index: Int): TypedValue!

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

open fun recycle(): Unit

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

open fun toString(): String