View Javadoc

1   /*
2    *  XNap - A P2P framework and client.
3    *
4    *  See the file AUTHORS for copyright information.
5    *
6    *  This program is free software; you can redistribute it and/or modify
7    *  it under the terms of the GNU General Public License as published by
8    *  the Free Software Foundation.
9    *
10   *  This program is distributed in the hope that it will be useful,
11   *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12   *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   *  GNU General Public License for more details.
14   *
15   *  You should have received a copy of the GNU General Public License
16   *  along with this program; if not, write to the Free Software
17   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18   */
19  package org.xnap.gui.shortcut;
20  
21  import javax.swing.KeyStroke;
22  
23  /***
24   * Defines the requirements for classes that provide shortcuts.
25   */
26  public interface Shortcut {
27  
28      // --- Constants(s) ---
29  
30      // --- Method(s) ---
31  
32      /***
33       * Returns the parent category.
34       */
35      String getCategory();
36  
37      /***
38       * 
39       */
40      String getDescription();
41  
42      /***
43       * Returns a keystroke.
44       */
45      KeyStroke getDefaultKeyStroke();
46  
47      /***
48       * Returns a keystroke.
49       */
50      KeyStroke getKeyStroke();
51  
52      /***
53       * 
54       */
55      void setKeyStroke(KeyStroke stroke);
56  
57  }
58