4458bda7d5f7e2d5499199aaa320b6039e41ab6c
[idea/community.git] / platform / platform-api / src / com / intellij / openapi / editor / actionSystem / EditorActionManager.java
1 /*
2  * Copyright 2000-2009 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.editor.actionSystem;
17
18 import com.intellij.openapi.components.ServiceManager;
19 import com.intellij.openapi.editor.Document;
20 import org.jetbrains.annotations.NonNls;
21 import org.jetbrains.annotations.NotNull;
22
23 /**
24  * Allows to register actions which are activated by typing and navigation keystrokes
25  * in the editor.
26  */
27 public abstract class EditorActionManager {
28   /**
29    * Returns the instance of the editor action manager.
30    *
31    * @return the editor action manger instance.
32    */
33   public static EditorActionManager getInstance() {
34     return ServiceManager.getService(EditorActionManager.class);
35   }
36
37   /**
38    * Returns the handler currently defined for the specified editor actions.
39    *
40    * @param actionId the ID of the action for which the handler is requested. Possible
41    *                 IDs are defined in the {@link com.intellij.openapi.actionSystem.IdeActions} class
42    *                 by constants starting with <code>ACTION_EDITOR_</code>.
43    * @return the handler currently defined for the action.
44    */
45   public abstract EditorActionHandler getActionHandler(@NonNls @NotNull String actionId);
46
47   /**
48    * Sets the handler for the specified editor actions.
49    *
50    * @param actionId the ID of the action for which the handler is set. Possible
51    *                 IDs are defined in the {@link com.intellij.openapi.actionSystem.IdeActions} class
52    *                 by constants starting with <code>ACTION_EDITOR_</code>.
53    * @return the handler previously defined for the action.
54    */
55   public abstract EditorActionHandler setActionHandler(@NonNls @NotNull String actionId, @NotNull EditorActionHandler handler);
56
57   /**
58    * Returns the service for registering actions activated by typing visible characters
59    * in the editor.
60    *
61    * @return the typed action service instance.
62    */
63   @NotNull
64   public abstract TypedAction getTypedAction();
65
66   /**
67    * Gets the default handler which is invoked on attempt to modify a read-only fragment in the editor.
68    *
69    * @return the handler instance.
70    * @see com.intellij.openapi.editor.Document#createGuardedBlock(int, int)
71    */
72   public abstract ReadonlyFragmentModificationHandler getReadonlyFragmentModificationHandler();
73
74   /**
75    * Sets the handler which is invoked on attempt to modify a read-only fragment in the editor.
76    *
77    * @param handler the handler instance.
78    * @return the old instance of the handler.
79    * @see com.intellij.openapi.editor.Document#createGuardedBlock(int, int)
80    */
81   public abstract ReadonlyFragmentModificationHandler setReadonlyFragmentModificationHandler(@NotNull ReadonlyFragmentModificationHandler handler);
82
83   /**
84    * Gets the handler which is invoked on attempt to modify a read-only fragment for the document.
85    *
86    * @param document target document
87    * @return the handler instance.
88    * @see com.intellij.openapi.editor.Document#createGuardedBlock(int, int)
89    */
90   public abstract ReadonlyFragmentModificationHandler getReadonlyFragmentModificationHandler(@NotNull Document document);
91
92   /**
93    * Sets the handler which is invoked on attempt to modify a read-only fragment for the document.
94    *
95    * @param document target document
96    * @param handler  new handler
97    * @see com.intellij.openapi.editor.Document#createGuardedBlock(int, int)
98    */
99   public abstract void setReadonlyFragmentModificationHandler(@NotNull Document document, ReadonlyFragmentModificationHandler handler);
100
101 }
102