• スポンサードリンク

Android4.xでもカスタムViewにレイアウトxmlでベクタードローアブルを割り当てたいんじゃぁ〜

Android widget

今更な話ですが、Android5(APIレベル21)以降ではベクタードローアブルがサポートされるようになりました。ですのでAPI21以上のみをターゲットとする場合、アプリをビルドして実行する上ではテンプレ通りに設定すれば問題はありません、たぶん。(ベクタードローアブル自体は色々微妙な挙動する場合があって困ったものですが)

Android4.xの場合でもサポートライブラリやandroixを使うことで一応はベクタードローアブルに対応することができます。例えばコードを書いてベクタードローアブルを任意Viewの背景に割り当てるのこんな感じ(Android4.xに対応)。

でもいちいちコード書かなきゃいけないなんてなんかスマートじゃないよね? レイアウトxmlで色々設定したいですよね?

サポートライブラリまたはandroidxを使っていれば、ImageView系(実際にはAppCompatImageViewとその子クラス)では、今までは android:src で指定していたところを app:srcCompat にすることでAndroid4.xでも勝手にベクタードローアブルを読み込めるようになります。またTextView系のCompoundDrawbalesもStateListDrawable等でベクタードローアブルをラップしてあげることで正常に動作します。

しかしですよ、AppCompat系も含めたViewにレイアウトxmlで背景にVectorDrawableを割り当てて、Android4.xで実行しようとするといきなり頓挫します。

さきほどはコードで設定しましたが、代わりにViewの背景をレイアウトxmlファイルで設定する場合、通常であれば御存知の通り、 android:background 属性にドローアブルリソースを割り当てます。
Android5(API21)以上であれば割り当てたドローアブルがベクタードローアブルであっても問題なく実行できます。でもAPI21未満の場合Viewのinflate中にそんなリソースはないんじゃぁおらぁ〜と言われてクラッシュします、100%ですチクセゥ〜
TextView系のCompoundDrawbalesと同じ様にStateListDrawable等でベクタードローアブルをラップしてみても AppCompatDelegate#setCompatVectorFromResourcesEnabled(true) にしてもだめです。

コードを書けばAndroid4.xでもベクタードローアブルを読み込めるんだから、例えばAppCompatActivityの Context#getResources を上書きして Context#getResources#getDrawable でドローアブルを読み込むときにvectorタグならVectorDrawableCompatに差し替えてくれりゃいいのにと思ってみたり。

あるいは、ImageView系の app:srcCompat と同じように app:backgroundCompat なんてものがあって勝手にベクタードローアブルを読み込んでくれればいいのにと思うのですが、そんな都合のいいものはありません。

本当は各View側を修正するのではなく、ContextとかResourcesをらっぷしてゴニョゴニョするだけですめばいいのですが、ちと面倒そうなのでとりあえず自前のカスタムViewだけでも割り当てることができるようにします。まぁぶっちゃけ、先に書いた app:backgroundCompat を実現しようってことです。

ここで大事なことを1つ。androidネームスペースの属性( android:background とか)に対してVectorDrawableを割り当てるとAndroid5(API21)未満では(大本のViewクラスのコンストラクタ内で)必ずクラッシュします。なのでレイアウトxml内でベクタードローアブルを割り当ててAndroid4.xで実行する場合は必ずカスタム属性の定義が必要です。

ということでカスタム属性を定義します。まぁこんな感じですかね。

ここではとりあえず、 drawableCompat , backgroundCompat , backgroundTintCompat の3つのカスタム属性を定義しています(意味や目的意図は読んで字のごとくなので察してくだされ)。
レイアウトxml内で設定する際にはそれぞれ app:drawableCompat , app:backgroundCompat , app:backgroundTintCompat としてアクセスします。

カスタム属性は該当Viewのコンストラクタで TypedArray としてアクセスします。

ここで、Android5(API21)以上またはベクタードローアブルを使うことを考えなければ、カスタム属性からのドローアブルの取得は例えば次のようになります。

しかぁ〜し、Android4.xで app:drawableCompat 属性にVectorDrawableを割り当てていると先程のコードは android.content.res.Resources$NotFoundException 例外でクラッシュします。ですので少し面倒ですが、例えば次のようにしないといけません。

ちなみに、 ContextCompat#getDrawable(Context, int) はAPI16以上では Context#getResources()#getDrawable(int) と等価です。

ということでレイアウトxmlで設定したVectorDrawableをAndroid4.xでも読み込めるようになりました(VectorDrawableCompatとして読み込まれます)\(^o^)/

ひゃっほぉ〜と言いたいところなのですが、実はまだちょっと足りません。何が足りないかというとtintです。VectorDrawableの一般的な使い方ではfillColorを#FF000000(黒)に設定しておいて、使うときにtintで色を指定するようにします。また従来のpngからのBitmapDrawableやShapeDrawableでもtintで色を変更できると便利です。

Android5未満では Drawable#setColorFilter , Android5以上では Drawable#setTint を使えばいいのですが、わざわざ自分でオレオレ実装しなくともサポートライブラリ/androidxには DrawableCompat#setTint という便利クラス/メソッドがあるのでそれを使いたいと思います。

DrawableCompatでのtint処理は簡単で、次のようにすると好きな色を付けることができます(PorterDuff.Modeは用途に応じて適時変更してくだされ)。

しかし、実はここにも落とし穴があるのです😨 DrawableComat#setTint の実装を見てみると一目瞭然です。

API21以上だと Drawable#setTint を呼び出すだけですので問題ないですよね、しかしAPI21未満の場合はDrawableがTintAwareDrawableインターフェースを実装していない場合には何も処理が行われないのです。VectorDrawableCompatであればTintAwareDrawableインターフェースを実装しているので問題ないですが、他のドローアブルではTintAwareDrawableインターフェースを実装していないものもたくさんありますので、先程のドロー炙る読み込み処理だけでは思ったとおりに色がつかにゃぁーということになってしまいます😹

そんなあなたに強い味方、DrawableCompatです。 DrawableCompat#wrap を使うとTintAwareDrawableインターフェースを実装していないドローアブルでもラップして良きにはからってくれるのです✨

ということで、先程のドローアブルの読み込み処理は次のようにしましょう。

これでどんなドローアブルを設定してもtintを適用できるようになります、やったね👍

同じ様にAndroid4.xで背景にもtint付きでベクタードローアブル(他のドローアブルも可)を適用できるように読み込みます。

Android5(API21)以上では android:background 属性と android:backgroundTint 使えば済むことですが、Android4.x対応 & VectorDrawable対応をするにはこんなことをすることになります。

これで本来はおしまいなのですが、今のVectorDrawable/VectorDrawableCompatはですねぇ、 Drawable#setTint でも DrawableComat#setTint でも正常にtintが当たらないのんですよ(機種依存する)
原因は昔から頻発するあれです、アレ。

なのでtint適用時にVectorDrawable/VectorDrawableCompatのときの対策を追加しておきます。

ということで、Android4.xでレイアウトxml内でカスタムViewにベクタードローアブルを割り当てるには、

  • カスタム属性を使ってDrawableの割り当て設定をする
  • TypedArray#getDrawableは使っちゃだめ
  • Android5(API21)未満ではAppCompatDelegate.setCompatVectorFromResourcesEnabled(true)を呼んでおく
  • TypedArray#getResourceIdを使って割り当てたDrawableのリソースIDを取得してResources#getDrawable(id)でDrawableを読み込む
  • tint処理が必要であればDrawableCompat.wrapでラップしておく
  • VectorDrawableとVectorDrawableCompatはtintが正常に適用できない端末があるのでハードウエアアクセレレーションを無効にする

でした✌

ちゃんちゃん
(^^)/~~~

«

  • スポンサードリンク

コメントを残す

%d人のブロガーが「いいね」をつけました。