View Javadoc

1   /*
2    * $Id: IAcceleratorKeyCapability.java,v 1.18 2011/06/16 09:29:40 jbmeslin Exp $
3    */
4   package org.rcfaces.core.component.capability;
5   
6   /**
7    * A string that indicates the (composed) key used to execute an action from the
8    * keyboard.
9    * <p>
10   * [Shift|Alt|Ctrl] + &lt;Any key&gt;
11   * 
12   * @author Olivier Oeuillot (latest modification by $Author: jbmeslin $)
13   * @version $Revision: 1.18 $ $Date: 2011/06/16 09:29:40 $
14   */
15  public interface IAcceleratorKeyCapability {
16  
17      /**
18       * Returns a string that indicates the (composed) key used to execute an
19       * action from the keyboard.
20       * 
21       * @return [Shift|Alt|Ctrl] + &lt;Any key&gt;
22       */
23      String getAcceleratorKey();
24  
25      /**
26       * Sets a string that indicates the (composed) key used to execute an action
27       * from the keyboard.
28       * 
29       * @param acceleratorKey
30       *            [Shift|Alt|Ctrl] + &lt;Any key&gt;
31       */
32      void setAcceleratorKey(String acceleratorKey);
33  }