ButterKnife 8使用説明

ButterKnife 8
メンバー変数とメソッドの依存注入フレームワーク
資料
Github
公式サイト
ButterKnife-Zelezny Github ButterKnifeプラグイン
インポート
プロジェクトでの使用

モジュールのbuildを配置する.gradle

dependencies {
    compile 'com.jakewharton:butterknife:8.4.0'
    annotationProcessor 'com.jakewharton:butterknife-compiler:8.4.0'
}

ライブラリでの使用

プロジェクトのbuildを構成する.gradle

buildscript {
    repositories {
      mavenCentral()
     }
    dependencies {
      classpath 'com.jakewharton:butterknife-gradle-plugin:8.4.0'
    }
}

モジュールのbuildを配置する.gradle

apply plugin: 'com.android.library'
apply plugin: 'com.jakewharton.butterknife'

注釈においてR2の代わりにRを用いる

.
基本的な使い方
初期化

Activityで

を初期化

@Override
public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.simple_activity);
    ButterKnife.bind(this);
    // ...
}

Fragmentでの初期化

@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
    View view = inflater.inflate(R.layout.fragment, container, false);
    ButterKnife.bind(this, view);
    // ...
    return view;
}

ViewHolderで

を初期化

static class ViewHolder {
    public ViewHolder(View view) {
        ButterKnife.bind(this, view);
    }
}

注意

ラベルレイアウトは、コンストラクタの再充填後に

を初期化することができる.

xmlにカスタムViewを埋め込むには、onFinishInflate()で

を初期化する必要があります.

Viewバインド@BindView 、 @BindViews
private、staticをバインドできません

@BindView(R.id.name)
EditText nameView; //    findViewById

@BindViews({ R.id.first_name, R.id.middle_name, R.id.last_name })
List nameViews;

リソースバインド@BindString 、 @BindBool 、 @BindInt 、 @BindFloat 、 @BindArray 、 @BindDimen 、 @BindColor 、 @BindBitmap 、 @BindDrawable

@BindString(R.string.username_error)
String usernameErrorText;

@BindBool(R.bool.is_tablet)
boolean isTablet;

@BindInt(R.int.columns)
int columns;

//     float     dimen   
@BindFloat(R.dimen.image_ratio)
float imageRatio;

//    String、int、Text     android.content.res.TypedArray
@BindArray(R.array.countries)
String[] countries;

@BindArray(R.array.phones)
int[] phones;

@BindArray(R.array.options)
CharSequence[] options;

@BindArray(R.array.icons)
TypedArray icons;

//     int (    ), float (     )
@BindDimen(R.dimen.horizontal_gap)
int gapPx;

@BindDimen(R.dimen.horizontal_gap)
float gap;

//     int, ColorStateList
@BindColor(R.color.background_green)
int green;

@BindColor(R.color.background_green_selector)
ColorStateList greenSelector;

@BindBitmap(R.drawable.logo)
Bitmap logo;

@BindDrawable(R.drawable.placeholder)
Drawable placeholder;

@BindDrawable(value = R.drawable.placeholder, tint = R.attr.colorAccent)
Drawable tintedPlaceholder;

傍受バインディング@OnClick 、 @OnLongClick 、 @OnTouch 、 @OnCheckedChanged 、 @OnEditorAction 、 @OnFocusChange 、 @OnTextChanged 、 @OnItemClick 、 @OnItemLongClickListener 、 @OnItemSelected 、 @OnPageChange

パラメータの数は固定されず、パラメータのサブクラス

とすることができる.

マルチドロップメソッドの傍受、valueとcallback

を使用

// View.OnClickListener
@OnClick(R.id.submit)
public void submit(View view) {
}

@OnClick(R.id.submit)
public void submit() {  //   
}

@OnClick(R.id.submit)
public void sayHi(Button button) {  //     ，    ，    View   
  button.setText("Hello!");
}

@OnClick({ R.id.door1, R.id.door2, R.id.door3 })  //   IDs   
public void pickDoor(DoorView door) {
    if (door.hasPrizeBehind()) {
      Toast.makeText(this, "You win!", LENGTH_SHORT).show();
    } else {
      Toast.makeText(this, "Try again", LENGTH_SHORT).show();
    }
}

//     View，       ，    ID
public class FancyButton extends Button {
    @OnClick
    public void onClick() {
    }
}

// TextWatcher
@OnTextChanged(R.id.example)
void onTextChanged(CharSequence s, int start, int before, int count) {
}

@OnTextChanged(value = R.id.example, callback = BEFORE_TEXT_CHANGED)
void onBeforeTextChanged(CharSequence s, int start, int count, int after) {
}

@OnTextChanged(value = R.id.example, callback = AFTER_TEXT_CHANGED)
void onAfterTextChanged(Editable s) {
}

// View.OnLongClickListener
@OnLongClick(R.id.example)
boolean onLongClick(View v) {
    return true;
}

// View.OnTouchListener
@OnTouch(R.id.example)
boolean onTouch(View v, MotionEvent event) {
    return false;
}

// CompoundButton.OnCheckedChangeListener
@OnCheckedChanged(R.id.example)
void onChecked(CompoundButton buttonView, boolean isChecked) {
}

// TextView.OnEditorActionListener
@OnEditorAction(R.id.example)
boolean onEditorAction(TextView v, int actionId, KeyEvent event) {
    return true;
}

// View.OnFocusChangeListener
@OnFocusChange(R.id.example)
void onFocusChanged(View v, boolean hasFocus) {
}

// AdapterView.OnItemClickListener
@OnItemClick(R.id.example_list)
void onItemClick(AdapterView> parent, View view, int position, long id) {
}

// AdapterView.OnItemLongClickListener
@OnItemLongClick(R.id.example_list)
boolean onItemLongClick(AdapterView> parent, View view, int position, long id) {
    return true;
}

// AdapterView.OnItemSelectedListener
@OnItemSelected(R.id.example_list)
void onItemSelected(AdapterView> parent, View view, int position, long id) {
}

@OnItemSelected(value = R.id.example_list, callback = NOTHING_SELECTED)
void onNothingSelected() {
}

// ViewPager.OnPageChangeListener
@OnPageChange(R.id.example_pager)
void onPageSelected(int position) {
}

@OnPageChange(value = R.id.example_pager, callback = PAGE_SCROLL_STATE_CHANGED)
void onPageStateChanged(int state) {
}

@OnPageChange(value = R.id.example_pager, callback = PAGE_SCROLLED)
void onPageStateChanged(int position, float positionOffset, int positionOffsetPixels) {
}

バインディングの選択
デフォルトでは、ターゲットビューが見つからない場合は、例外が放出されます.@Nullable、@Optional、存在即ちバインド、存在しない即ち無視、異常を投げない

@Nullable @BindView(R.id.might_not_be_there)
TextView mightNotBeThere;

@Optional @OnClick(R.id.maybe_missing)
void onMaybeMissingClicked() {}

バインドリセット

public class FancyFragment extends Fragment {
    private Unbinder unbinder;

    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
        View view = inflater.inflate(R.layout.fancy_fragment, container, false);
        unbinder = ButterKnife.bind(this, view);
        // ...
        return view;
    }

    @Override public void onDestroyView() {
        super.onDestroyView();
        unbinder.unbind();
    }
}

追加ButterKnife.findById()自動強転、最初のパラメータはView、Activity、Dialog

ImageView photo = ButterKnife.findById(view, R.id.photo);

ステップアップ法
ButterKnife.apply()

//   View
@BindViews({ R.id.first_name, R.id.middle_name, R.id.last_name })
List nameViews;

//    Action   Setter   ，    
static final ButterKnife.Action DISABLE = new ButterKnife.Action() {
    @Override
    public void apply(View view, int index) {
        view.setEnabled(false);
    }
};
static final ButterKnife.Setter ENABLED = new ButterKnife.Setter() {
    @Override
    public void set(View view, Boolean value, int index) {
        view.setEnabled(value);
    }
};

//   
ButterKnife.apply(nameViews, DISABLE);
ButterKnife.apply(nameViews, ENABLED, false);
ButterKnife.apply(nameViews, View.ALPHA, 0.0f);