001    package echopoint.able;
002    
003    /* 
004     * This file is part of the Echo Point Project.  This project is a collection
005     * of Components that have extended the Echo Web Application Framework.
006     *
007     * Version: MPL 1.1/GPL 2.0/LGPL 2.1
008     *
009     * The contents of this file are subject to the Mozilla Public License Version
010     * 1.1 (the "License"); you may not use this file except in compliance with
011     * the License. You may obtain a copy of the License at
012     * http://www.mozilla.org/MPL/
013     *
014     * Software distributed under the License is distributed on an "AS IS" basis,
015     * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
016     * for the specific language governing rights and limitations under the
017     * License.
018     *
019     * Alternatively, the contents of this file may be used under the terms of
020     * either the GNU General Public License Version 2 or later (the "GPL"), or
021     * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
022     * in which case the provisions of the GPL or the LGPL are applicable instead
023     * of those above. If you wish to allow use of your version of this file only
024     * under the terms of either the GPL or the LGPL, and not to allow others to
025     * use your version of this file under the terms of the MPL, indicate your
026     * decision by deleting the provisions above and replace them with the notice
027     * and other provisions required by the GPL or the LGPL. If you do not delete
028     * the provisions above, a recipient may use your version of this file under
029     * the terms of any one of the MPL, the GPL or the LGPL.
030     */
031    
032    /**
033     * The <code>AccessKeyable</code> interface is used to set a access key for a
034     * given component. While most clients only support one access key and hence the
035     * value could have been a 'char', AccessKeyable also supports a null access key
036     * (ie no access key) and hence java.lang.String is used as the access key
037     * value.
038     */
039    public interface AccessKeyable extends Delegateable {
040    
041            public static final String PROPERTY_ACCESS_KEY = "accessKey";
042    
043            /**
044             * Returns the access key in use.
045             * 
046             * @return the access key in use.
047             */
048            public String getAccessKey();
049    
050            /**
051             * Sets the access key to be used.
052             * 
053             * @param newValue -
054             *            the access key to be used.
055             */
056            public void setAccessKey(String newValue);
057    }