Android Checkbox preference

Question

I cannot find any tutorials on checkbox preference. I can use a listpreference, but I can't use checkbox preference. For now, I want that if user sets on the checbox, a toast msg says "true" and if he sets it off, the toast msg says "false". So far I have this:

preferences.xml:

 <CheckBoxPreference
          android:title="Show Call UI"
          android:defaultValue="true"
          android:summary="Show Call Interface when clicking call button"
          android:key="checkboxPref" />

EditPreferences.java:

public class EditPreferences extends PreferenceActivity {

    String listPreference;
    boolean checkboxPreference;

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        addPreferencesFromResource(R.xml.preferences);
    }

    public void onStart(Intent intent, int startId) {
        getPrefs();
    }

    private void getPrefs() {
        SharedPreferences prefs = PreferenceManager
                .getDefaultSharedPreferences(getBaseContext());
        listPreference = prefs.getString("listPref", "nr1");
        checkboxPreference = prefs.getBoolean("checkboxPref", true);
    }
}

Edit: Solution thanks to David Caunt:

checkboxPreference.
    setOnPreferenceChangeListener(new Preference.OnPreferenceChangeListener() {

    public boolean onPreferenceChange(Preference preference, Object newValue) {
        if (newValue.toString().equals("true")) {
            Toast.makeText(getApplicationContext(), "CB: " + "true",
                                                    Toast.LENGTH_SHORT).show();
        } else {
            Toast.makeText(getApplicationContext(), "CB: " + "false",
                                                    Toast.LENGTH_SHORT).show();
        }
        return true;
    }
});

Please edit this to have variables begin with small letters - it is _very_ confusing to see things like `CheckboxPreference` as variable names ! — Mr_and_Mrs_D, Mar 24 '13 at 15:40

David Snabel-Caunt · Accepted Answer · 2011-06-27T17:34:54.703

49

You need to add a listener to the Preference in your onCreate method

    final CheckBoxPreference checkboxPref = (CheckBoxPreference) getPreferenceManager().findPreference("checkboxPref");

    checkboxPref.setOnPreferenceChangeListener(new Preference.OnPreferenceChangeListener() {            
        public boolean onPreferenceChange(Preference preference, Object newValue) {
            Log.d("MyApp", "Pref " + preference.getKey() + " changed to " + newValue.toString());       
            return true;
        }
    });

edited Jun 27 '11 at 17:34

answered Jun 27 '11 at 17:19

David Snabel-Caunt

57,804
13
114
132

Thanks! Small prob: "The method checkboxPref(new Preference.OnPreferenceChangeListener(){}) is undefined for the type EditPreference" – erdomester Jun 27 '11 at 17:27
2

Whoops! I accidentally deleted the method name - see revised answer above. – David Snabel-Caunt Jun 27 '11 at 17:35
Great, nice touch adding the full solution to your question! – David Snabel-Caunt Jun 27 '11 at 18:53

score 15 · Answer 2 · answered Sep 16 '11 at 13:48

You can cast the value of the checkbox into a boolean. This might be safer and more extensible than checking the toString() value.

final CheckBoxPreference checkboxPref = (CheckBoxPreference) getPreferenceManager().findPreference("checkboxPref");

checkboxPref.setOnPreferenceChangeListener(new Preference.OnPreferenceChangeListener() {            
    public boolean onPreferenceChange(Preference preference, Object newValue) {
        if(newValue instanceof Boolean){
            Boolean boolVal = (Boolean)newValue;
        }
        return true;
    }
});

score 1 · Answer 3 · answered Mar 20 '20 at 12:09

SharedPreferences sp = PreferenceManager.getDefaultSharedPreferences(this);
Log.i("LOG", String.valueOf(sp.getBoolean("key", false)));

Simplest way i found of getting value if item is pressed. If log is:

I/LOG: true

Checkbox is pressed

I/LOG: false

Checkbox is not selected

Hope this answers your question.

Android Checkbox preference

3 Answers3

Linked