001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.core.options.keymap.api;
043:
044: import java.util.Set;
045:
046: /**
047: * Objects implementing this interface serve as providers for storing
048: * the shortcuts definitions.
049: *
050: * @author David Strupl
051: */
052: public interface ShortcutsFinder {
053: /**
054: * Find a ShortcutAction for a given string representation of the shortcut.
055: * @param shortcuts
056: * @return the shortcut
057: */
058: ShortcutAction findActionForShortcut(String shortcuts);
059:
060: /**
061: * The actions can be assigned IDs when storing them. This method
062: * finds a ShortcutAction instance by given id.
063: * @param id
064: * @return the shortcut
065: */
066:
067: ShortcutAction findActionForId(String id);
068:
069: /**
070: * This method will show the shortcut selection dialog to the user.
071: * @return The shortcut that the user has selected on <code>null</code>
072: * if the user has cancelled the dialog
073: */
074:
075: String showShortcutsDialog();
076:
077: /**
078: * Retrieve all the shortcuts assigned to a given action.
079: * @param action
080: * @return all the shortcuts for the action.
081: */
082: String[] getShortcuts(ShortcutAction action);
083:
084: /**
085: * Refreshes the model by reading the stored assignments.
086: */
087: void refreshActions();
088:
089: /**
090: * Assigns the given shortcuts to the given action.
091: * @param action
092: * @param shortcuts
093: */
094: void setShortcuts(ShortcutAction action, Set<String> shortcuts);
095:
096: /**
097: * Applies the changes by storing them to the storage.
098: */
099: void apply();
100: }
|