https://github.com/ohmae/preference-activity-compat
This is a compatibility class of PreferenceActivity
https://github.com/ohmae/preference-activity-compat
android android-library settings
Last synced: 6 months ago
JSON representation
This is a compatibility class of PreferenceActivity
- Host: GitHub
- URL: https://github.com/ohmae/preference-activity-compat
- Owner: ohmae
- License: mit
- Created: 2018-05-13T10:07:59.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-08-05T00:39:23.000Z (almost 3 years ago)
- Last Synced: 2024-04-20T17:16:16.811Z (over 2 years ago)
- Topics: android, android-library, settings
- Language: Kotlin
- Homepage:
- Size: 2.23 MB
- Stars: 13
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
*This Library is EOL. Please use [PreferenceHeaderFragmentCompat](https://developer.android.com/reference/androidx/preference/PreferenceHeaderFragmentCompat) instead.*
===
---
# PreferenceActivityCompat
[](./LICENSE)
[](https://github.com/ohmae/preference-activity-compat/releases)
[](https://github.com/ohmae/preference-activity-compat/issues)
[](https://github.com/ohmae/preference-activity-compat/issues?q=is%3Aissue+is%3Aclosed)
This is a compatibility library of `PreferenceActivity`.
This class can be used in much the same way as `PreferenceActivity`.
Moreover, the material design is applied, It is also possible to manage `PreferenceFragmentCompat` instead of `PreferenceFragment`.
## Background
As you know,
[`PreferenceFragmentCompat`](https://developer.android.com/reference/android/support/v7/preference/PreferenceFragmentCompat)
which is a compatibility class corresponding to [`PreferenceFragment`](https://developer.android.com/reference/android/preference/PreferenceFragment)
is provided in SupportLibrary.
([`com.android.support:preference-v7`](https://developer.android.com/topic/libraries/support-library/packages#v7-preference))
But compatibility class corresponding to [`PreferenceActivity`](https://developer.android.com/reference/android/preference/PreferenceActivity) is not provided.
When adding a new activity in AndroidStudio, `AppCompatPreferenceActivity` is created by selecting "Settings Activity" from the gallery.
Guessing from the name of "`AppCompatPreferenceActivity`", we will get an impression like the `PreferenceActivity` version of `AppCompatActivity`.
In the fact, it allows us to use some new APIs, but doesn't allows we to use material design theme in Android 4.x.
Also, since `AppCompatPreferenceActivity` can inflate only native Fragment, it can not inflate `PreferenceFragmentCompat` inheriting Fragment of support library.
There is also a Support Library version of [`PreferenceFragment`](https://developer.android.com/reference/android/support/v14/preference/PreferenceFragment)
that inherits the native Fragment.
But **the native Fragment is deprecated**.
## Screenshots
### Android 4.4 (Tablet)
|PreferenceActivityCompat:smile:|Native PreferenceActivity:scream:|
|-|-|
|||
|||
### Android 7.1 (Tablet)
|PreferenceActivityCompat:smile:|Native PreferenceActivity:smile:|
|-|-|
|||
|||
### Android 4.4 (Phone)
#### PreferenceActivityCompat:smile:
||||
|-|-|-|
#### Native PreferenceActivity:scream:
||||
|-|-|-|
### Android 7.1 (Phone)
#### PreferenceActivityCompat:smile:
||||
|-|-|-|
#### Native PreferenceActivity:smile:
||||
|-|-|-|
## How to use
jCenter will close in May. In 0.2.6 moved to mavenCentral from jcenter.
Please note that the **groupID has changed**
Download from mavenCentral.
The latest version is: 
```gradle
dependencies {
implementation 'net.mm2d.preference:preference:0.2.6'
}
```
Versions below 0.2.6 were distributed with jCenter.
However, jCenter will close and old versions are not migrated to mavenCentral.
If you need an older version, please use the Github Pages repository.
```gradle
repositories {
maven { url = URI("https://ohmae.github.com/maven") }
}
```
```gradle
dependencies {
implementation 'net.mm2d.preference:preference:0.2.5'
}
```
0.1.0~ this library depends on androidx.
If you need to use support library 28.0.0, use 0.0.4.
If you are using ProGuard, to load preference-header from xml, you might need to add the following option.
```
-keep public class * extends androidx.preference.PreferenceFragmentCompat
```
## Restriction
This class is only partially compatible with
[`PreferenceActivity`](https://developer.android.com/reference/android/preference/PreferenceActivity).
Only functions that are likely to be used are implemented.
e.g.
- The method to handle Preference is deprecated in Activity and is not implemented.
- [`FragmentBreadCrumbs`](https://developer.android.com/reference/android/app/FragmentBreadCrumbs) is not used.
This class can handle only `preference-headers`.
This class was created with the premise of using
[`PreferenceFragmentCompat`](https://developer.android.com/reference/androidx/preference/PreferenceFragmentCompat).
Therefore, it is not a restriction of this class itself, but it has the same restrictions as `PreferenceFragmentCompat`.
- We can't use `RingtonePreference`.
This is because `RingtonePreference` doesn't exist in the
[`androidx.preference`](https://developer.android.com/reference/androidx/preference/package-summary) package.
- `SwitchPreference` does not apply material design.
Because
[`androidx.preference.SwitchPreference`](https://developer.android.com/reference/androidx/preference/SwitchPreference)
is inflated.
If you want to apply material design, use
[`SwitchPreferenceCompat`](https://developer.android.com/reference/androidx/preference/SwitchPreferenceCompat)
instead.
[`androidx.preference`](https://developer.android.com/reference/androidx/preference/package-summary) has various problems, so I recommend to use this library together with other OSS for further improvement.
Please see the next section.
## Migrate from AppCompatPreferenceActivity
### 1. Add `preferenceTheme` in `PreferenceActivity`'s theme.
```xml
<item name="colorPrimary">@color/colorPrimary</item>
<item name="colorPrimaryDark">@color/colorPrimaryDark</item>
<item name="colorAccent">@color/colorAccent</item>
+ <item name="preferenceTheme">@style/PreferenceCompatTheme</item>
```
### 2. Replace `SettingsActivity`'s super class
```java
- public class SettingsActivity extends AppCompatPreferenceActivity {
+ public class SettingsActivity extends PreferenceActivityCompat {
```
At that time, change the `isValidFragment` from `protected` to `public`.
```java
@Override
- protected boolean isValidFragment(final String fragmentName) {
+ public boolean isValidFragment(final String fragmentName) {
```
If you override `onMenuItemSelected`, replace it with `onOptionsItemSelected`.
```java
@Override
- public boolean onMenuItemSelected(int featureId, MenuItem item) {
+ public boolean onOptionsItemSelected(final MenuItem item) {
final int id = item.getItemId();
if (id == android.R.id.home) {
- if (!super.onMenuItemSelected(featureId, item)) {
+ if (!super.onOptionsItemSelected(item)) {
NavUtils.navigateUpFromSameTask(this);
}
return true;
}
- return super.onMenuItemSelected(featureId, item);
+ return super.onOptionsItemSelected(item);
}
```
If you use Kotlin.
`onBuildHeaders` argument type must be `MutableList`.
Because `PreferenceActivityCompat` is implemented by Kotlin.
```kotlin
- override fun onBuildHeaders(target: List)
+ override fun onBuildHeaders(target: MutableList)
```
### 3. Replace `PreferenceFragment` to `PreferenceFragmentCompat`
And implement `onCreatePreferences` instead of `onCreate`
```java
- public static class GeneralPreferenceFragment extends PreferenceFragment {
+ public static class GeneralPreferenceFragment extends PreferenceFragmentCompat {
@Override
- public void onCreate(final Bundle savedInstanceState) {
- super.onCreate(savedInstanceState);
+ public void onCreatePreferences(final Bundle savedInstanceState,final String rootKey) {
addPreferencesFromResource(R.xml.native_pref_general);
}
```
### 4. Change package import
Use `net.mm2d.preference.Header` instead of `android.preference.PreferenceActivity.Header`
```java
- import android.preference.PreferenceActivity.Header;
+ import net.mm2d.preference.Header;
```
Use `androidx.preference` instead of `android.preference`
```java
- import android.preference.ListPreference;
- import android.preference.Preference;
- import android.preference.Preference.OnPreferenceChangeListener;
- import android.preference.PreferenceFragment;
- import android.preference.PreferenceManager;
+ import androidx.preference.ListPreference;
+ import androidx.preference.Preference;
+ import androidx.preference.Preference.OnPreferenceChangeListener;
+ import androidx.preference.PreferenceFragmentCompat;
+ import androidx.preference.PreferenceManager;
```
### 5. Change namespace of attributes to `app` instead of `android` in xml of `preference-headers`
```xml
+ xmlns:app="http://schemas.android.com/apk/res-auto">
```
### 6. Replace `SwtichPreference` to `SwitchPreferenceCompat`, if you need
(This is a description of PreferenceFragmentCompat, not this library)
```xml
-
+
```
Because SwitchPreference looks legacy in Android 4.4 or less.
|SwitchPreference|SwitchPreferenceCompat|
|:-:|:-:|
|||
If your target is Android 5 or later, you do not have to replace it.
### 7. Add `app:iconSpaceReserved="false"`, If you do not need the space for the icon
(This is a description of PreferenceFragmentCompat, not this library)
```xml
```
|default|`app:iconSpaceReserved="false"`|
|:-:|:-:|
|||
## Dependent OSS
### PreferenceActivityCompat
- [Kotlin](https://kotlinlang.org/)
- [Android Jetpack](https://developer.android.com/jetpack/)
- androidx.appcompat:appcompat
- androidx.preference:preference
- androidx.core:core-ktx
### Sample app
- [Kotlin](https://kotlinlang.org/)
- [Android Jetpack](https://developer.android.com/jetpack/)
- androidx.appcompat:appcompat
- androidx.preference:preference
## Author
大前 良介 (OHMAE Ryosuke)
http://www.mm2d.net/
## License
[MIT License](./LICENSE)