AndroidX Preference eXtended

This library is meant to fix some of the problems found in the official AndroidX preference library. Also, there are new preference types available, such as RingtonePreference, DatePickerPreference, and TimePickerPreference.

Donation

If you would like to support me, you may donate some small amount via PayPal.

How to use the library?

1. Add gradle dependency

Add this to your gradle file:

implementation "androidx.preference:preference:$androidxVersion"
implementation 'com.takisoft.preferencex:preferencex:1.1.0'

2. Use the appropriate class as your fragment's base

import com.takisoft.preferencex.PreferenceFragmentCompat;

public class MyPreferenceFragment extends PreferenceFragmentCompat {

    @Override
    public void onCreatePreferencesFix(@Nullable Bundle savedInstanceState, String rootKey) {
        setPreferencesFromResource(R.xml.settings, rootKey);
	
	// additional setup
    }
}

Warning! Watch out for the correct package name when importing PreferenceFragmentCompat, it should come from com.takisoft.preferencex.

Now you can enjoy using preferenceX.

Extra types

There are additional preferences not part of the official support library, but decided to add them to some extra libraries. You can add them to your project using Gradle.

Preference	Dependency	Preview
RingtonePreference	implementation 'com.takisoft.preferencex:preferencex-ringtone:1.1.0'
DatePickerPreference	implementation 'com.takisoft.preferencex:preferencex-datetimepicker:1.1.0'
TimePickerPreference	implementation 'com.takisoft.preferencex:preferencex-datetimepicker:1.1.0'
ColorPickerPreference	implementation 'com.takisoft.preferencex:preferencex-colorpicker:1.1.0'
SimpleMenuPreference	implementation 'com.takisoft.preferencex:preferencex-simplemenu:1.1.0' (can be used independent of preferencex)

Custom solutions

Hijacked EditTextPreference

The support implementation of EditTextPreference ignores many of the basic yet very important attributes as it doesn't forward them to the underlying EditText widget. In my opinion this is a result of some twisted thinking which would require someone to create custom dialog layouts for some simple tasks, like showing a numbers-only dialog. This is the main reason why the EditTextPreference gets hijacked by this lib: it replaces certain aspects of the original class in order to forward all the XML attributes set (such as inputType) on the EditTextPreference to the EditText, and also provides a getEditText() method so it can be manipulated directly.

The sample app shows an example of setting (via XML) and querying (programmatically) the input type of the EditTextPreference:

<EditTextPreference
    android:inputType="phone"
    android:key="edit_text_test" />

EditTextPreference etPref = (EditTextPreference) findPreference("edit_text_test");
if (etPref != null) {
    int inputType = etPref.getEditText().getInputType();
    // do something with inputType
}

Note! Watch out for the correct package name when importing EditTextPreference, it should come from com.takisoft.preferencex. If you import from the wrong package (i.e. androidx.preference), the getEditText() method will not be available, however, the XML attributes will still be forwarded and processed by the EditText.

Others

• Convenience methods in PreferenceFragmentCompat;
• PreferenceCategory with different colors;
• AutoSummaryEditTextPreference;
• PreferenceActivityResultListener;
• EditTextPreference correctly calls notifyChange. (#66)

Version

The current stable version is 1.1.0.

Notes

This demo / bugfix is set to work on API level 14+.

Sample

Material design - everywhere.

API 15	API 21	API 26

Changelog

See the separate CHANGELOG.md file.

2019-11-26

New version: 1.1.0 (based on v1.1.0)

• introduced PreferenceFragmentCompatMasterSwitch that can be used as a switch's additional screen for settings; see the sample for details
• Added pref_disableMessagePaddingFix attribute to the EditTextPreference that can be used to disable the dialog message padding fix.
• EditText does not receive all attributes from EditTextPreference from now, only the following: inputType, textAllCaps, lines, minLines, maxLines, ems, minEms, maxEms
• AutoSummaryEditTextPreference is now deprecated, use an appropriate SummaryProvider with the EditTextPreference

For older changelogs, check out the CHANGELOG file.

Feel free to ask / suggest anything on this page by creating a ticket (issues)!

License notes

Apache v2