README.md

PrefPin 📍

Reduce boilerplate codes in PreferenceFragment by using field and method binding.

• Remove findPreference by using @BindPref.
• Remove setOnPreferenceClickListener by using @OnPrefClick.
• Remove setOnPreferenceChangeListener by using @OnPrefChange.

Installation

dependencies {
    // ... others
    implementation 'com.emo-pass:prefpin:1.1.1'
    annotationProcessor 'com.emo-pass:prefpin-processor:1.1.1'
}

Usage

Preference keys should be stored in strings.xml.

  <string name="pref_about_key" translatable="false">pref_about_key</string>

PreferenceFragment subclass will look like.

public class SettingFragment extends PreferenceFragment{
  @BindPref(R.string.pref_about_key) Preference aboutPreference;
  @BindPref(R.string.pref_name_key) EditTextPreference namePreference;

  @Override protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    addPreferencesFromResource(R.xml.settings);
    PrefPin.bind(this);
    //...
  }
  
  @OnPrefClick(R.string.pref_about_key)
  void onClick(Preference preference) {
    //...
  }
  
  @OnPrefChange({R.string.pref_name_key, R.string.pref_score_key})
  void onPrefChange(Preference preference, Object newObject) {
    //...
  } 
}

ProGuard

You need to add the following line if ProGuard is used in your app.

# Retain generated classes to look for by using reflection.
-keep public class **.*_PrefBinding { *; }

License

This project is under MIT license. Copyright (c) 2017 Quang Nguyen.