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.spi;
043:
044: import java.util.List;
045: import java.util.Map;
046: import java.util.Set;
047: import org.netbeans.core.options.keymap.api.ShortcutAction;
048:
049: /**
050: * The SPI class allowing to plug in implementations of shortcuts storage.
051: * The instances of this class are registered in the global lookup
052: * (Lookup.getDefault()).
053: *
054: * The class can implement also the keyboard shortcuts profiles manipulation
055: * (switching of the profiles, saving of the profiles etc.)
056: *
057: * @author David Strupl
058: */
059: public abstract class KeymapManager {
060:
061: /** My instance name */
062: private String name;
063:
064: /**
065: * Every instance is represented by an unique name.
066: * @param name
067: */
068: protected KeymapManager(String name) {
069: this .name = name;
070: }
071:
072: /**
073: * This method should return the currently running shortcuts action
074: * assignment.
075: * @return
076: */
077: public abstract Map<String, Set<ShortcutAction>> getActions();
078:
079: /**
080: * Refreshes the current keymap model by reading the assignments stored
081: * in the persistent storage.
082: */
083: public abstract void refreshActions();
084:
085: /**
086: * Retrieves the action shortcuts assignments for given profile.
087: * @param profileName The name of the profile to get shortcuts for.
088: * @return Shortcuts for given profile.
089: */
090: public abstract Map<ShortcutAction, Set<String>> getKeymap(
091: String profileName);
092:
093: /**
094: * Retrieves the default action shortcuts assignments for given profile.
095: * @param profileName The name of the profile to get shortcuts for.
096: * @return Default shortcuts for given profile.
097: */
098: public abstract Map<ShortcutAction, Set<String>> getDefaultKeymap(
099: String profileName);
100:
101: /**
102: * Saves the given action shortcuts assignment under given profile name.
103: * @param profileName
104: * @param actionToShortcuts
105: */
106: public abstract void saveKeymap(String profileName,
107: Map<ShortcutAction, Set<String>> actionToShortcuts);
108:
109: /**
110: * Lists all profiles known to this KeymapManager.
111: * @return the existing profile names.
112: */
113: public abstract List<String> getProfiles();
114:
115: public String getProfileDisplayName(String profileName) {
116: return profileName;
117: }
118:
119: /**
120: * @return Currently active profile.
121: */
122: public abstract String getCurrentProfile();
123:
124: /**
125: * Allows switching of the profiles.
126: * @param profileName
127: */
128: public abstract void setCurrentProfile(String profileName);
129:
130: /**
131: * Deletes the given profile.
132: * @param profileName
133: */
134: public abstract void deleteProfile(String profileName);
135:
136: /**
137: * The profile can be either default or custom.
138: * @param profileName
139: * @return
140: */
141: public abstract boolean isCustomProfile(String profileName);
142:
143: /**
144: * @return this instance name (should be unique amongst all registered
145: * instances.
146: */
147: public final String getName() {
148: return name;
149: }
150: }
|