// License: GPL. For details, see LICENSE file.
package org.openstreetmap.josm.gui.util;

import java.util.List;

import javax.swing.Action;

import org.openstreetmap.josm.tools.Shortcut;

/**
 * Action implementing a multikey shortcut - shortcuts like Ctrl+Alt+S,n will toggle n-th layer visibility.
 * @since 4595
 */
public interface MultikeyShortcutAction extends Action {

    /**
     * Information for a Multikey action
     */
    class MultikeyInfo {
        private final int index;
        private final String description;

        public MultikeyInfo(int index, String description) {
            this.index = index;
            this.description = description;
        }

        public int getIndex() {
            return index;
        }

        public char getShortcut() {
            if (index < 9)
                return (char) ('1' + index);
            else if (index == 9)
                return '0';
            else
                return (char) ('A' + index - 10);
        }

        public String getDescription() {
            return description;
        }
    }

    Shortcut getMultikeyShortcut();

    /**
     * Execute a multi key action
     * @param index The index to execute
     * @param repeatLastAction {@code true} if the last action should be executed if no action is found for the given index.
     */
    void executeMultikeyAction(int index, boolean repeatLastAction);

    List<MultikeyInfo> getMultikeyCombinations();

    MultikeyInfo getLastMultikeyAction();

}