7dd12647cc6e7a8882b079584fc10b7e39462619
[idea/community.git] / platform / platform-api / src / com / intellij / openapi / actionSystem / PlatformDataKeys.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.actionSystem;
17
18 import com.intellij.ide.*;
19 import com.intellij.openapi.Disposable;
20 import com.intellij.openapi.application.ModalityState;
21 import com.intellij.openapi.diff.DiffViewer;
22 import com.intellij.openapi.fileEditor.FileEditor;
23 import com.intellij.openapi.project.Project;
24 import com.intellij.openapi.vfs.VirtualFile;
25 import com.intellij.openapi.wm.ToolWindow;
26 import com.intellij.ui.content.ContentManager;
27
28 import java.awt.*;
29 import java.util.Comparator;
30
31 /**
32  * @author yole
33  */
34 public class PlatformDataKeys extends CommonDataKeys {
35   public static final DataKey<FileEditor> FILE_EDITOR = DataKey.create("fileEditor");
36
37   /**
38    *  Returns the text of currently selected file/file revision
39    */
40   public static final DataKey<String> FILE_TEXT = DataKey.create("fileText");
41
42   /**
43    * Returns Boolean.TRUE if action is executed in modal context and
44    * Boolean.FALSE if action is executed not in modal context. If context
45    * is unknown then the value of this data constant is <code>null</code>.
46    */
47   public static final DataKey<Boolean> IS_MODAL_CONTEXT = DataKey.create("isModalContext");
48   public static final DataKey<DiffViewer> DIFF_VIEWER = DataKey.create("diffViewer");
49   public static final DataKey<DiffViewer> COMPOSITE_DIFF_VIEWER = DataKey.create("compositeDiffViewer");
50
51   /**
52    * Returns help id (String)
53    */
54   public static final DataKey<String> HELP_ID = DataKey.create("helpId");
55
56   /**
57    * Returns project if project node is selected (in project view)
58    */
59   public static final DataKey<Project> PROJECT_CONTEXT = DataKey.create("context.Project");
60
61   /**
62    * Returns java.awt.Component currently in focus, DataContext should be retrieved for
63    */
64   public static final DataKey<Component> CONTEXT_COMPONENT = DataKey.create("contextComponent");
65   public static final DataKey<CopyProvider> COPY_PROVIDER = DataKey.create("copyProvider");
66   public static final DataKey<CutProvider> CUT_PROVIDER = DataKey.create("cutProvider");
67   public static final DataKey<PasteProvider> PASTE_PROVIDER = DataKey.create("pasteProvider");
68   public static final DataKey<DeleteProvider> DELETE_ELEMENT_PROVIDER = DataKey.create("deleteElementProvider");
69   public static final DataKey<Object> SELECTED_ITEM = DataKey.create("selectedItem");
70   public static final DataKey<Object[]> SELECTED_ITEMS = DataKey.create("selectedItems");
71   public static final DataKey<Rectangle> DOMINANT_HINT_AREA_RECTANGLE = DataKey.create("dominant.hint.rectangle");
72   public static final DataKey<ContentManager> CONTENT_MANAGER = DataKey.create("contentManager");
73   public static final DataKey<ToolWindow> TOOL_WINDOW = DataKey.create("TOOL_WINDOW");
74   public static final DataKey<TreeExpander> TREE_EXPANDER = DataKey.create("treeExpander");
75   public static final DataKey<ExporterToTextFile> EXPORTER_TO_TEXT_FILE = DataKey.create("exporterToTextFile");
76   public static final DataKey<VirtualFile> PROJECT_FILE_DIRECTORY = DataKey.create("context.ProjectFileDirectory");
77   public static final DataKey<Disposable> UI_DISPOSABLE = DataKey.create("ui.disposable");
78
79   public static final DataKey<ContentManager> NONEMPTY_CONTENT_MANAGER = DataKey.create("nonemptyContentManager");
80   public static final DataKey<ModalityState> MODALITY_STATE = DataKey.create("ModalityState");
81   public static final DataKey<Boolean> SOURCE_NAVIGATION_LOCKED = DataKey.create("sourceNavigationLocked");
82
83   public static final DataKey<String> PREDEFINED_TEXT = DataKey.create("predefined.text.value");
84
85   public static final DataKey<String> SEARCH_INPUT_TEXT = DataKey.create("search.input.text.value");
86   public static final DataKey<Object> SPEED_SEARCH_COMPONENT = DataKey.create("speed.search.component.value");
87
88   /**
89    * Returns java.awt.Point to guess where to show context menu invoked by key.
90    * This point should be relative to the currently focused component
91    */
92   public static final DataKey<Point> CONTEXT_MENU_POINT = DataKey.create("contextMenuPoint");
93
94   /**
95    * It's allowed to assign multiple actions to the same keyboard shortcut. Actions system filters them on the current
96    * context basis during processing (e.g. we can have two actions assigned to the same shortcut but one of them is
97    * configured to be inapplicable in modal dialog context).
98    * <p/>
99    * However, there is a possible case that there is still more than one action applicable for particular keyboard shortcut
100    * after filtering. The first one is executed then. Hence, actions processing order becomes very important.
101    * <p/>
102    * Current key allows to specify custom actions sorter to use if any. I.e. every component can define it's custom
103    * sorting rule in order to define priorities for target actions (classes of actions).
104    *
105    * @deprecated use com.intellij.openapi.actionSystem.ActionPromoter
106    */
107   @Deprecated
108   public static final DataKey<Comparator<? super AnAction>> ACTIONS_SORTER = DataKey.create("actionsSorter");
109 }