[Android] カスタムビューのプロパティを xml から操作する

田中圭介

2016.02.12

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

XML で属性追加

カスタムビューを作成した時に、値を layout の xml からセットする方法をご紹介します。

カスタムビュークラスの作成

まずはカスタムクラスを作成します。今回は View クラスのサブクラスとして作成しました。

/**
* ライトセーバーを表すビュークラス
*/
public class LightSaberView extends View {

public LightSaberView(Context context, AttributeSet attrs) {
super(context, attrs);
}
}

コンストラクタを 1 つ記述します。こちらは Layout から生成されるときに呼ばれるものらしく、記述しなければエラーになります。

属性の定義

次に res/values/attrs.xml を作成し、以下のようにカスタムしたい属性を定義します。

<br /><br /><br /><br /><br /><br /><br /><br /><br />

declare-styleable の name 部分が作成したカスタムクラス名となっており、attr の name は属性名、format が型となっています。

ここでは isMaceWindu という boolean と、force という enum の属性を追加しました。

layout xml での値セット

以上の設定を行うと layout の xml から、作成した属性に対して値をセットすることができるようになります。

<br />

値の受け取り

次にカスタムビューの方で xml からセットした値を受け取ります。

private boolean isMaceWindu;

private int mForce;

public LightSaberView(Context context, AttributeSet attrs) {
super(context, attrs);

TypedArray a = context.getTheme().obtainStyledAttributes(
attrs,
R.styleable.LightSaberView,
0, 0);

try {
isMaceWindu = a.getBoolean(R.styleable.LightSaberView_isMaceWindu, false);
mForce = a.getInteger(R.styleable.LightSaberView_force, 0);
} finally {
a.recycle();
}

setBackgroundColor();
}

obtainStyledAttributes() というメソッドで TypedArray クラスのインスタンスを取得し、そのインスタンスから目的の値を取り出しています。 TypedArray のインスタンスに対する処理が全て終わったら recycle() メソッドを忘れずに実行しましょう。

ここでは取得した値によってビューの背景色を変えるという処理を行いました。

private void setBackgroundColor() {
int color = Color.WHITE;

if (isMaceWindu) {
color = Color.MAGENTA;
} else if (mForce == 0) {
color = Color.BLUE;
} else if (mForce == 1) {
color = Color.RED;
}

this.setBackgroundColor(color);
}