Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public interface

AttributeSet

android.util.AttributeSet
Known Indirect Subclasses

Class Overview

A collection of attributes, as found associated with a tag in an XML document. Often you will not want to use this interface directly, instead passing it to Resources.Theme.obtainStyledAttributes() which will take care of parsing the attributes for you. In particular, the Resources API will convert resource references (attribute values such as "@string/my_label" in the original XML) to the desired type for you; if you use AttributeSet directly then you will need to manually check for resource references (with getAttributeResourceValue(int, int) ) and do the resource lookup yourself if needed. Direct use of AttributeSet also prevents the application of themes and styles when retrieving attribute values.

This interface provides an efficient mechanism for retrieving data from compiled XML files, which can be retrieved for a particular XmlPullParser through Xml.asAttributeSet() . Normally this will return an implementation of the interface that works on top of a generic XmlPullParser, however it is more useful in conjunction with compiled XML resources: 

        XmlPullParser parser = resources.getXml(myResouce);
 AttributeSet attributes = Xml.asAttributeSet(parser);

The implementation returned here, unlike using the implementation on top of a generic XmlPullParser, is highly optimized by retrieving pre-computed information that was generated by aapt when compiling your resources. For example, the getAttributeFloatValue(int, float) method returns a floating point number previous stored in the compiled resource instead of parsing at runtime the string originally in the XML file.

This interface also provides additional information contained in the compiled XML resource that is not available in a normal XML file, such as getAttributeNameResource(int) which returns the resource identifier associated with a particular XML attribute name.

Summary

Public Methods
abstract boolean getAttributeBooleanValue ( String namespace, String attribute, boolean defaultValue)
Return the boolean value of 'attribute'.
abstract boolean getAttributeBooleanValue (int index, boolean defaultValue)
Return the boolean value of attribute at 'index'.
abstract int getAttributeCount ()
Returns the number of attributes available in the set.
abstract float getAttributeFloatValue (int index, float defaultValue)
Return the float value of attribute at 'index'.
abstract float getAttributeFloatValue ( String namespace, String attribute, float defaultValue)
Return the float value of 'attribute'.
abstract int getAttributeIntValue ( String namespace, String attribute, int defaultValue)
Return the integer value of 'attribute'.
abstract int getAttributeIntValue (int index, int defaultValue)
Return the integer value of attribute at 'index'.
abstract int getAttributeListValue ( String namespace, String attribute, String[] options, int defaultValue)
Return the index of the value of 'attribute' in the list 'options'.
abstract int getAttributeListValue (int index, String[] options, int defaultValue)
Return the index of the value of attribute at 'index' in the list 'options'.
abstract String getAttributeName (int index)
Returns the name of the specified attribute.
abstract int getAttributeNameResource (int index)
Return the resource ID associated with the given attribute name.
abstract int getAttributeResourceValue ( String namespace, String attribute, int defaultValue)
Return the value of 'attribute' as a resource identifier.
abstract int getAttributeResourceValue (int index, int defaultValue)
Return the value of attribute at 'index' as a resource identifier.
abstract int getAttributeUnsignedIntValue (int index, int defaultValue)
Return the integer value of attribute at 'index' that is formatted as an unsigned value.
abstract int getAttributeUnsignedIntValue ( String namespace, String attribute, int defaultValue)
Return the boolean value of 'attribute' that is formatted as an unsigned value.
abstract String getAttributeValue (int index)
Returns the value of the specified attribute as a string representation.
abstract String getAttributeValue ( String namespace, String name)
Returns the value of the specified attribute as a string representation.
abstract String getClassAttribute ()
Return the value of the "class" attribute or null if there is not one.
abstract String getIdAttribute ()
Return the value of the "id" attribute or null if there is not one.
abstract int getIdAttributeResourceValue (int defaultValue)
Return the integer value of the "id" attribute or defaultValue if there is none.
abstract String getPositionDescription ()
Returns a description of the current position of the attribute set.
abstract int getStyleAttribute ()
Return the value of the "style" attribute or 0 if there is not one.

Public Methods

public abstract boolean getAttributeBooleanValue ( String namespace, String attribute, boolean defaultValue)

Added in API level 1

Return the boolean value of 'attribute'.

Parameters
namespace Namespace of attribute to retrieve.
attribute The attribute to retrieve.
defaultValue What to return if the attribute isn't found.
Returns
  • Resulting value.

public abstract boolean getAttributeBooleanValue (int index, boolean defaultValue)

Added in API level 1

Return the boolean value of attribute at 'index'.

Parameters
index Index of the desired attribute, 0...count-1.
defaultValue What to return if the attribute isn't found.
Returns
  • Resulting value.

public abstract int getAttributeCount ()

Added in API level 1

Returns the number of attributes available in the set.

Returns
  • A positive integer, or 0 if the set is empty.

public abstract float getAttributeFloatValue (int index, float defaultValue)

Added in API level 1

Return the float value of attribute at 'index'.

Parameters
index Index of the desired attribute, 0...count-1.
defaultValue What to return if the attribute isn't found.
Returns
  • Resulting value.

public abstract float getAttributeFloatValue ( String namespace, String attribute, float defaultValue)

Added in API level 1

Return the float value of 'attribute'.

Parameters
namespace Namespace of attribute to retrieve.
attribute The attribute to retrieve.
defaultValue What to return if the attribute isn't found.
Returns
  • Resulting value.

public abstract int getAttributeIntValue ( String namespace, String attribute, int defaultValue)

Added in API level 1

Return the integer value of 'attribute'.

Parameters
namespace Namespace of attribute to retrieve.
attribute The attribute to retrieve.
defaultValue What to return if the attribute isn't found.
Returns
  • Resulting value.

public abstract int getAttributeIntValue (int index, int defaultValue)

Added in API level 1

Return the integer value of attribute at 'index'.

Parameters
index Index of the desired attribute, 0...count-1.
defaultValue What to return if the attribute isn't found.
Returns
  • Resulting value.

public abstract int getAttributeListValue ( String namespace, String attribute, String[] options, int defaultValue)

Added in API level 1

Return the index of the value of 'attribute' in the list 'options'.

Parameters
namespace Namespace of attribute to retrieve.
attribute Name of attribute to retrieve.
options List of strings whose values we are checking against.
defaultValue Value returned if attribute doesn't exist or no match is found.
Returns
  • Index in to 'options' or defaultValue.

public abstract int getAttributeListValue (int index, String[] options, int defaultValue)

Added in API level 1

Return the index of the value of attribute at 'index' in the list 'options'.

Parameters
index Index of the desired attribute, 0...count-1.
options List of strings whose values we are checking against.
defaultValue Value returned if attribute doesn't exist or no match is found.
Returns
  • Index in to 'options' or defaultValue.

public abstract String getAttributeName (int index)

Added in API level 1

Returns the name of the specified attribute.

Parameters
index Index of the desired attribute, 0...count-1.
Returns
  • A String containing the name of the attribute, or null if the attribute cannot be found.

public abstract int getAttributeNameResource (int index)

Added in API level 1

Return the resource ID associated with the given attribute name. This will be the identifier for an attribute resource, which can be used by styles. Returns 0 if there is no resource associated with this attribute.

Note that this is different than getAttributeResourceValue(int, int) in that it returns a resource identifier for the attribute name; the other method returns this attribute's value as a resource identifier.

Parameters
index Index of the desired attribute, 0...count-1.
Returns
  • The resource identifier, 0 if none.

public abstract int getAttributeResourceValue ( String namespace, String attribute, int defaultValue)

Added in API level 1

Return the value of 'attribute' as a resource identifier.

Note that this is different than getAttributeNameResource(int) in that it returns the value contained in this attribute as a resource identifier (i.e., a value originally of the form "@package:type/resource"); the other method returns a resource identifier that identifies the name of the attribute.

Parameters
namespace Namespace of attribute to retrieve.
attribute The attribute to retrieve.
defaultValue What to return if the attribute isn't found.
Returns
  • Resulting value.

public abstract int getAttributeResourceValue (int index, int defaultValue)

Added in API level 1

Return the value of attribute at 'index' as a resource identifier.

Note that this is different than getAttributeNameResource(int) in that it returns the value contained in this attribute as a resource identifier (i.e., a value originally of the form "@package:type/resource"); the other method returns a resource identifier that identifies the name of the attribute.

Parameters
index Index of the desired attribute, 0...count-1.
defaultValue What to return if the attribute isn't found.
Returns
  • Resulting value.

public abstract int getAttributeUnsignedIntValue (int index, int defaultValue)

Added in API level 1

Return the integer value of attribute at 'index' that is formatted as an unsigned value. In particular, the formats 0xn...n and #n...n are handled.

Parameters
index Index of the desired attribute, 0...count-1.
defaultValue What to return if the attribute isn't found.
Returns
  • Resulting value.

public abstract int getAttributeUnsignedIntValue ( String namespace, String attribute, int defaultValue)

Added in API level 1

Return the boolean value of 'attribute' that is formatted as an unsigned value. In particular, the formats 0xn...n and #n...n are handled.

Parameters
namespace Namespace of attribute to retrieve.
attribute The attribute to retrieve.
defaultValue What to return if the attribute isn't found.
Returns
  • Resulting value.

public abstract String getAttributeValue (int index)

Added in API level 1

Returns the value of the specified attribute as a string representation.

Parameters
index Index of the desired attribute, 0...count-1.
Returns
  • A String containing the value of the attribute, or null if the attribute cannot be found.

public abstract String getAttributeValue ( String namespace, String name)

Added in API level 1

Returns the value of the specified attribute as a string representation. The lookup is performed using the attribute name.

Parameters
namespace The namespace of the attribute to get the value from.
name The name of the attribute to get the value from.
Returns
  • A String containing the value of the attribute, or null if the attribute cannot be found.

public abstract String getClassAttribute ()

Added in API level 1

Return the value of the "class" attribute or null if there is not one. Equivalent to getAttributeValue(null, "class").

Returns
  • The class attribute's value or null.

public abstract String getIdAttribute ()

Added in API level 1

Return the value of the "id" attribute or null if there is not one. Equivalent to getAttributeValue(null, "id").

Returns
  • The id attribute's value or null.

public abstract int getIdAttributeResourceValue (int defaultValue)

Added in API level 1

Return the integer value of the "id" attribute or defaultValue if there is none. Equivalent to getAttributeResourceValue(null, "id", defaultValue);

Parameters
defaultValue What to return if the "id" attribute isn't found.
Returns
  • int Resulting value.

public abstract String getPositionDescription ()

Added in API level 1

Returns a description of the current position of the attribute set. For instance, if the attribute set is loaded from an XML document, the position description could indicate the current line number.

Returns
  • A string representation of the current position in the set, may be null.

public abstract int getStyleAttribute ()

Added in API level 1

Return the value of the "style" attribute or 0 if there is not one. Equivalent to getAttributeResourceValue(null, "style").

Returns
  • The style attribute's resource identifier or 0.