CODEWITHSUNDEEP
androiddeclare-styleable
Jonathan Schneider
Jonathan Schneider

Reputation: 27727

Android library project uses declare-styleable -- how to compile?

I have a custom preferences control that I have defined a few attributes for in values/attrs.xml. Just to focus the conversation, here is an example of attributes that could be found in values/attrs.xml:

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <declare-styleable name="MyCustomView">
        <attr name="android:text"/>
        <attr name="android:textColor"/>            
        <attr name="extraInformation" format="string" />
    </declare-styleable>
</resources>

To use the attributes, you use an xmlns tag where you want to use it, and it looks something like this:

xmlns:custom="http://schemas.android.com/apk/res/com.conundrum.app.lib"

Herein lies the problem: the xmlns definition refers to the LIBRARY's package name, and this resource compiles fine in the LIBRARY project. However, the Android project that includes the Library project has a different package name and Android tries to merge all the resources. When it gets to this xmlns definition, it balks because the package name is different in the including Android project.

Anybody got any ideas for using xmlns references in Library projects that are still valid in including Android projects?

Were declare-styleables just an oversight by the Android team when they considered libraries?

Upvotes: 14

Views: 6350

Answers (6)

DevfoMobile
DevfoMobile

Reputation: 91

This fixed it for me. I also remember having this issue with Xamarin and the same solution worked for Xamarin.

xmlns:ab="http://schemas.android.com/apk/res-auto"

Upvotes: 0

Abid H. Mujtaba
Abid H. Mujtaba

Reputation: 1939

Use http://schemas.android.com/apk/res-auto

I found this solution given casually as a side-note in the AndroidSVG project:

Aside: Note the special schema URL in the namespace. If you were using a custom View from your own project you would use a URL based on your package name. For example http://schemas.android.com/apk/res/com.example.customview. But since the custom View is in an included library you should use the res-auto short-cut. The real schema URL will be automatically inserted when your app is built.

(I fixed a typo - missing /res/ subfolder - in the quoted text above)

Upvotes: 6

Mahendran
Mahendran

Reputation: 2719

Me too had the same problem. My app not detected the library-project styleable xml.

I tried this:

My Library Project package : com.lib.mylibrary My Application Project package : com.app.myapp

I tried xmlns:custom="http://schemas.android.com/apk/res/com.app.myapp

instead of xmlns:custom="http://schemas.android.com/apk/res/com.lib.mylib

It worked fine ie. try

xmlns:custom="http://schemas.android.com/apk/res/<your app package>

instead of

xmlns:custom="http://schemas.android.com/apk/res/<your lib project package>

I got this idea here

Upvotes: 3

Mopper
Mopper

Reputation: 1727

Maybe a bit late, but the issue appears to be fixed in the latest (r14) release of the dev tools.

Upvotes: 1

Graham Borland
Graham Borland

Reputation: 60681

This is a known issue in Android. A fix is expected in the next release (r13) of the development tools.

Upvotes: 5

Jarek Potiuk
Jarek Potiuk

Reputation: 20067

I actually played a lot with styleable and libraries and have the following observations:

Imagine that you have a project that has main project and included library:

main
   |--- library
  • there is no problem with compiling an application with included library even when the library contains styleable. You can for example include one of my libraries ( http://code.google.com/p/tree-view-list-android/ ). You will find a number of styleable attributes there (like collapsible) and some XMLs using it inside the library.. All compiles and works well whether you compile library alone or as included library... So here it looks good.....
  • now, you might experience strange problems with compilation of the main project when you have resources with the same name in both - library and main project. I initially did not understood it, but now I know how it works. For example if you have in your library main.xml which has android:id="@+id/some_id" and then in your main project you have another main.xml (without some_id id), then the R.id.some_id will be generated when you compile the library, but will NOT be generated in the main project - this might lead to compilation errors of the main project because included library .java files most likely will use R.id.some_id (which will be missing). I initially misunderstood the problem and tried to get id dynamically, but it was not needed at the end - it was enough to make sure your layout xmls in library use some kind of privateish namespace.
  • and now the most interesting part - how to refer to the styleable parameters in layout.xmls of the project? As you noticed, the following won't work: xmlns:custom="http://schemas.android.com/apk/res/YOUR_LIBRARY_PACKAGE" Surprisingly what works instead is xmlns:custom="http://schemas.android.com/apk/res/YOUR_MAIN_APP_PACKAGE" (!) It indeed looks like an overlook from android team, but once you know it, it works flawlessly.

Upvotes: 9

Related Questions