replaced <code></code> with more concise {@code}
[idea/community.git] / platform / platform-impl / src / com / intellij / openapi / keymap / ex / KeymapManagerEx.java
1 /*
2  * Copyright 2000-2016 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.intellij.openapi.keymap.ex;
17
18 import com.intellij.openapi.keymap.Keymap;
19 import com.intellij.openapi.keymap.KeymapManager;
20 import com.intellij.openapi.keymap.KeymapManagerListener;
21 import com.intellij.openapi.options.SchemeManager;
22 import com.intellij.openapi.options.SchemesManager;
23 import org.jetbrains.annotations.NotNull;
24 import org.jetbrains.annotations.Nullable;
25
26 import java.util.Set;
27
28 public abstract class KeymapManagerEx extends KeymapManager {
29   public static KeymapManagerEx getInstanceEx() {
30     return (KeymapManagerEx)getInstance();
31   }
32
33   /**
34    * @return all available keymaps. The method return an empty array if no
35    * keymaps are available.
36    */
37   public abstract Keymap[] getAllKeymaps();
38
39   public abstract void setActiveKeymap(@Nullable Keymap keymap);
40
41   /**
42    * Instructs the manager that one action should use shortcut of another one ({@code 'use-shortcut-of'} attribute at
43    * action's config located at plugin.xml).
44    *
45    * @param sourceActionId if of the action which shortcut should be used for the 'target action'
46    * @param targetActionId id of the action which should use shortcut of the 'source action'
47    */
48   public abstract void bindShortcuts(@NotNull String sourceActionId, @NotNull String targetActionId);
49
50   public abstract void unbindShortcuts(String targetActionId);
51
52   @NotNull
53   public abstract Set<String> getBoundActions();
54
55   @Nullable
56   public abstract String getActionBinding(@NotNull String actionId);
57
58   public abstract SchemeManager<Keymap> getSchemeManager();
59
60   /**
61    * @deprecated Please use {@link #getSchemeManager()}
62    */
63   @SuppressWarnings("deprecation")
64   @Deprecated
65   public final SchemesManager<Keymap> getSchemesManager() {
66     return (SchemesManager<Keymap>)getSchemeManager();
67   }
68
69   public abstract void addWeakListener(@NotNull KeymapManagerListener listener);
70
71   public abstract void removeWeakListener(@NotNull KeymapManagerListener listenerToRemove);
72 }