Skip to content
This repository has been archived by the owner on Mar 9, 2022. It is now read-only.

Latest commit

 

History

History
265 lines (191 loc) · 14.4 KB

UserGuideFr.md

File metadata and controls

265 lines (191 loc) · 14.4 KB

aFileDialog - Guide de l'utilisateur

1. Utilisation basique

Installation

Pour utiliser aFileDialog, dans votre logiciel, il faut suivre les suivants pas:

1) Ajouter une référence au projet de la librairie (situé dans le dossier library). Étant donné que aFileDialog est un projet de librairie d'Android, il ne peut pas être compilé et distribué comme un fichier binaire (comme, par exemple, un fichier JAR), à cause de ça on doit faire la référence au dossier du projet (avec le code source), en lieu de faire la référence à un fichier JAR.

2) Déclarer la activité FileChooserActivity dans le fichier de manifeste. On peut faire ça en ajoutant les lignes suivantes entre les étiquettes <application></application>:

    <activity android:name="ar.com.daidalos.afiledialog.FileChooserActivity" />

3) Déclarer le permis READ_EXTERNAL_STORAGE dans le fichier de manifeste, si on a besoin d’accéder à la carte SD (et si on utilise Android 4.1 ou supérieur).

    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

4) Sur Android 6.0 et versions ultérieures, en plus d'indiquer la permission sur le fichier manifest, vous devez également demander aux utilisateurs d'approuver l'autorisation lors de l'exécution. Par exemple:

if (ContextCompat.checkSelfPermission(this, Manifest.permission.READ_EXTERNAL_STORAGE) != PackageManager.PERMISSION_GRANTED) {
    // If permission is not granted, ask it.
    ActivityCompat.requestPermissions(this,
            new String[]{Manifest.permission.READ_EXTERNAL_STORAGE},
            MY_PERMISSIONS_REQUEST_READ_EXTERNAL_STORAGE);
}

Vous pouvez trouvar plus d'information dans https://developer.android.com/training/permissions/requesting.

Pour plus d'information sur comment faire une référence à un projet de librairie et comment déclarer une activité dans le fichier de manifeste, vous pouvez lire la documentation officielle d'Android.

1.2. Afficher le sélecteur de fichiers

Si on veut utiliser un Dialog pour afficher le sélecteur de fichiers, on peut utiliser les lignes suivantes:

    FileChooserDialog dialog = new FileChooserDialog(this);
    dialog.show();

Si on veut utiliser une Activity pour afficher le sélecteur de fichiers, alors on peut utiliser ces lignes de code:

    Intent intent = new Intent(this, FileChooserActivity.class);
    this.startActivityForResult(intent, 0);

Par défaut, le sélecteur de fichiers montre le racine de la carte SD, néanmoins, on peut changer le dossier que le sélecteur montre la première fois qu'il est ouvert.

Si on utilise un Dialog pour afficher le sélecteur, alors on doit appeler le méthode loadFolder() de la classe FileChooserDialog:

    FileChooserDialog dialog = new FileChooserDialog(this);
    dialog.loadFolder(Environment.getExternalStorageDirectory() + "/Download/");
    dialog.show();

Si on utilise une Activity pour afficher le sélecteur, alors on doit ajouter un extra au Intent avec le nom FileChooserActivity.INPUT_START_FOLDER et le chemin du dossier comme le valeur:

    Intent intent = new Intent(this, FileChooserActivity.class);
    intent.putExtra(FileChooserActivity.INPUT_START_FOLDER, Environment.getExternalStorageDirectory() + "/Download/");
    this.startActivityForResult(intent, 0);

1.3. Retrouver le fichier sélectionné

À fin de retrouver le fichier, représente comme un objet File, choisi par l'utilisateur, si on utilise un Dialog pour afficher le sélecteur, il faut appeler le méthode addListener(), de la classe FileChooserDialog, en utilisant comme paramètre une implémentation de la interface FileChooserDialog.OnFileSelectedListener:

    dialog.addListener(new FileChooserDialog.OnFileSelectedListener() {
        public void onFileSelected(Dialog source, File file) {
            source.hide();
            Toast toast = Toast.makeText(source.getContext(), "File selected: " + file.getName(), Toast.LENGTH_LONG);
            toast.show();
		}
		public void onFileSelected(Dialog source, File folder, String name) {
            source.hide();
            Toast toast = Toast.makeText(source.getContext(), "File created: " + folder.getName() + "/" + name, Toast.LENGTH_LONG);
            toast.show();
		}
	});

L'interface FileChooserDialog.OnFileSelectedListener défini deux méthodes: onFileSelected(Dialog source, File file), qui est appelé quand un fichier est sélectionné; et onFileSelected(Dialog source, File folder, String name), qui est appelé quand un fichier est créé.

Il faut tenir en compte, qu'est responsabilité de l'application de fermer le sélecteur de fichiers, une fois que un fichier a été sélectionné. De cette manière, si l'utilisateur sélectionne un fichier incorrecte, l’application peut montrer un message d'erreur et ne pas fermer le sélecteur de fichiers, à fin de permettre à l'utilisateur de sélectionner autre fichier.

Si on utilise une Activity pour afficher le sélecteur de fichiers, alors la Activity que appelle le sélecteur doit implémenter le méthode onActivityResult():

	@Override
	protected void onActivityResult(int requestCode, int resultCode, Intent data) {
	    if (resultCode == Activity.RESULT_OK) {
	    	boolean fileCreated = false;
	    	String filePath = "";
	    	
	    	Bundle bundle = data.getExtras();
	        if(bundle != null)
	        {
	        	if(bundle.containsKey(FileChooserActivity.OUTPUT_NEW_FILE_NAME)) {
	        		fileCreated = true;
	        		File folder = (File) bundle.get(FileChooserActivity.OUTPUT_FILE_OBJECT);
	        		String name = bundle.getString(FileChooserActivity.OUTPUT_NEW_FILE_NAME);
	        		filePath = folder.getAbsolutePath() + "/" + name;
	        	} else {
	        		fileCreated = false;
	        		File file = (File) bundle.get(FileChooserActivity.OUTPUT_FILE_OBJECT);
	        		filePath = file.getAbsolutePath();
	        	}
	        }
	    	
	        String message = fileCreated? "File created" : "File opened";
	        message += ": " + filePath;
	    	Toast toast = Toast.makeText(AFileDialogTestingActivity.this, message, Toast.LENGTH_LONG);
			toast.show();
	    }
	}

Il faut tenir en compte que si un fichier a été créé, alors le valeur (à l’intérieur de l'objet Bundle) représenté par la mot FileChooserActivity.OUTPUT_NEW_FILE_NAME contiendra le nom de fichier et le valeur représenté par la mot FileChooserActivity.OUTPUT_FILE_OBJECT contiendra le dossier dans lequel le fichier doit être créé. Autrement, si le fichier a été seulement sélectionné, FileChooserActivity.OUTPUT_NEW_FILE_NAME contiendra un valeur nulle et FileChooserActivity.OUTPUT_FILE_OBJECT contiendra le fichier sélectionné.

1.4 Demo

Dans le dossier demo on peut trouver le projet d'une application référence et utilise la librairie aFileDialog.

On peut aussi installer cette application dans Google Play.

2. Options avancés

2.1. Sélectionner dossiers

Par défaut, le sélecteur sélectionne fichiers, néanmoins, on le peut paramétrer pour sélectionner dossiers. Dans ce cas, un bouton "Ok" sera affiché à la section inférieur du sélecteur de fichiers; en appuyant ce bouton on sélectionnera le dossier actuelle (étant donné que l’évènement de toucher un dossier s'utilise pour ouvrir le dossier et afficher tous les fichiers que sont à l’intérieur).

Si on utilise un Dialog pour afficher le sélecteur de fichiers, alors il faut appeler le méthode _setFolderMode(), de la classe FileChooserDialog, en utilisant "true" comme paramètre:

    FileChooserDialog dialog = new FileChooserDialog(this);
    dialog.setFolderMode(true);
    dialog.show();

Si on utilise une Activity pour afficher le sélecteur de fichiers, alors on doit ajouter un extra au Intent avec le nom FileChooserActivity.INPUT_FOLDER_MODE et avec le valeur "true":

    Intent intent = new Intent(this, FileChooserActivity.class);
    intent.putExtra(FileChooserActivity.INPUT_FOLDER_MODE, true);
    this.startActivityForResult(intent, 0);

2.2. Créer fichiers

On peut paramétrer le sélecteur de fichiers pour afficher un bouton "New", pour donner la possibilité aux utilisateurs de créer fichiers ou dossiers. En appuyant ce bouton, une fenêtre émergent que permettra à l'utilisateur de saisir le nom du fichier ou dossier qu'il veut créer.

Il faut tenir en compte que le sélecteur de fichiers ne crée pas les fichiers ou dossiers, il se limite à obtenir le dossiers, dans lequel le fichier doit être créé, et le nom du fichier. Il est responsabilité de l'application, que a ouvert le sélecteur de fichiers, de créer le fichier et de l'ajouter l'extension correcte.

Si on utilise un Dialog, alors on doit appeler le méthode setCanCreateFiles() de la classe FileChooserDialog, en utilisant "true" comme paramètre:

    FileChooserDialog dialog = new FileChooserDialog(this);
    dialog.setCanCreateFiles(true);
    dialog.show();

Si on utilise une Activity, alors on doit ajouter un extra dans le Intent avec le nom FileChooserActivity.INPUT_CAN_CREATE_FILES et le valeur "true":

    Intent intent = new Intent(this, FileChooserActivity.class);
    intent.putExtra(FileChooserActivity.INPUT_CAN_CREATE_FILES, true);
    this.startActivityForResult(intent, 0);

2.3. Filtrer fichiers et dossiers

Par défaut, le sélecteur de fichiers permet à l'utilisateur de sélectionner n'importe quel fichier, néanmoins, on peut utiliser expressions régulières pour définir quels fichiers peuvent être sélectionné, selon son nom ou extension.

Si on utilise un Dialog, alors on doit appeler le méthode setFilter() de la classe FileChooserDialog, en utilisant une expression régulière comme paramètre (dans cet exemple, l'expression régulière définit que seulement fichiers d'images peuvent être sélectionné):

    FileChooserDialog dialog = new FileChooserDialog(this);
    dialog.setFilter(".*jpg|.*png|.*gif|.*JPG|.*PNG|.*GIF");
    dialog.show();

Si on utilise une Activity, alors on doit ajouter un extra au Intent avec nom FileChooserActivity.INPUT_REGEX_FILTER et avec l'expression régulière comme valeur:

    Intent intent = new Intent(this, FileChooserActivity.class);
    intent.putExtra(FileChooserActivity.INPUT_REGEX_FILTER, ".*jpg|.*png|.*gif|.*JPG|.*PNG|.*GIF");
    this.startActivityForResult(intent, 0);

De manière analogue, on peut également filtrer les dossiers en appelant la méthode _setFolderFilter () _, si vous utilisez un Dialog, ou en utilisant l'extra FileChooserActivity.INPUT_REGEX_FOLDER_FILTER, si vous utilisez une Activity.

Il faut Noter que lors du filtrage de fichiers, l'expression régulière est appliquée au nom du fichier, mais lors du filtrage des dossiers, l'expression régulière est appliquée sur le chemin absolu du fichier.

Quand on filtre des fichiers ou dossiers, on peut définir aussi si les fichiers/dossiers que ne sont pas sélectionnables doivent être affichés ou cachés (quand il sont affichés, il sont montrés avec un couleur grise, à fin d'indiquer à l'utilisateur que il ne le peut pas sélectionner).

Pour faire ça, si on utilise un Dialog, alors on doit appeler le méthode setShowOnlySelectable() de la classe FileChooserDialog; si on utilise une Activity, alors on doit ajouter un extra au Intent avec le nom FileChooserActivity.INPUT_SHOW_ONLY_SELECTABLE.

2.4. Afficher messages de confirmation

Le sélecteur de fichiers peut être paramétré pour afficher de fenêtres avec messages de confirmation (avec les options "Oui" et "Non") au sélectionner ou créer un fichier, avec messages comme "Vous êtes sure que vous voulez ouvrir ce fichier?".

Si on utilise un Dialog, on doit appeler le méthode setShowConfirmation() de la classe FileChooserDialog, le premier paramètre définit si un fenêtre de confirmation doit être affiché au ouvrir un fichier et le deuxième paramètre si la fenêtre doit être affiché quand on créé un fichier:

    FileChooserDialog dialog = new FileChooserDialog(this);
    dialog.setShowConfirmation(true, false);
    dialog.show();

Si on utilise une Activity, on doit ajouter deux extras au Intent avec les noms FileChooserActivity.INPUT_SHOW_CONFIRMATION_ON_CREATE et FileChooserActivity.INPUT_SHOW_CONFIRMATION_ON_SELECT:

    Intent intent = new Intent(this, FileChooserActivity.class);
    intent.putExtra(FileChooserActivity.INPUT_SHOW_CONFIRMATION_ON_SELECT, true);
    intent.putExtra(FileChooserActivity.INPUT_SHOW_CONFIRMATION_ON_CREATE, false);
    this.startActivityForResult(intent, 0);

Il faut remarquer que les messages des fenêtres peuvent être changés avec la classe FileChooserLabels.

2.5. Paramétrer étiquettes

On peut changer tous les messages et étiquettes utilisés par la librairie, pour ajouter de nouveaux messages ou pour ajouter des autre langages.

Pour faire ça, on doit créer une instance de la classe FileChooserLabels et définir le valeur des textes qu'on veut modifier (dans le cas des messages de confirmation, le texte "$file_name" sera remplacé par le nom du fichier concerné):

    FileChooserLabels labels = new FileChooserLabels();
    labels.createFileDialogAcceptButton = "Accept";
    labels.createFileDialogCancelButton = "Cancel";
    labels.createFileDialogMessage = "Enter the name of the file";
    labels.createFileDialogTitle = "Create file";
    labels.labelAddButton = "Add";
    labels.labelSelectButton = "Select";
    labels.messageConfirmCreation = "Are you sure that you want to create the file $file_name?";
    labels.messageConfirmSelection = "Are you sure that you want to open the file $file_name?";
    labels.labelConfirmYesButton = "Yes";
    labels.labelConfirmNoButton = "Note;

Après, il faut passer cette instance au sélecteur de fichiers. Si on utilise un Dialog, on doit appeler le méthode setLabels() de la classe FileChooserDialog:

    FileChooserDialog dialog = new FileChooserDialog(this);
    dialog.setLabels(labels);
    dialog.show();

Si on utilise une Activity, on doit ajouter un extra au Intent avec le nom FileChooserActivity.INPUT_LABELS:

    Intent intent = new Intent(this, FileChooserActivity.class);
    intent.putExtra(FileChooserActivity.INPUT_LABELS, (Serializable) labels); 
    this.startActivityForResult(intent, 0);