Skip to content

Most visited

Recently visited

navigation
Added in API level 1

AttributeSet

public interface AttributeSet

android.util.AttributeSet
Known Indirect Subclasses


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(myResource);
 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

getAttributeBooleanValue

Added in API level 1
boolean getAttributeBooleanValue (String namespace, 
                String attribute, 
                boolean defaultValue)

Return the boolean value of 'attribute'.

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

getAttributeBooleanValue

Added in API level 1
boolean getAttributeBooleanValue (int index, 
                boolean defaultValue)

Return the boolean value of attribute at 'index'.

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

getAttributeCount

Added in API level 1
int getAttributeCount ()

Returns the number of attributes available in the set.

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

getAttributeFloatValue

Added in API level 1
float getAttributeFloatValue (int index, 
                float defaultValue)

Return the float value of attribute at 'index'.

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

getAttributeFloatValue

Added in API level 1
float getAttributeFloatValue (String namespace, 
                String attribute, 
                float defaultValue)

Return the float value of 'attribute'.

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

getAttributeIntValue

Added in API level 1
int getAttributeIntValue (String namespace, 
                String attribute, 
                int defaultValue)

Return the integer value of 'attribute'.

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

getAttributeIntValue

Added in API level 1
int getAttributeIntValue (int index, 
                int defaultValue)

Return the integer value of attribute at 'index'.

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

getAttributeListValue

Added in API level 1
int getAttributeListValue (String namespace, 
                String attribute, 
                String[] options, 
                int defaultValue)

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

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

getAttributeListValue

Added in API level 1
int getAttributeListValue (int index, 
                String[] options, 
                int defaultValue)

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

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

getAttributeName

Added in API level 1
String getAttributeName (int index)

Returns the name of the specified attribute.

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

getAttributeNameResource

Added in API level 1
int getAttributeNameResource (int index)

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 int: Index of the desired attribute, 0...count-1.
Returns
int The resource identifier, 0 if none.

getAttributeResourceValue

Added in API level 1
int getAttributeResourceValue (String namespace, 
                String attribute, 
                int defaultValue)

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 String: Namespace of attribute to retrieve.
attribute String: The attribute to retrieve.
defaultValue int: What to return if the attribute isn't found.
Returns
int Resulting value.

getAttributeResourceValue

Added in API level 1
int getAttributeResourceValue (int index, 
                int defaultValue)

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 int: Index of the desired attribute, 0...count-1.
defaultValue int: What to return if the attribute isn't found.
Returns
int Resulting value.

getAttributeUnsignedIntValue

Added in API level 1
int getAttributeUnsignedIntValue (int index, 
                int defaultValue)

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 int: Index of the desired attribute, 0...count-1.
defaultValue int: What to return if the attribute isn't found.
Returns
int Resulting value.

getAttributeUnsignedIntValue

Added in API level 1
int getAttributeUnsignedIntValue (String namespace, 
                String attribute, 
                int defaultValue)

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 String: Namespace of attribute to retrieve.
attribute String: The attribute to retrieve.
defaultValue int: What to return if the attribute isn't found.
Returns
int Resulting value.

getAttributeValue

Added in API level 1
String getAttributeValue (int index)

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

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

getAttributeValue

Added in API level 1
String getAttributeValue (String namespace, 
                String name)

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

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

getClassAttribute

Added in API level 1
String getClassAttribute ()

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

Returns
String The class attribute's value or null.

getIdAttribute

Added in API level 1
String getIdAttribute ()

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

Returns
String The id attribute's value or null.

getIdAttributeResourceValue

Added in API level 1
int getIdAttributeResourceValue (int defaultValue)

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

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

getPositionDescription

Added in API level 1
String getPositionDescription ()

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
String A string representation of the current position in the set, may be null.

getStyleAttribute

Added in API level 1
int getStyleAttribute ()

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

Returns
int The style attribute's resource identifier or 0.
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.