5dcf68f05f528d3e23693dd484c36ea3883e2541
[idea/community.git] / platform / platform-api / src / com / intellij / openapi / actionSystem / DataConstants.java
1 /*
2  * Copyright 2000-2015 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 org.jetbrains.annotations.NonNls;
19
20 /**
21  * Identifiers for data items which can be returned from {@link DataContext#getData(String)} and
22  * {@link DataProvider#getData(String)}.
23  *
24  * @deprecated {@link DataKeys} and {@link DataKey#getData} should be used instead
25  */
26 @SuppressWarnings({"HardCodedStringLiteral", "JavadocReference"})
27 public interface DataConstants {
28   /**
29    * Returns {@link com.intellij.openapi.project.Project}
30    *
31    * @deprecated use {@link PlatformDataKeys#PROJECT} instead
32    */
33   String PROJECT = CommonDataKeys.PROJECT.getName();
34
35   /**
36    * Returns {@link com.intellij.openapi.module.Module}
37    *
38    * @deprecated use {@link com.intellij.openapi.actionSystem.LangDataKeys#MODULE} instead
39    */
40   @NonNls String MODULE = "module";
41
42   /**
43    * Returns {@link com.intellij.openapi.vfs.VirtualFile}
44    *
45    * @deprecated use {@link PlatformDataKeys#VIRTUAL_FILE} instead
46    */
47   String VIRTUAL_FILE = CommonDataKeys.VIRTUAL_FILE.getName();
48
49   /**
50    * Returns array of {@link com.intellij.openapi.vfs.VirtualFile}
51    *
52    * @deprecated use {@link PlatformDataKeys#VIRTUAL_FILE_ARRAY} instead
53    */
54   String VIRTUAL_FILE_ARRAY = CommonDataKeys.VIRTUAL_FILE_ARRAY.getName();
55
56   /**
57    * Returns {@link com.intellij.openapi.editor.Editor}
58    *
59    * @deprecated use {@link PlatformDataKeys#EDITOR} instead
60    */
61   String EDITOR = CommonDataKeys.EDITOR.getName();
62
63   /**
64    * Returns {@link com.intellij.openapi.fileEditor.FileEditor}
65    *
66    * @deprecated use {@link PlatformDataKeys#FILE_EDITOR} instead
67    */
68   String FILE_EDITOR = PlatformDataKeys.FILE_EDITOR.getName();
69
70   /**
71    * Returns {@link com.intellij.openapi.fileEditor.OpenFileDescriptor}
72    *
73    * @deprecated {@link PlatformDataKeys#NAVIGATABLE} should be used instead
74    */
75   @NonNls String OPEN_FILE_DESCRIPTOR = "openFileDescriptor";
76
77   /**
78    * Returns the text of currently selected file/file revision
79    *
80    * @deprecated use {@link PlatformDataKeys#FILE_TEXT} instead
81    */
82   String FILE_TEXT = PlatformDataKeys.FILE_TEXT.getName();
83
84   /**
85    * Returns Boolean.TRUE if action is executed in modal context and
86    * Boolean.FALSE if action is executed not in modal context. If context
87    * is unknown then the value of this data constant is <code>null</code>.
88    *
89    * @deprecated use {@link PlatformDataKeys#IS_MODAL_CONTEXT} instead
90    */
91   String IS_MODAL_CONTEXT = PlatformDataKeys.IS_MODAL_CONTEXT.getName();
92
93   /**
94    * Returns {@link com.intellij.openapi.diff.DiffViewer}
95    *
96    * @deprecated use {@link PlatformDataKeys#DIFF_VIEWER} instead
97    */
98   String DIFF_VIEWER = PlatformDataKeys.DIFF_VIEWER.getName();
99
100   /**
101    * Returns help id (String)
102    *
103    * @deprecated use {@link PlatformDataKeys#HELP_ID} instead
104    */
105   String HELP_ID = PlatformDataKeys.HELP_ID.getName();
106
107   /**
108    * Returns project if project node is selected (in project view)
109    *
110    * @deprecated use {@link PlatformDataKeys#PROJECT_CONTEXT} instead
111    */
112   String PROJECT_CONTEXT = PlatformDataKeys.PROJECT_CONTEXT.getName();
113
114   /**
115    * Returns module if module node is selected (in module view)
116    *
117    * @deprecated use {@link com.intellij.openapi.actionSystem.LangDataKeys#MODULE_CONTEXT} instead
118    */
119   @NonNls String MODULE_CONTEXT = "context.Module";
120
121   /**
122    * @deprecated use {@link com.intellij.openapi.actionSystem.LangDataKeys#MODULE_CONTEXT_ARRAY} instead
123    */
124   @NonNls String MODULE_CONTEXT_ARRAY = "context.Module.Array";
125
126   /**
127    * Returns {@link com.intellij.pom.Navigatable}
128    *
129    * @deprecated use {@link PlatformDataKeys#NAVIGATABLE} instead
130    */
131   String NAVIGATABLE = CommonDataKeys.NAVIGATABLE.getName();
132
133   /**
134    * Returns an array of {@link com.intellij.pom.Navigatable}
135    *
136    * @deprecated use {@link PlatformDataKeys#NAVIGATABLE_ARRAY} instead
137    */
138   String NAVIGATABLE_ARRAY = CommonDataKeys.NAVIGATABLE_ARRAY.getName();
139
140   /**
141    * Returns {@link com.intellij.ide.ExporterToTextFile}
142    *
143    * @deprecated use {@link PlatformDataKeys#EXPORTER_TO_TEXT_FILE} instead
144    */
145   String EXPORTER_TO_TEXT_FILE = PlatformDataKeys.EXPORTER_TO_TEXT_FILE.getName();
146
147   /**
148    * Returns {@link com.intellij.psi.PsiElement}
149    *
150    * @deprecated use {@link CommonDataKeys#PSI_ELEMENT} instead
151    */
152   @NonNls String PSI_ELEMENT = "psi.Element";
153
154   /**
155    * Returns {@link com.intellij.psi.PsiFile}
156    *
157    * @deprecated use {@link CommonDataKeys#PSI_FILE} instead
158    */
159   @NonNls String PSI_FILE = "psi.File";
160
161   /**
162    * Returns {@link com.intellij.lang.Language}
163    *
164    * @deprecated use {@link com.intellij.openapi.actionSystem.LangDataKeys#LANGUAGE} instead
165    */
166   @NonNls String LANGUAGE = "Language";
167
168   /**
169    * Returns java.awt.Component currently in focus, DataContext should be retrieved for
170    *
171    * @deprecated use {@link PlatformDataKeys#CONTEXT_COMPONENT} instead
172    */
173   String CONTEXT_COMPONENT = PlatformDataKeys.CONTEXT_COMPONENT.getName();
174
175   /**
176    * Returns {@link com.intellij.ide.IdeView} (one of project, packages, commander or favorites view).
177    *
178    * @since 5.1
179    * @deprecated use {@link com.intellij.openapi.actionSystem.LangDataKeys#IDE_VIEW} instead
180    */
181   @NonNls String IDE_VIEW = "IDEView";
182
183   /**
184    * Returns array of selected {@link com.intellij.openapi.vcs.changes.ChangeList}s.
185    *
186    * @since 6.0
187    * @deprecated use {@link com.intellij.openapi.vcs.VcsDataKeys#CHANGE_LISTS} instead
188    */
189   @NonNls String CHANGE_LISTS = "vcs.ChangeList";
190
191   /**
192    * Returns array of selected {@link com.intellij.openapi.vcs.changes.Change}s.
193    *
194    * @since 6.0
195    * @deprecated use {@link com.intellij.openapi.vcs.VcsDataKeys#CHANGES} instead
196    */
197   @NonNls String CHANGES = "vcs.Change";
198
199   /**
200    * Returns com.intellij.psi.PsiElement[]
201    *
202    * @deprecated use {@link com.intellij.openapi.actionSystem.LangDataKeys#PSI_ELEMENT_ARRAY} instead
203    */
204   @NonNls String PSI_ELEMENT_ARRAY = "psi.Element.array";
205
206   /**
207    * Returns com.intellij.ide.CopyProvider
208    *
209    * @deprecated use {@link PlatformDataKeys#COPY_PROVIDER} instead
210    */
211   String COPY_PROVIDER = PlatformDataKeys.COPY_PROVIDER.getName();
212
213   /**
214    * Returns com.intellij.ide.CutProvider
215    *
216    * @deprecated use {@link PlatformDataKeys#CUT_PROVIDER} instead
217    */
218   String CUT_PROVIDER = PlatformDataKeys.CUT_PROVIDER.getName();
219
220   /**
221    * Returns com.intellij.ide.PasteProvider
222    *
223    * @deprecated use {@link PlatformDataKeys#PASTE_PROVIDER} instead
224    */
225   String PASTE_PROVIDER = PlatformDataKeys.PASTE_PROVIDER.getName();
226
227   /**
228    * Returns com.intellij.ide.DeleteProvider
229    *
230    * @deprecated use {@link PlatformDataKeys#DELETE_ELEMENT_PROVIDER} instead
231    */
232   String DELETE_ELEMENT_PROVIDER = PlatformDataKeys.DELETE_ELEMENT_PROVIDER.getName();
233
234   /**
235    * Returns com.intellij.openapi.editor.Editor even if focuses currently is in find bar
236    *
237    * @deprecated use {@link PlatformDataKeys#EDITOR} instead
238    */
239   String EDITOR_EVEN_IF_INACTIVE = CommonDataKeys.EDITOR_EVEN_IF_INACTIVE.getName();
240
241   /**
242    * @deprecated use {@link PlatformDataKeys#SELECTED_ITEM} instead
243    */
244   String SELECTED_ITEM = PlatformDataKeys.SELECTED_ITEM.getName();
245
246   /**
247    * @deprecated use {@link PlatformDataKeys#DOMINANT_HINT_AREA_RECTANGLE} instead
248    */
249   String DOMINANT_HINT_AREA_RECTANGLE = PlatformDataKeys.DOMINANT_HINT_AREA_RECTANGLE.getName();
250 }