View Javadoc

1   /*
2    * $Id: IAccessKeyCapability.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 alphanumeric key used to execute an action from
8    * the keyboard (in conjunction with a alteration key ex : Alt).
9    * <p>
10   * Alt + &lt;Any alphanumeric key&gt; <BR>
11   * The letter|number will be highlighted when the alteration key is pressed.
12   * </p>
13   * 
14   * @author Olivier Oeuillot (latest modification by $Author: jbmeslin $)
15   * @version $Revision: 1.18 $ $Date: 2011/06/16 09:29:40 $
16   */
17  public interface IAccessKeyCapability {
18      /**
19       * Returns a string that indicates the alphanumeric key used to execute an
20       * action from the keyboard (in conjunction with a alteration key ex : Alt).
21       * 
22       * @return &lt;Any alphanumeric key&gt;
23       */
24      String getAccessKey();
25  
26      /**
27       * Sets a string that indicates the alphanumeric key used to execute an
28       * action from the keyboard (in conjunction with a alteration key ex : Alt).
29       * 
30       * @param key
31       *            &lt;Any alphanumeric key&gt;
32       */
33      void setAccessKey(String key);
34  }