IAbstractTextEditorHelpContextIds


1   /*******************************************************************************
2    * Copyright (c) 2000, 2007 IBM Corporation and others.
3    * All rights reserved. This program and the accompanying materials
4    * are made available under the terms of the Eclipse Public License v1.0
5    * which accompanies this distribution, and is available at
6    * http://www.eclipse.org/legal/epl-v10.html
7    *
8    * Contributors:
9    *     IBM Corporation - initial API and implementation
10   *     Genady Beryozkin, me@genady.org - https://bugs.eclipse.org/bugs/show_bug.cgi?id=11668
11   *     Benjamin Muskalla <b.muskalla@gmx.net> - https://bugs.eclipse.org/bugs/show_bug.cgi?id=41573
12   *******************************************************************************/
13  
14  package org.eclipse.ui.texteditor;
15  
16  
17  import org.eclipse.jface.text.information.IInformationProvider;
18  
19  import org.eclipse.ui.IWorkbenchActionConstants;
20  import org.eclipse.ui.PlatformUI;
21  
22  
23  /**
24   * Help context ids for the text editor.
25   * <p>
26   * This interface contains constants only; it is not intended to be implemented.
27   * </p>
28   */
29  public interface IAbstractTextEditorHelpContextIds {
30  
31      /**
32       * The string with which all other defined ids are prefixed to construct help context ids.
33       * Value: <code>"org.eclipse.ui."</code>
34       */
35      String   PREFIX= PlatformUI.PLUGIN_ID + "."; //$NON-NLS-1$
36  
37      /**
38       * The string which is appended to action ids to construct help context ids.
39       * Value: <code>"_action_context"</code>
40       */
41      String   ACTION_POSTFIX= "_action_context"; //$NON-NLS-1$
42  
43      /**
44       * Help context id for the action.
45       * Value: <code>"org.eclipse.ui.undo_action_context"</code>
46       */
47      String   UNDO_ACTION= PREFIX + ITextEditorActionConstants.UNDO + ACTION_POSTFIX;
48  
49      /**
50       * Help context id for the action.
51       * Value: <code>"org.eclipse.ui.redo_action_context"</code>
52       */
53      String   REDO_ACTION= PREFIX + ITextEditorActionConstants.REDO + ACTION_POSTFIX;
54  
55      /**
56       * Help context id for the action.
57       * Value: <code>"org.eclipse.ui.cut_action_context"</code>
58       */
59      String   CUT_ACTION= PREFIX + ITextEditorActionConstants.CUT + ACTION_POSTFIX;
60  
61      /**
62       * Help context id for the action.
63       * Value: <code>"org.eclipse.ui.copy_action_context"</code>
64       */
65      String   COPY_ACTION= PREFIX + ITextEditorActionConstants.COPY + ACTION_POSTFIX;
66  
67      /**
68       * Help context id for the action.
69       * Value: <code>"org.eclipse.ui.paste_action_context"</code>
70       */
71      String   PASTE_ACTION= PREFIX + ITextEditorActionConstants.PASTE + ACTION_POSTFIX;
72  
73      /**
74       * Help context id for the action.
75       * Value: <code>"org.eclipse.ui.delete_action_context"</code>
76       */
77      String   DELETE_ACTION= PREFIX + ITextEditorActionConstants.DELETE + ACTION_POSTFIX;
78  
79      /**
80       * Help context id for the action.
81       * Value: <code>"org.eclipse.ui.DeleteLine_action_context"</code>
82       * @since 2.0
83       */
84      String   DELETE_LINE_ACTION= PREFIX + ITextEditorActionConstants.DELETE_LINE + ACTION_POSTFIX;
85  
86      /**
87       * Help context id for the action.
88       * Value: <code>"org.eclipse.ui.JoinLines_action_context"</code>
89       * @since 3.3
90       */
91      String   JOIN_LINES_ACTION = PREFIX + ITextEditorActionConstants.JOIN_LINES + ACTION_POSTFIX;
92  
93      /**
94       * Help context id for the action.
95       * Value: <code>"org.eclipse.ui.CutLine_action_context"</code>
96       * @since 2.1
97       */
98      String   CUT_LINE_ACTION= PREFIX + ITextEditorActionConstants.CUT_LINE + ACTION_POSTFIX;
99  
100     /**
101      * Help context id for the action.
102      * Value: <code>"org.eclipse.ui.DeleteLineToBeginning_action_context"</code>
103      * @since 2.0
104      */
105     String   DELETE_LINE_TO_BEGINNING_ACTION= PREFIX + ITextEditorActionConstants.DELETE_LINE_TO_BEGINNING + ACTION_POSTFIX;
106 
107     /**
108      * Help context id for the action.
109      * Value: <code>"org.eclipse.ui.CutLineToBeginning_action_context"</code>
110      * @since 2.1
111      */
112     String   CUT_LINE_TO_BEGINNING_ACTION= PREFIX + ITextEditorActionConstants.CUT_LINE_TO_BEGINNING + ACTION_POSTFIX;
113 
114     /**
115      * Help context id for the action.
116      * Value: <code>"org.eclipse.ui.DeleteLineToEnd_action_context"</code>
117      * @since 2.0
118      */
119     String   DELETE_LINE_TO_END_ACTION= PREFIX + ITextEditorActionConstants.DELETE_LINE_TO_END + ACTION_POSTFIX;
120 
121     /**
122      * Help context id for the action.
123      * Value: <code>"org.eclipse.ui.CutLineToEnd_action_context"</code>
124      * @since 2.1
125      */
126     String   CUT_LINE_TO_END_ACTION= PREFIX + ITextEditorActionConstants.CUT_LINE_TO_END + ACTION_POSTFIX;
127 
128     /**
129      * Help context id for the action.
130      * Value: <code>"org.eclipse.ui.SetMark_action_context"</code>
131      * @since 2.0
132      */
133     String   SET_MARK_ACTION= PREFIX + ITextEditorActionConstants.SET_MARK + ACTION_POSTFIX;
134 
135     /**
136      * Help context id for the action.
137      * Value: <code>"org.eclipse.ui.ClearMark_action_context"</code>
138      * @since 2.0
139      */
140     String   CLEAR_MARK_ACTION= PREFIX + ITextEditorActionConstants.CLEAR_MARK + ACTION_POSTFIX;
141 
142     /**
143      * Help context id for the action.
144      * Value: <code>"org.eclipse.ui.SwapMark_action_context"</code>
145      * @since 2.0
146      */
147     String   SWAP_MARK_ACTION= PREFIX + ITextEditorActionConstants.SWAP_MARK + ACTION_POSTFIX;
148 
149     /**
150      * Help context id for the action.
151      * Value: <code>"org.eclipse.ui.selectAll_action_context"</code>
152      */
153     String   SELECT_ALL_ACTION= PREFIX + ITextEditorActionConstants.SELECT_ALL + ACTION_POSTFIX;
154 
155     /**
156      * Help context id for the action.
157      * Value: <code>"org.eclipse.ui.ShiftRight_action_context"</code>
158      */
159     String   SHIFT_RIGHT_ACTION= PREFIX + ITextEditorActionConstants.SHIFT_RIGHT + ACTION_POSTFIX;
160 
161     /**
162      * Help context id for the action.
163      * Value: <code>"org.eclipse.ui.ShiftLeft_action_context"</code>
164      */
165     String   SHIFT_LEFT_ACTION= PREFIX + ITextEditorActionConstants.SHIFT_LEFT + ACTION_POSTFIX;
166 
167     /**
168      * Help context id for the action.
169      * Value: <code>"org.eclipse.ui.find_action_context"</code>
170      */
171     String   FIND_ACTION= PREFIX + ITextEditorActionConstants.FIND + ACTION_POSTFIX;
172 
173     /**
174      * Help context id for the action.
175      * Value: <code>"org.eclipse.ui.FindNext_action_context"</code>
176      * @since 2.0
177      */
178     String   FIND_NEXT_ACTION= PREFIX + ITextEditorActionConstants.FIND_NEXT + ACTION_POSTFIX;
179 
180     /**
181      * Help context id for the action.
182      * Value: <code>"org.eclipse.ui.FindPrevious_action_context"</code>
183      * @since 2.0
184      */
185     String   FIND_PREVIOUS_ACTION= PREFIX + ITextEditorActionConstants.FIND_PREVIOUS + ACTION_POSTFIX;
186 
187     /**
188      * Help context id for the action.
189      * Value: <code>"org.eclipse.ui.goto_next_annotation_action_context"</code>
190      * @since 3.2
191      */
192     String   GOTO_NEXT_ANNOTATION_ACTION= PREFIX + "goto_next_annotation" + ACTION_POSTFIX; //$NON-NLS-1$
193     
194     /**
195      * Help context id for the action.
196      * Value: <code>"org.eclipse.ui.goto_previous_annotation_action_context"</code>
197      * @since 3.2
198      */
199     String   GOTO_PREVIOUS_ANNOTATION_ACTION= PREFIX + "goto_previous_annotation" + ACTION_POSTFIX;    //$NON-NLS-1$
200     
201     /**
202      * Help context id for the action.
203      * Value: <code>"org.eclipse.ui.FindIncremental_action_context"</code>
204      * @since 2.0
205      */
206     String   FIND_INCREMENTAL_ACTION= PREFIX + ITextEditorActionConstants.FIND_INCREMENTAL + ACTION_POSTFIX;
207     /**
208      * Help context id for the action.
209      * Value: <code>"org.eclipse.ui.FindIncrementalReverse_action_context"</code>
210      * @since 2.1
211      */
212     String   FIND_INCREMENTAL_REVERSE_ACTION= PREFIX + ITextEditorActionConstants.FIND_INCREMENTAL_REVERSE + ACTION_POSTFIX;
213 
214     /**
215      * Help context id for the action.
216      * Value: <code>"org.eclipse.ui.bookmark_action_context"</code>
217      * @deprecated in 3.0 Use <code>org.eclipse.ui.texteditor.ITextEditorHelpContextIds.BOOKMARK_ACTION</code> instead.
218      */
219     String   BOOKMARK_ACTION= PREFIX + IWorkbenchActionConstants.BOOKMARK + ACTION_POSTFIX;
220 
221     /**
222      * Help context id for the action.
223      * Value: <code>"org.eclipse.ui.addTask_action_context"</code>
224      * @deprecated in 3.0 Use <code>org.eclipse.ui.texteditor.ITextEditorHelpContextIds.ADD_TASK_ACTION</code> instead.
225      */
226     String   ADD_TASK_ACTION= PREFIX + IWorkbenchActionConstants.ADD_TASK + ACTION_POSTFIX;
227 
228     /**
229      * Help context id for the action.
230      * Value: <code>"org.eclipse.ui.save_action_context"</code>
231      */
232     String   SAVE_ACTION= PREFIX + ITextEditorActionConstants.SAVE + ACTION_POSTFIX;
233 
234     /**
235      * Help context id for the action.
236      * Value: <code>"org.eclipse.ui.revert_action_context"</code>
237      */
238     String   REVERT_TO_SAVED_ACTION= PREFIX + ITextEditorActionConstants.REVERT_TO_SAVED + ACTION_POSTFIX;
239 
240     /**
241      * Help context id for the action.
242      * Value: <code>"org.eclipse.ui.GotoLine_action_context"</code>
243      */
244     String   GOTO_LINE_ACTION= PREFIX + ITextEditorActionConstants.GOTO_LINE + ACTION_POSTFIX;
245 
246     /**
247      * Help context id for the action.
248      * Value: <code>"org.eclipse.ui.print_action_context"</code>
249      */
250     String   PRINT_ACTION= PREFIX + ITextEditorActionConstants.PRINT + ACTION_POSTFIX;
251 
252     /**
253      * Help context id for the action.
254      * Value: <code>"org.eclipse.ui.ConvertLineDelimitersToWindows_action_context"</code>
255      * @since 2.0
256      * @deprecated since 3.1. No longer supported as editor actions.
257      */
258     String   CONVERT_LINE_DELIMITERS_TO_WINDOWS= PREFIX + ITextEditorActionConstants.CONVERT_LINE_DELIMITERS_TO_WINDOWS + ACTION_POSTFIX;
259 
260     /**
261      * Help context id for the action.
262      * Value: <code>"org.eclipse.ui.ConvertLineDelimitersToUNIX_action_context"</code>
263      * @since 2.0
264      * @deprecated since 3.1. No longer supported as editor actions.
265      */
266     String   CONVERT_LINE_DELIMITERS_TO_UNIX= PREFIX + ITextEditorActionConstants.CONVERT_LINE_DELIMITERS_TO_UNIX + ACTION_POSTFIX;
267 
268     /**
269      * Help context id for the action.
270      * Value: <code>"org.eclipse.ui.ConvertLineDelimitersToMAC_action_context"</code>
271      * @since 2.0
272      * @deprecated since 3.1 No longer supported as editor actions.
273      */
274     String   CONVERT_LINE_DELIMITERS_TO_MAC= PREFIX + ITextEditorActionConstants.CONVERT_LINE_DELIMITERS_TO_MAC + ACTION_POSTFIX;
275 
276     /**
277      * Help context id for the action.
278      * Value: <code>"org.eclipse.ui.find_replace_dialog_context"</code>
279      */
280     String   FIND_REPLACE_DIALOG= PREFIX + "find_replace_dialog_context"; //$NON-NLS-1$
281 
282     /**
283      * Help context id for the action.
284      * Value: <code>"org.eclipse.ui.goto_last_edit_position_action_context"</code>
285      * @since 2.1
286      */
287     String   GOTO_LAST_EDIT_POSITION_ACTION= PREFIX + "goto_last_edit_position" + ACTION_POSTFIX; //$NON-NLS-1$
288 
289     /**
290      * Help context id for the action.
291      * Value: <code>"org.eclipse.ui.move_lines_action_context"</code>
292      * @since 3.0
293      */
294     String   MOVE_LINES_ACTION= PREFIX + "move_lines" + ACTION_POSTFIX; //$NON-NLS-1$
295 
296     /**
297      * Help context id for the action.
298      * Value: <code>"org.eclipse.ui.copy_lines_action_context"</code>
299      * @since 3.0
300      */
301     String   COPY_LINES_ACTION= PREFIX + "copy_lines" + ACTION_POSTFIX; //$NON-NLS-1$;
302 
303     /**
304      * Help context id for the action.
305      * Value: <code>"org.eclipse.ui.upper_case_action_context"</code>
306      * @since 3.0
307      */
308     String   UPPER_CASE_ACTION= PREFIX + "upper_case" + ACTION_POSTFIX; //$NON-NLS-1$
309 
310     /**
311      * Help context id for the action.
312      * Value: <code>"org.eclipse.ui.lower_case_action_context"</code>
313      * @since 3.0
314      */
315     String   LOWER_CASE_ACTION= PREFIX + "lower_case" + ACTION_POSTFIX; //$NON-NLS-1$
316 
317     /**
318      * Help context id for the action.
319      * Value: <code>"org.eclipse.ui.smart_enter_action_context"</code>
320      * @since 3.0
321      */
322     String   SMART_ENTER_ACTION= PREFIX + "smart_enter" + ACTION_POSTFIX; //$NON-NLS-1$;
323 
324     /**
325      * Help context id for the smart insert mode toggle action.
326      * Value: <code>"org.eclipse.ui.toggle_insert_mode_action_context"</code>
327      * @since 3.0
328      */
329     String   TOGGLE_INSERT_MODE_ACTION= PREFIX + "toggle_insert_mode" + ACTION_POSTFIX; //$NON-NLS-1$;;
330 
331     /**
332      * Help context id for the word completion action.
333      * Value: <code>"org.eclipse.ui.hippie_completion_action_context"</code>
334      * @since 3.1
335      */
336     String   HIPPIE_COMPLETION_ACTION=PREFIX + "hippie_completion" + ACTION_POSTFIX; //$NON-NLS-1$
337     
338     /**
339      * Help context id for the quick assist action.
340      * Value: <code>"org.eclipse.ui.quick_assist_action_context"</code>
341      * @since 3.2
342      */
343     String   QUICK_ASSIST_ACTION=PREFIX + "quick_assist" + ACTION_POSTFIX; //$NON-NLS-1$
344     
345     /**
346      * Help context id for the recenter action.
347      * Value: <code>"org.eclipse.ui.recenter_action_context"</code>
348      * @since 3.3
349      */
350     String   RECENTER_ACTION=PREFIX + "recenter" + ACTION_POSTFIX; //$NON-NLS-1$
351 
352     /**
353      * Help context id for the show whitespace characters action.
354      * Value: <code>"show_whitespace_characters_action_context"</code>
355      * @since 3.3
356      */
357     String   SHOW_WHITESPACE_CHARACTERS_ACTION=PREFIX + "show_whitepsace_characters" + ACTION_POSTFIX; //$NON-NLS-1$
358     
359     /**
360      * Help context id for the action that displays information
361      * for the current caret location in a sticky hover.
362      * Value: <code>"show_information_action_context"</code>
363      * @see IInformationProvider
364      * @since 3.3
365      */
366     String   SHOW_INFORMATION_ACTION=PREFIX + "show_information" + ACTION_POSTFIX; //$NON-NLS-1$
367 }
368
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags