01: /*
02: * Javu WingS - Lightweight Java Component Set
03: * Copyright (c) 2005-2007 Krzysztof A. Sadlocha
04: * e-mail: ksadlocha@programics.com
05: *
06: * This library is free software; you can redistribute it and/or
07: * modify it under the terms of the GNU Lesser General Public
08: * License as published by the Free Software Foundation; either
09: * version 2.1 of the License, or (at your option) any later version.
10: *
11: * This library is distributed in the hope that it will be useful,
12: * but WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14: * Lesser General Public License for more details.
15: *
16: * You should have received a copy of the GNU Lesser General Public
17: * License along with this library; if not, write to the Free Software
18: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19: */
20:
21: package com.javujavu.javux.wings;
22:
23: import java.awt.event.KeyEvent;
24:
25: /**
26: * The interface for objects implementing interactive keyboard shortcuts.<br>
27: * Every object implementing Shortcut can be added to <code>WingComponent</code> as a shortcut.<br>
28: * Shortcut receives key events which <code>getKeyCode</code> and <code>getModifiers</code> return the same values
29: * as <code>getShortcutCode</code> and <code>getShortcutModifiers</code> of the shortcut.<br>
30: * <br>
31: * <b>This is one of the core WingS interfaces required by all the components</b>
32: **/
33: public interface Shortcut {
34: /**
35: * @return shortcut key code
36: */
37: int getShortcutCode();
38:
39: /**
40: * @return shortcut key modifiers
41: */
42: int getShortcutModifiers();
43:
44: /**
45: * Method invoked when shortcut key is pressed or released
46: * @param e key event
47: */
48: void processShortcut(KeyEvent e);
49: }
|