Tutoriel Android : Apprendre à utiliser les préférences via SharedPreferences et PreferenceActivity

Chapitre 4.2

Android2ee

Mathias Séguy

Ce tutoriel s'intéresse à l'utilisation des préférences au niveau de votre activité, votre application et du système sous Android.

- Chapitre 0 : Installation et préparation de l'environnement de développement

- Chapitre 1 : Premiers pas avec Android

- Chapitre 1.1 : Cycle de vie de l'activité

- Chapitre 2.1 : Les éléments graphiques fondamentaux

- Chapitre 2.2 : Composants graphiques complexes

- Chapitre 3.3 : Intent et IntentFilters

- Chapitre 4.1 : Les Ressources

- Chapitre 4.2 : SharedPreferences et PreferenceActivity

- Chapitre 4.3 : Base de données SQLite

- Chapitre 4.4 : Gestion des fichiers

- Chapitre 5 : Content Provider

Pour réagir à ce tutoriel, un espace de dialogue vous est proposé sur le forum : Commentez

- Titre : Tutoriel Android : Apprendre à utiliser les préférences via SharedPreferences et PreferenceActivity

- Auteur : Mathias Séguy

- Parution : 23 février 2015

- Licence : Les sources présentées sur cette page sont libres de droits et vous pouvez les utiliser à votre convenance. Par contre, la page de présentation constitue une œuvre intellectuelle protégée par les droits d'auteur. Copyright ® 2016 Mathias Séguy. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc. sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.

Sommaire

- I. Gestion des préférences

- II. Mise en place de préférences spécifiques à votre application

- I-A. Modification programmatique

- I-B. Utilisation du fichier XML des préférences

- I-C. Définition d'un fichier XML de préférences

- III. Remerciements

I - Gestion des préférences

Il y a trois niveaux de préférences, votre activité, votre application et les préférences système. Chacune d'elles s'obtient par un appel spécifique.

Pour les préférences de l'application :

1. Context context = getApplicationContext();

2. SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(context);

3. Pour des préférences stockées dans un fichier de votre application :

4. String MY_PREF="mesPrefs";

5. SharedPreferences prefs = PreferenceManager.getSharedPreferences(MY_PREFS,Activity.MODE_PRIVATE);

7. Boolean valueBool=prefs.getBoolean(key, defaultValueBool);

8. Float valueFlo=prefs.getFloat(key, defaultValueFloat);

9. Integer valueInt=prefs.getInt(key, defaultValueInt);

10. Long valueLong=prefs.getLong(key, defaultValueLong);

11. String valueStr=prefs.getString(key, defaultValueStr);

où key est la clef de la propriété et defaultValue** est la valeur par défaut. Si la clef n'est pas trouvée, la valeur par défaut est renvoyée.

L'accès aux autres préférences n'est pas clair, il faudrait utiliser getPreference(Activity.MODE_PRIVATE) pour les préférences de l'activité et getDefaultSharedPreference pour les préférences du système.

II - Mise en place de préférences spécifiques à votre application

Ces préférences se définissent au travers d'un fichier XML stocké sous res\xml\. Ce fichier XML est appelé par la méthode addPreferenceFromRessource(R.xml.mespreferences) qui charge dans l'objet shareReference de l'application les valeurs contenues dans ce fichier. Android dispose d'un éditeur générique pour afficher ce fichier et permettre à l'utilisateur de le modifier. Ces préférences peuvent aussi être modifiées de manière programmatique.

I-A - Modification programmatique

Une fois que vous avez récupéré votre objet SharedPreference, il vous suffit d'utiliser son Editor pour le modifier.

1. SharedPreferences.Editor editor=prefs.edit();

2. editor.putBoolean(key, value);

3. editor.putFloat(key, value);

4. editor.putInt(key, value);

5. editor.putLong(key, value);

6. editor.putString(key, value);

7. editor.commit();

où key est la clef (String) et value est la valeur.

Si vous ne finissez pas par commit, dès que votre activité n'est plus active, vos préférences seront oubliées par l'objet sharedPreference.

I-B - Utilisation du fichier XML des préférences

Il n'y a pas grand-chose à dire, l'activité ci-dessous affiche un éditeur pour que l'utilisateur puisse modifier ces préférences :

1. public class Preferences extends PreferenceActivity {

3. @Override

4. public void onCreate(Bundle icicle) {

5. super.onCreate(icicle);

6. addPreferencesFromResource(R.xml.userpreferences);

7. }

8. }

I-C - Définition d'un fichier XML de préférences

Vous pouvez définir dans le fichier XML vos préférences de manière à ce qu' Android les interprète et puisse les modifier de manière programmatique ou bien construire une IHM permettant à l'utilisateur de les modifier.

Ce fichier possède une structure plus ou moins complexe.

- Soit vous listez simplement vos préférences (dans ce cas, il n'y a pas de bloc PreferenceCategory et toutes vos préférences se trouvent dans le bloc PreferenceScreen).

- Soit vous les listez en mettant une structure de category, elles seront regroupées en fonction des catégories que vous avez définies.

- Soit vous faites appel à un autre écran de préférence, dans ce cas vous rajoutez un bloc PreferenceScreen qui ouvrira un autre écran de préférence quand l'utilisateur appuiera sur la préférence à modifier.

Les préférences qui ne sont pas des CheckBox ou des RingTone ouvriront des fenêtres de dialogue.

L'exemple ci-dessous est complet, vous pouvez l'associer à l'activité précédente pour que les préférences soient visibles par l'utilisateur :

1. <?xml version="1.0" encoding="utf-8"?>

2. <PreferenceScreen

3. xmlns:android="http://schemas.android.com/apk/res/android">

4. <!-- Une Catégorie -->

5. <!-- Une boîte de dialogue -->

6. <PreferenceCategory android:title="Simple Preference">

7. <CheckBoxPreference

8. android:key="@string/checkbox"

9. android:title="A checkBox preference :"

10. android:summary="Check or uncheck"

11. />

12. <RingtonePreference

13. android:key="@string/ringtone"

14. android:title="Ring tone preference"

15. android:showDefault="true"

16. android:showSilent="true"

17. android:summary="Choose a ringTone"

18. />

19. <!-- Une Catégorie -->

20. </PreferenceCategory>

21. <!-- Une Catégorie -->

22. <PreferenceCategory android:title="more details (another category)">

23. <!-- Un autre écran de préférence-->

24. <PreferenceScreen

25. android:key="detail"

26. android:title="Details"

27. android:summary="More details on another screen">

28. <CheckBoxPreference

29. android:key="@string/checkbox2"

30. android:title="Another checkBox"

31. android:summary="On or Off"

32. />

33. </PreferenceScreen>

34. </PreferenceCategory>

35. <!-- Une Catégorie -->

36. <PreferenceCategory android:title="Others simples preferences(another category)">

37. <EditTextPreference

38. android:key="@string/text"

39. android:title="Text editor dialog"

40. android:summary="Click to open an editor field"

41. android:dialogTitle="Any text is ok"

42. />

43. <ListPreference

44. android:key="@string/list"

45. android:title="Choice dialog"

46. android:summary="Click to open a list of choices"

47. android:entries="@array/i_like_array"

48. android:dialogTitle="Choose what you like" />

49. </PreferenceCategory>

50. </PreferenceScreen>

Vous pouvez utiliser ce fichier de préférences avec l'activité suivante :

1. public class PreferenceSimpleTuto extends PreferenceActivity {

2. /** Called when the activity is first created. */

3. @Override

4. public void onCreate(Bundle savedInstanceState) {

5. super.onCreate(savedInstanceState);

6. addPreferencesFromResource(R.xml.preferences);

7. }

8. }

avec le fichier string.xml suivant :

1. <?xml version="1.0" encoding="utf-8"?>

2. <resources>

3. <string name="hello">Hello World, PreferenceSimpleTuto!</string>

4. <string name="app_name">PreferenceSimpleTuto</string>

5. <string name="checkbox">Check Box</string>

6. <string name="ringtone">Ring Tone</string>

7. <string name="checkbox2">Check Box2</string>

8. <string name="text">Text</string>

9. <string name="list">List</string>

10. <string-array name="i_like_array">

11. <item>chocolate</item>

12. <item>television</item>

13. <item>internet</item>

14. <item>nicotine</item>

15. <item>hug</item>

16. <item>Santa Claus</item>

17. </string-array>

18. </resources>

III - Remerciements

Cet article a été publié avec l'aimable autorisation de la société Android2EE.

Nous tenons à remercier Malick SECK pour la relecture orthographique de cet article et Mickael Baron pour la mise au format Developpez.com.