Android - An Open Handset Alliance Project

android.content
public final class

android.content.Resources.StyledAttributes

java.lang.Object
	android.content.Resources.StyledAttributes

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	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)
					Retrieve a fractional unit attribute at `index`.
				int	getInt(int index, int defValue)
					Retrieve the integer value for the attribute at `index`.
				int	getLayoutDimension(int index, String name)
					Special version of getDimensionPixelSize(int, int) for retrieving ViewGroup's layout_width and layout_height attributes.
				String	getPositionDescription()
					Returns a message about the parser state suitable for printing error messages.
				int	getResourceID(int index, int defValue)
					Retrieve the resource identifier for the attribute at `index`.
				String	getString(int index)
					Retrieve the string value for the attribute at `index`.
				CharSequence	getText(int index)
					Retrieve the styled string value for the attribute at `index`.
				CharSequence[]	getTextArray(int index)
					Retrieve the CharSequence[[]] for the attribute at `index`.
				boolean	getValue(int index, TypedValue outValue)
					Retrieve the raw TypedValue for the attribute at `index`.
				boolean	getValueAt(int index, TypedValue outValue)
				boolean	hasValue(int index)
					Determines whether there is an attribute at `index`.
				TypedValue	peekValue(int index)
					Retrieve the raw TypedValue for the attribute at `index` and return a temporary object holding its data.
				void	recycle()
					Give back a previously retrieved StyledAttributes, for later re-use.
				String	toString()
					Answers a string containing a concise, human-readable description of the receiver.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Details

Public Methods

public boolean getBoolean(int index, boolean defValue)

Retrieve the boolean value for the attribute at index.

Parameters

index	Index of attribute to retrieve.
defValue	Value to return if the attribute is not defined.

Returns

Attribute boolean value, or defValue if not defined.

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.

Parameters

index	Index of attribute to retrieve.
defValue	Value to return if the attribute is not defined or not a resource.

Returns

Attribute color value, or defValue if not defined.

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.

Parameters

index	Index of attribute to retrieve.

Returns

ColorStateList for the attribute, or null if not defined.

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 Resources.StyledAttributes object came from.

Parameters

index	Index of attribute to retrieve.
defValue	Value to return if the attribute is not defined or not a resource.

Returns

Attribute dimension value multiplied by the appropriate metric, or defValue if not defined.

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.

Parameters

index	Index of attribute to retrieve.
defValue	Value to return if the attribute is not defined or not a resource.

Returns

Attribute dimension value multiplied by the appropriate metric and truncated to integer pixels, or defValue if not defined.

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.

Parameters

index	Index of attribute to retrieve.
defValue	Value to return if the attribute is not defined or not a resource.

Returns

Attribute dimension value multiplied by the appropriate metric and truncated to integer pixels, or defValue if not defined.

public Drawable getDrawable(int index)

Retrieve the Drawable for the attribute at index. This gets the resource ID of the selected attribute, and uses Resources.getDrawable of the owning Resources object to retrieve its Drawable.

Parameters

index	Index of attribute to retrieve.

Returns

Drawable for the attribute, or null if not defined.

public float getFloat(int index, float defValue)

Retrieve the float value for the attribute at index.

Parameters

index	Index of attribute to retrieve.

Returns

Attribute float value, or defValue if not defined..

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

Retrieve a fractional unit attribute at index.

Parameters

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.

Returns

Attribute fractional value multiplied by the appropriate base value, or defValue if not defined.

public int getInt(int index, int defValue)

Retrieve the integer value for the attribute at index.

Parameters

index	Index of attribute to retrieve.
defValue	Value to return if the attribute is not defined.

Returns

Attribute int value, or defValue if not defined.

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

Parameters

index	Index of the attribute to retrieve.
name	Textual name of attribute for error reporting.

Returns

Attribute dimension value multiplied by the appropriate metric and truncated to integer pixels.

public String getPositionDescription()

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

public int getResourceID(int index, int defValue)

Retrieve the resource identifier for the attribute at index. Note that attribute resource as resolved when the overall Resources.StyledAttributes 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	Index of attribute to retrieve.
defValue	Value to return if the attribute is not defined or not a resource.

Returns

Attribute resource identifier, or defValue if not defined.

public String getString(int index)

Retrieve the string value for the attribute at index.

Parameters

index	Index of attribute to retrieve.

Returns

String holding string data. Any styling information is removed. Returns null if the attribute is not defined.

public CharSequence getText(int index)

Retrieve the styled string value for the attribute at index.

Parameters

index	Index of attribute to retrieve.

Returns

CharSequence holding string data. May be styled. Returns null if the attribute is not defined.

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[].

Parameters

index	Index of attribute to retrieve.

Returns

CharSequence[] for the attribute, or null if not defined.

public boolean getValue(int index, TypedValue outValue)

Retrieve the raw TypedValue for the attribute at index.

Parameters

index	Index of attribute to retrieve.
outValue	TypedValue object in which to place the attribute's data.

Returns

Returns true if the value was retrieved, else false.

public boolean getValueAt(int index, TypedValue outValue)

public boolean hasValue(int index)

Determines whether there is an attribute at index.

Parameters

index	Index of attribute to retrieve.

Returns

True if the attribute has a value, false otherwise.

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 Resources.StyledAttributes.

Parameters

index	Index of attribute to retrieve.

Returns

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

public void recycle()

Give back a previously retrieved StyledAttributes, for later re-use.

public String toString()

Answers a string containing a concise, human-readable description of the receiver.


e.g. "intent" or "activity"

Android - An Open Handset Alliance Project

Documentation

Goodies

android.content.Resources.StyledAttributes

Summary

Public Methods

Methods inherited from class java.lang.Object

Details

Public Methods

public boolean getBoolean(int index, boolean defValue)

Parameters

Returns

public int getColor(int index, int defValue)

Parameters

Returns

public ColorStateList getColorStateList(int index)

Parameters

Returns

public float getDimension(int index, float defValue)

Parameters

Returns

See Also

public int getDimensionPixelOffset(int index, int defValue)

Parameters

Returns

See Also

public int getDimensionPixelSize(int index, int defValue)

Parameters

Returns

See Also

public Drawable getDrawable(int index)

Parameters

Returns

public float getFloat(int index, float defValue)

Parameters

Returns

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

Parameters

Returns

public int getInt(int index, int defValue)

Parameters

Returns

public int getLayoutDimension(int index, String name)

Parameters

Returns

public String getPositionDescription()

public int getResourceID(int index, int defValue)

Parameters

Returns

public String getString(int index)

Parameters

Returns

public CharSequence getText(int index)

Parameters

Returns

public CharSequence[] getTextArray(int index)

Parameters

Returns

public boolean getValue(int index, TypedValue outValue)

Parameters

Returns

public boolean getValueAt(int index, TypedValue outValue)

public boolean hasValue(int index)

Parameters

Returns

public TypedValue peekValue(int index)

Parameters

Returns

public void recycle()

public String toString()