LecteurPdfDoubleAffichage/src/lecteur_pdf/raccourcisClavier/RaccourcisElement.java

/*
 * RaccourcisElement.java 10/03/2022
 * IUT Rodez 2021-2022, INFO2
 * Pas de copyright, aucun droits
 */

package lecteur_pdf.raccourcisClavier;

import lecteur_pdf.Popup;

import javax.swing.*;
import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.KeyEvent;
import java.awt.event.KeyListener;

/**
 * Élément de raccourcis qui définit un raccourci pour une propriété de
 * l'application
 *
 * @author Léo Franch
 * @author Tristan Nogaret
 * @author Lucàs Vabre
 * @author Noé Villeneuve
 * @see JPanel
 */
public class RaccourcisElement extends JPanel {

    /**
     * Le nom du MenuItem
     */
    private final String nom;

    /**
     * Le bouton qui contient en valeur la séquence de touches correspondant
     * au raccourci du
     * {@link lecteur_pdf.menuBar.menuItems.MenuItem MenuItem} de l'application
     *
     * @see JButton
     */
    private final JButton btnRaccourcis;

    /**
     * Le raccourci clavier
     *
     * @see KeyStroke
     */
    private KeyStroke raccourcis;

    /**
     * Crée un nouveau JPanel comportant une ligne et deux colonnes
     * <li>Dans la première colonne on trouve un label qui défini le
     * {@link lecteur_pdf.menuBar.menuItems.MenuItem MenuItem}</li>
     * <li>Dans la seconde colonne on trouve le bouton pour éditer le
     * raccourci clavier</li>
     *
     * @param nom        Le nom du
     *                   {@link lecteur_pdf.menuBar.menuItems.MenuItem
     *                   MenuItem} ciblé
     * @param raccourcis Le raccourci clavier actuel du
     *                   {@link lecteur_pdf.menuBar.menuItems.MenuItem
     *                   MenuItem} ciblé
     * @see GridLayout
     */
    public RaccourcisElement(String nom, KeyStroke raccourcis) {
        super(new GridLayout(1, 2));

        this.nom = nom;
        this.raccourcis = raccourcis;

        /* Interface */
        JLabel nomElement = new JLabel(nom);
        System.out.println(raccourcis);
        btnRaccourcis = new JButton(keystrokeToString(raccourcis));
        add(nomElement);
        add(btnRaccourcis);

        btnRaccourcis.addActionListener(this::action);
    }

    /**
     * Action lors du clic sur le bouton d'édition du raccourci
     *
     * @param evt écouteur d'évènement
     */
    private void action(ActionEvent evt) {
        if (!RaccourcisClavier.saisieBloquee) {
            RaccourcisClavier.saisieBloquee = true;
            btnRaccourcis.setText(" --- ");

            btnRaccourcis.addKeyListener(new KeyListener() {

                /**
                 * Valeur qui permet de définir si une touche n'est pas reconnue
                 */
                private static final int INDETERMINATE = -1;

                /**
                 * La valeur de la touche pressée précédemment
                 */
                private int previousKeyPressed = INDETERMINATE;

                @Override
                public void keyPressed(KeyEvent evt) {
                    if (previousKeyPressed == INDETERMINATE) {
                        previousKeyPressed = evt.getKeyCode();
                    } else if (previousKeyPressed != evt.getKeyCode()
                               && isMaskValide(previousKeyPressed)
                               && !isMaskValide(evt.getKeyCode())) {

                        KeyStroke ks = KeyStroke.getKeyStroke(evt.getKeyCode(),
                                                              getMask(
                                                                  previousKeyPressed));

                        /* Vérifie que ce raccourci clavier n'existe pas */
                        if (!RaccourcisClavier.raccourcis.containsValue(ks)) {
                            btnRaccourcis.setText(
                                getMaskString(previousKeyPressed) + " + "
                                + ks.toString().split(" ")[2]);
                            // On modifie la valeur
                            RaccourcisClavier.raccourcis.replace(nom, ks);
                            raccourcis = ks;
                            RaccourcisClavier.affecterRaccourcis();
                            RaccourcisClavier.sauvegarderRaccourcis();
                        } else {
                            final String TITRE_ERREUR = "Erreur raccourcis";
                            final String MESSAGE_ERREUR = "Le raccourcis que "
                                                          + "vous venez de "
                                                          + "réaliser est "
                                                          + "déjà affecté à "
                                                          + "une autre "
                                                          + "fonctionnalité";

                            Popup.errorPopup(btnRaccourcis, TITRE_ERREUR,
                                             MESSAGE_ERREUR);
                            btnRaccourcis.setText(
                                modifierToString(raccourcis.getModifiers())
                                + " + " + (char) raccourcis.getKeyCode());
                        }

                        btnRaccourcis.removeKeyListener(this);
                        RaccourcisClavier.saisieBloquee = false;
                    }
                }

                @Override
                public void keyTyped(KeyEvent evt) {
                }

                @Override
                public void keyReleased(KeyEvent evt) {
                    if (previousKeyPressed == evt.getKeyCode()) {
                        previousKeyPressed = INDETERMINATE;
                    }
                }

                private boolean isMaskValide(int maskValue) {
                    return 16 <= maskValue && maskValue <= 18;
                }

                /**
                 * Méthode outil qui permet de convertir la valeur tapée en
                 * KeyEvent
                 * @param maskValue Valeur de masque tapé (control, shift ou
                 *                  alt)
                 * @return Le KeyEvent correspondant
                 *
                 * @see KeyEvent
                 */
                private int getMask(int maskValue) {
                    return switch (maskValue) {
                        case 16 -> KeyEvent.SHIFT_DOWN_MASK;
                        case 17 -> KeyEvent.CTRL_DOWN_MASK;
                        default -> KeyEvent.ALT_DOWN_MASK;
                    };
                }

                /**
                 * Méthode outil qui permet de convertir la valeur tapée en
                 * chaîne de caractère
                 * @param maskValue Valeur de masque tapé (controle, shift ou
                 *                 alt)
                 * @return La chaine de caractère correspondante
                 */
                private String getMaskString(int maskValue) {
                    return switch (maskValue) {
                        case 16 -> "SHIFT";
                        case 17 -> "CTRL";
                        default -> "ALT";
                    };
                }
            });
        }
    }

    /**
     * Convertit un modifier en chaîne de caractère
     *
     * @param modifier valeur du modifier (Element d'un KeyStroke != KeyEvent)
     * @return La chaîne de caractère correspondante
     */
    private String modifierToString(int modifier) {
        return switch (modifier) {
            case 65 -> "SHIFT";
            case 130 -> "CTRL";
            default -> "ALT";
        };
    }

    /**
     * Convertit un raccourci en chaîne de caractère
     *
     * @param keyStroke Le raccourci en question
     * @return La chaîne de caractère construite à partir du raccourci
     *
     * @see KeyStroke
     */
    private String keystrokeToString(KeyStroke keyStroke) {
        return modifierToString(keyStroke.getModifiers()) + " + "
               + keyStroke.toString().split(" ")[2];
    }

    /**
     * Change le raccourci (visuellement)
     *
     * @param raccourcis nouveau raccourci
     */
    public void setRaccourcis(KeyStroke raccourcis) {
        this.raccourcis = raccourcis;
        this.btnRaccourcis.setText(keystrokeToString(raccourcis));
    }
}