Usage of TypedArray in Android Application

Question

I came across code at

HelloGallery Example

ImageAdapter.java - http://developer.android.com/resources/tutorials/views/hello-gallery.html

TypedArray a = obtainStyledAttributes(R.styleable.HelloGallery); mGalleryItemBackground = a.getResourceId(         R.styleable.HelloGallery_android_galleryItemBackground, 0); a.recycle(); 

---

attrs.xml - http://developer.android.com/resources/tutorials/views/hello-gallery.html

<?xml version="1.0" encoding="utf-8"?> <resources>     <declare-styleable name="HelloGallery">         <attr name="android:galleryItemBackground" />     </declare-styleable> </resources> 

and also code at :

Snake Game Example

TileView.java - http://developer.android.com/resources/samples/Snake/src/com/example/android/snake/TileView.html

TypedArray a = context.obtainStyledAttributes(attrs, R.styleable.TileView); mTileSize = a.getInt(R.styleable.TileView_tileSize, 12); a.recycle(); 

---

attrs.html - http://developer.android.com/resources/samples/Snake/res/values/attrs.html

<resources>   <declare-styleable name="TileView">     <attr name="tileSize" format="integer" />   </declare-styleable> </resources> 

---

1. May I know why they need to get the integer value from XML? Why don't they just code mGalleryItemBackground = 0; and mTileSize = 12;? My guess is that, they want to able to change something without touching Java code. But, I do not see any value being specified explicitly in the XML file itself. A code example to demonstrate the purpose of TypedArray and context.obtainStyledAttributes is very much appreicated.
2. Both are trying to read an integer. Why one of the example is using getResourceId technique, another is using getInt technique?
3. I refer to TypedArray JavaDoc, but I can hardly understand what recycle does?

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

Answer 1

1. May I know why they need to get the integer value from XML? Why don't they just code mGalleryItemBackground = 0; and mTileSize = 12;?

I think it's mainly to demonstrate the technique of reading XML attributes from the View constructor, rather than to meet an absolute requirement. If you wanted to re-use your custom view elsewhere (not terribly likely for something as specific as Snake I'll admit) then this is a fantastically useful thing to be able to do... to change the backgound colour etc without having to touch the Java code.

For the tile size in particular, that might be useful to read from XML in case there are different layouts for different device types... you might want different size tiles for different density+size combinations.

1. Both are trying to read an integer. Why one of the example is using getResourceId technique, another is using getInt technique?

Because the gallery background isn't an integer... it's expected to be a resource identifier (such as @drawable/foo). Yes it is still an integer, but an integer whose value isn't known until runtime. The tile size, by contrast, is a constant value and doesn't require any kind of runtime resolving.

1. I refer to TypedArray JavaDoc, but I can hardly understand what recycle does?

If in doubt, look at the source. It's basically an optimization to avoid the LayoutInflater having to allocate one of these for every view it inflates.

Answer 2

About styleable attributes

In addition to being able to change that value without touching Java code, it allows them to apply different styles to their app depending on device configuration. Instead of declaring in XML:

<com.example.android.snake.SnakeView     android:id="@+id/snake"     android:layout_width="match_parent"     android:layout_height="match_parent"     tileSize="24" /> 

they can declare these values in res/values/styles.xml:

<style name="Control.SnakeViewStyle">     <item name="android:layout_width">match_parent</item>     <item name="android:layout_height">match_parent</item>     <item name="tileSize">24</item> </style> 

and then refer to that style:

<com.example.android.snake.SnakeView     android:id="@+id/snake"     style="@styles/SnakeViewStyle" /> 

After separating styles like this they can provide different styles.xml file for each device configuration. For example, there might be one res/values/styles.xml for portrait mode and one res/values-land/styles.xml for landscape mode.

About resources and integers

If a styleable attribute is declared as "reference" instead of "integer", you would (1) get IDE content assist when writing XML for that attribute and (2) compiler would check that you haven't provided a reference to non-existing resource. Consequently, to get it you need to use getResourceId, because it may do some additional resolving to get actual resource id.

About recycle

I'm not really sure, but judging by the code of TypedArray, it seems that there's some caching mechanism inside it, and recycle() makes it work.