Java > Open Source Codes > org > eclipse > ui > texteditor > ITextEditorActionConstants


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.actions.ActionFactory;
21
22
23 /**
24  * Defines the names of those actions which are pre-registered with the
25  * <code>AbstractTextEditor</code>. <code>RULER_DOUBLE_CLICK</code> defines
26  * the action which is registered as being executed when the editor's
27  * ruler has been double clicked. This interface extends the set of names
28  * available from <code>IWorkbenchActionConstants</code>. It also defines the
29  * names of the menu groups in a text editor's context menu.
30  */
31 public interface ITextEditorActionConstants extends IWorkbenchActionConstants {
32
33     /**
34      * Context menu group for undo/redo related actions.
35      * Value: <code>"group.undo"</code>
36      */
37     String GROUP_UNDO= "group.undo"; //$NON-NLS-1$
38
39     /**
40      * Context menu group for copy/paste related actions.
41      * Value: <code>"group.copy"</code>
42      */
43     String GROUP_COPY= "group.copy"; //$NON-NLS-1$
44
45     /**
46      * Context menu group for text manipulation actions.
47      * Value: <code>"group.edit"</code>
48      */
49     String GROUP_EDIT= "group.edit"; //$NON-NLS-1$
50
51     /**
52      * Context menu group for print related actions.
53      * Value: <code>"group.print"</code>
54      */
55     String GROUP_PRINT= "group.print"; //$NON-NLS-1$
56
57     /**
58      * Context menu group for find/replace related actions.
59      * Value: <code>"group.find"</code>
60      */
61     String GROUP_FIND= "group.find"; //$NON-NLS-1$
62
63     /**
64      * Context menu group for save related actions.
65      * Value: <code>"group.save"</code>
66      */
67     String GROUP_SAVE= "group.save"; //$NON-NLS-1$
68
69     /**
70      * Context menu group for actions which do not fit in one of the other categories.
71      * Value: <code>"group.rest"</code>
72      */
73     String GROUP_REST= "group.rest"; //$NON-NLS-1$
74
75     /**
76      * Menu group for open actions.
77      * Value <code>"group.open"</code>
78      * @since 3.1
79      */
80     String GROUP_OPEN= "group.open"; //$NON-NLS-1$
81
82     /**
83      * Menu group for code generation and content assist actions.
84      * Value <code>"group.generate"</code>).
85      * @since 3.1
86      */
87     String GROUP_GENERATE= "group.generate"; //$NON-NLS-1$
88
89     /**
90      * Name of the action for shifting text blocks to the right.
91      * Value: <code>"ShiftRight"</code>
92      */
93     String SHIFT_RIGHT= "ShiftRight"; //$NON-NLS-1$
94
95     /**
96      * Name of the action for shifting text blocks to the right, triggered by the TAB key.
97      * Value: <code>"ShiftRightTab"</code>
98      * @since 3.0
99      */
100     String SHIFT_RIGHT_TAB= "ShiftRightTab"; //$NON-NLS-1$
101
102     /**
103      * Name of the action for shifting text blocks to the left.
104      * Value: <code>"ShiftLeft"</code>
105      */
106     String SHIFT_LEFT= "ShiftLeft"; //$NON-NLS-1$
107
108     /**
109      * Name of the action to delete the current line.
110      * Value: <code>"DeleteLine"</code>
111      * @since 2.0
112      */
113     String DELETE_LINE= "DeleteLine"; //$NON-NLS-1$
114
115     /**
116      * Name of the action to join the current lines.
117      * Value: <code>"JoinLine"</code>
118      * @since 3.3
119      */
120     String JOIN_LINES= "JoinLines"; //$NON-NLS-1$
121
122     /**
123      * Name of the action to cut the current line.
124      * Value: <code>"CutLine"</code>
125      * @since 2.1
126      */
127     String CUT_LINE= "CutLine"; //$NON-NLS-1$
128
129     /**
130      * Name of the action to delete line to beginning.
131      * Value: <code>"DeleteLineToBeginning"</code>
132      * @since 2.0
133      */
134     String DELETE_LINE_TO_BEGINNING= "DeleteLineToBeginning"; //$NON-NLS-1$
135
136     /**
137      * Name of the action to cut line to beginning.
138      * Value: <code>"CutLineToBeginning"</code>
139      * @since 2.1
140      */
141     String CUT_LINE_TO_BEGINNING= "CutLineToBeginning"; //$NON-NLS-1$
142
143     /**
144      * Name of the action to delete line to end.
145      * Value: <code>"DeleteLineToEnd"</code>
146      * @since 2.0
147      */
148     String DELETE_LINE_TO_END= "DeleteLineToEnd"; //$NON-NLS-1$
149
150     /**
151      * Name of the action to cut line to end.
152      * Value: <code>"CutLineToEnd"</code>
153      * @since 2.1
154      */
155     String CUT_LINE_TO_END= "CutLineToEnd"; //$NON-NLS-1$
156
157     /**
158      * Name of the action to set the mark.
159      * Value: <code>"SetMark"</code>
160      * @since 2.0
161      */
162     String SET_MARK= "SetMark"; //$NON-NLS-1$
163
164     /**
165      * Name of the action to set the mark.
166      * Value: <code>"ClearMark"</code>
167      * @since 2.0
168      */
169     String CLEAR_MARK= "ClearMark"; //$NON-NLS-1$
170
171     /**
172      * Name of the action to swap the mark with the cursor position.
173      * Value: <code>"SwapMark"</code>
174      * @since 2.0
175      */
176     String SWAP_MARK= "SwapMark"; //$NON-NLS-1$
177
178     /**
179      * Name of the action to jump to a certain text line.
180      * Value: <code>"GotoLine"</code>
181      */
182     String GOTO_LINE= "GotoLine"; //$NON-NLS-1$
183
184     /**
185      * Name of the action to insert a new line below the current position.
186      * Value: <code>"SmartEnter"</code>
187      * @since 3.0
188      */
189     String SMART_ENTER= "SmartEnter"; //$NON-NLS-1$
190
191     /**
192      * Name of the action to insert a new line above the current position.
193      * Value: <code>"SmartEnterInverse"</code>
194      * @since 3.0
195      */
196     String SMART_ENTER_INVERSE= "SmartEnterInverse"; //$NON-NLS-1$
197
198     /**
199      * Name of the action to move lines upwards
200      * Value: <code>"MoveLineUp"</code>
201      * @since 3.0
202      */
203     String MOVE_LINE_UP= "MoveLineUp"; //$NON-NLS-1$
204
205     /**
206      * Name of the action to move lines downwards
207      * Value: <code>"MoveLineDown"</code>
208      * @since 3.0
209      */
210     String MOVE_LINE_DOWN= "MoveLineDown"; //$NON-NLS-1$
211
212     /**
213      * Name of the action to copy lines upwards
214      * Value: <code>"CopyLineUp"</code>
215      * @since 3.0
216      */
217     String COPY_LINE_UP= "CopyLineUp"; //$NON-NLS-1$;
218
219     /**
220      * Name of the action to copy lines downwards
221      * Value: <code>"CopyLineDown"</code>
222      * @since 3.0
223      */
224     String COPY_LINE_DOWN= "CopyLineDown"; //$NON-NLS-1$;
225
226     /**
227      * Name of the action to turn a selection to upper case
228      * Value: <code>"UpperCase"</code>
229      * @since 3.0
230      */
231     String UPPER_CASE= "UpperCase"; //$NON-NLS-1$
232
233     /**
234      * Name of the action to turn a selection to lower case
235      * Value: <code>"LowerCase"</code>
236      * @since 3.0
237      */
238     String LOWER_CASE= "LowerCase"; //$NON-NLS-1$
239
240     /**
241      * Name of the action to find next.
242      * Value: <code>"FindNext"</code>
243      * @since 2.0
244      */
245     String FIND_NEXT= "FindNext"; //$NON-NLS-1$
246
247     /**
248      * Name of the action to find previous.
249      * Value: <code>"FindPrevious"</code>
250      * @since 2.0
251      */
252     String FIND_PREVIOUS= "FindPrevious"; //$NON-NLS-1$
253
254     /**
255      * Name of the action to incremental find.
256      * Value: <code>"FindIncremental"</code>
257      * @since 2.0
258      */
259     String FIND_INCREMENTAL= "FindIncremental"; //$NON-NLS-1$
260 /**
261      * Name of the action to incremental find reverse.
262      * Value: <code>"FindIncrementalReverse"</code>
263      * @since 2.1
264      */
265     String FIND_INCREMENTAL_REVERSE= "FindIncrementalReverse"; //$NON-NLS-1$
266
267     /**
268      * Name of the action to convert line delimiters to Windows.
269      * Value: <code>"ConvertLineDelimitersToWindows"</code>
270      * @since 2.0
271      * @deprecated since 3.1. No longer supported as editor actions.
272      */
273     String CONVERT_LINE_DELIMITERS_TO_WINDOWS= "ConvertLineDelimitersToWindows"; //$NON-NLS-1$
274
275     /**
276      * Name of the action to convert line delimiters to UNIX.
277      * Value: <code>"ConvertLineDelimitersToUNIX"</code>
278      * @since 2.0
279      * @deprecated since 3.1. No longer supported as editor actions.
280      */
281     String CONVERT_LINE_DELIMITERS_TO_UNIX= "ConvertLineDelimitersToUNIX"; //$NON-NLS-1$
282
283     /**
284      * Name of the action to convert line delimiters to MAC.
285      * Value: <code>"ConvertLineDelimitersToMAC"</code>
286      * @since 2.0
287      * @deprecated since 3.1. No longer supported as editor actions.
288      */
289     String CONVERT_LINE_DELIMITERS_TO_MAC= "ConvertLineDelimitersToMAC"; //$NON-NLS-1$
290
291     /**
292      * Name of the change encoding action.
293      * Value: <code>"ChangeEncoding"</code>
294      * @since 3.1
295      */
296     String CHANGE_ENCODING= "ChangeEncoding"; //$NON-NLS-1$
297
298     /**
299      * Name of the ruler action performed when double clicking the editor's vertical ruler.
300      * Value: <code>"RulerDoubleClick"</code>
301      */
302     String RULER_DOUBLE_CLICK= "RulerDoubleClick"; //$NON-NLS-1$
303
304     /**
305      * Name of the ruler action performed when clicking the editor's vertical ruler.
306      * Value: <code>"RulerClick"</code>
307      * @since 2.0
308      */
309     String RULER_CLICK= "RulerClick"; //$NON-NLS-1$
310
311     /**
312      * Name of the ruler action to manage tasks.
313      * Value: <code>"ManageTasks"</code>
314      */
315     String RULER_MANAGE_TASKS= "ManageTasks"; //$NON-NLS-1$
316
317     /**
318      * Name of the ruler action to manage bookmarks.
319      * Value: <code>"ManageBookmarks"</code>
320      */
321     String RULER_MANAGE_BOOKMARKS= "ManageBookmarks"; //$NON-NLS-1$
322
323
324     /**
325      * Status line category "input position".
326      * Value: <code>"InputPosition"</code>
327      * @since 2.0
328      */
329     String STATUS_CATEGORY_INPUT_POSITION= "InputPosition"; //$NON-NLS-1$
330
331     /**
332      * Status line category "input mode".
333      * Value: <code>"InputMode"</code>
334      * @since 2.0
335      */
336     String STATUS_CATEGORY_INPUT_MODE= "InputMode"; //$NON-NLS-1$
337
338     /**
339      * Status line category "element state".
340      * Value: <code>"ElementState"</code>
341      * @since 2.0
342      */
343     String STATUS_CATEGORY_ELEMENT_STATE= "ElementState"; //$NON-NLS-1$
344
345     /**
346      * Status line category "findField".
347      * Value: <code>"findField"</code>
348      * @since 3.0
349      */
350     String STATUS_CATEGORY_FIND_FIELD= "findField"; //$NON-NLS-1$
351
352     /**
353      * Name of standard Copy global action in the Edit menu.
354      * Value <code>"copy"</code>
355      * @since 3.0
356      * @see org.eclipse.ui.actions.ActionFactory#COPY
357      */
358     String COPY= ActionFactory.COPY.getId();
359
360     /**
361      * Name of standard Cut global action in the Edit menu.
362      * Value <code>"cut"</code>
363      * @since 3.0
364      * @see org.eclipse.ui.actions.ActionFactory#CUT
365      */
366     String CUT= ActionFactory.CUT.getId();
367
368     /**
369      * Name of standard Delete global action in the Edit menu.
370      * Value <code>"delete"</code>
371      * @since 3.0
372      * @see org.eclipse.ui.actions.ActionFactory#DELETE
373      */
374     String DELETE= ActionFactory.DELETE.getId();
375
376     /**
377      * Name of standard Find global action in the Edit menu.
378      * Value <code>"find"</code>
379      * @since 3.0
380      * @see org.eclipse.ui.actions.ActionFactory#FIND
381      */
382     String FIND= ActionFactory.FIND.getId();
383
384     /**
385      * Name of standard Paste global action in the Edit menu.
386      * Value <code>"paste"</code>
387      * @since 3.0
388      * @see org.eclipse.ui.actions.ActionFactory#PASTE
389      */
390     String PASTE= ActionFactory.PASTE.getId();
391
392     /**
393      * Name of standard Print global action in the File menu.
394      * Value <code>"print"</code>
395      * @since 3.0
396      * @see org.eclipse.ui.actions.ActionFactory#PRINT
397      */
398     String PRINT= ActionFactory.PRINT.getId();
399
400     /**
401      * Name of standard Properties global action in the File menu.
402      * Value <code>"properties"</code>
403      * @since 3.1
404      * @see org.eclipse.ui.actions.ActionFactory#PROPERTIES
405      */
406     String PROPERTIES= ActionFactory.PROPERTIES.getId();
407
408     /**
409      * Name of standard Redo global action in the Edit menu.
410      * Value <code>"redo"</code>
411      * @since 3.0
412      * @see org.eclipse.ui.actions.ActionFactory#REDO
413      */
414     String REDO= ActionFactory.REDO.getId();
415
416     /**
417      * Name of standard Undo global action in the Edit menu.
418      * Value <code>"undo"</code>
419      * @since 3.0
420      * @see org.eclipse.ui.actions.ActionFactory#UNDO
421      */
422     String UNDO= ActionFactory.UNDO.getId();
423
424     /**
425      * Name of standard Save global action in the File menu.
426      * Value <code>"save"</code>
427      * @since 3.0
428      * @see org.eclipse.ui.actions.ActionFactory#SAVE
429      */
430     String SAVE= ActionFactory.SAVE.getId();
431
432     /**
433      * Name of standard Select All global action in the Edit menu.
434      * Value <code>"selectAll"</code>
435      * @since 3.0
436      * @see org.eclipse.ui.actions.ActionFactory#SELECT_ALL
437      */
438     String SELECT_ALL= ActionFactory.SELECT_ALL.getId();
439
440     /**
441      * Name of standard Revert global action in the File menu.
442      * Value <code>"revert"</code>
443      * @since 3.0
444      * @see org.eclipse.ui.actions.ActionFactory#REVERT
445      */
446     String REVERT= ActionFactory.REVERT.getId();
447     
448     /**
449      * Name of standard Next global action in the Navigate menu.
450      * Value <code>"next"</code>
451      * @since 3.2
452      * @see org.eclipse.ui.actions.ActionFactory#NEXT
453      */
454     String NEXT= ActionFactory.NEXT.getId();
455     
456     /**
457      * Name of standard Previous global action in the Navigate menu.
458      * Value <code>"previous"</code>
459      * @since 3.2
460      * @see org.eclipse.ui.actions.ActionFactory#PREVIOUS
461      */
462     String PREVIOUS= ActionFactory.PREVIOUS.getId();
463
464     /**
465      * Name of the action for re-establishing the state after the
466      * most recent save operation.
467      * Value: <code>"ITextEditorActionConstants.REVERT"</code>
468      */
469     String REVERT_TO_SAVED= REVERT;
470
471     /**
472      * Name of the action for toggling the smart insert mode.
473      * Value: <code>"ToggleInsertMode"</code>
474      * @since 3.0
475      */
476     String TOGGLE_INSERT_MODE= "TOGGLE_INSERT_MODE"; //$NON-NLS-1$
477
478     /**
479      * Context menu group for preference related actions.
480      * Value: <code>"settings"</code>
481      * @since 3.1
482      */
483     String GROUP_SETTINGS= "settings"; //$NON-NLS-1$
484
485     /**
486      * Context menu group for ruler column related actions.
487      * Value: <code>"rulers"</code>
488      * @since 3.1
489      */
490     String GROUP_RULERS= "rulers"; //$NON-NLS-1$
491
492     /**
493      * Context menu group for quick diff revert related actions.
494      * Value: <code>"restore"</code>
495      * @since 3.1
496      */
497     String GROUP_RESTORE= "restore"; //$NON-NLS-1$
498
499     /**
500      * Context menu group for actions that display additional information. Value:
501      * <code>"group.information"</code>.
502      * @since 3.2
503      */
504     String GROUP_INFORMATION= "group.information"; //$NON-NLS-1$
505
506     /**
507      * Context menu group for typing aid actions such as content assist. Value:
508      * <code>"group.assist"</code>.
509      * @since 3.2
510      */
511     String GROUP_ASSIST= "group.assist"; //$NON-NLS-1$
512
513     /**
514      * Name of the action for showing the preferences from the editor context
515      * menu. Value: <code>"Preferences.ContextAction"</code>
516      * @since 3.1
517      */
518     String CONTEXT_PREFERENCES= "Preferences.ContextAction"; //$NON-NLS-1$
519
520     /**
521      * Name of the action for showing the preferences from the editor ruler
522      * context menu. Value: <code>"Preferences.RulerAction"</code>
523      * @since 3.1
524      */
525     String RULER_PREFERENCES= "Preferences.RulerAction"; //$NON-NLS-1$
526
527     /**
528      * Name of the action for toggling line number display.
529      * Value: <code>"Linenumbers.Toggle"</code>
530      * @since 3.1
531      */
532     String LINENUMBERS_TOGGLE= "Linenumbers.Toggle"; //$NON-NLS-1$
533
534     /**
535      * Name of the action for reverting deleted lines at the current selection.
536      * Value: <code>"QuickDiff.RevertDeletion"</code>
537      * @since 3.1
538      */
539     String QUICKDIFF_REVERTDELETION= "QuickDiff.RevertDeletion"; //$NON-NLS-1$
540
541     /**
542      * Name of the action for reverting the line at the current selection.
543      * Value: <code>"QuickDiff.RevertLine"</code>
544      * @since 3.1
545      */
546     String QUICKDIFF_REVERTLINE= "QuickDiff.RevertLine"; //$NON-NLS-1$
547
548     /**
549      * Name of the action for reverting the selection or the block at the
550      * current selection. Value: <code>"QuickDiff.Revert"</code>
551      * @since 3.1
552      */
553     String QUICKDIFF_REVERT= "QuickDiff.Revert"; //$NON-NLS-1$
554
555     /**
556      * Name of the action for reverting the block at the current selection.
557      * Value: <code>"QuickDiff.RevertBlock"</code>
558      * @since 3.1
559      */
560     String QUICKDIFF_REVERTBLOCK= "QuickDiff.RevertBlock"; //$NON-NLS-1$
561
562     /**
563      * Name of the action for reverting the current selection.
564      * Value: <code>"QuickDiff.RevertBlock"</code>
565      * @since 3.1
566      */
567     String QUICKDIFF_REVERTSELECTION= "QuickDiff.RevertSelection"; //$NON-NLS-1$
568
569     /**
570      * Name of the action for toggling quick diff display.
571      * Value: <code>"QuickDiff.Toggle"</code>
572      * @since 3.1
573      */
574     String QUICKDIFF_TOGGLE= "QuickDiff.Toggle"; //$NON-NLS-1$
575
576     /**
577      * Name of the action for emacs style word completion.
578      * Value: <code>"HIPPIE_COMPLETION"</code>
579      * @since 3.1
580      */
581     String HIPPIE_COMPLETION= "HIPPIE_COMPLETION"; //$NON-NLS-1$
582
583     /**
584      * Name of the action for hiding the revision info
585      * Value: <code>"Revision.HideInfo"</code>
586      * @since 3.2
587      */
588     String REVISION_HIDE_INFO= "Revision.HideInfo"; //$NON-NLS-1$
589
590     /**
591      * Name of the quick assist action
592      * Value: <code>"QuickAssist"</code>
593      * @since 3.2
594      */
595     String QUICK_ASSIST= "QuickAssist"; //$NON-NLS-1$
596
597     /**
598      * Name of the action for cycling through the revision rendering modes.
599      * Value: <code>"Revision.Rendering.Cycle"</code>
600      * @since 3.3
601      */
602     String REVISION_RENDERING_CYCLE= "Revision.Rendering.Cycle"; //$NON-NLS-1$
603
604     /**
605      * Name of the action for toggling the display of the revision author.
606      * Value: <code>"Revision.ShowAuthor.Toggle"</code>
607      * @since 3.3
608      */
609     String REVISION_SHOW_AUTHOR_TOGGLE= "Revision.ShowAuthor.Toggle"; //$NON-NLS-1$
610
611     /**
612      * Name of the action for toggling the display of the revision id.
613      * Value: <code>"Revision.ShowId.Toggle"</code>
614      * @since 3.3
615      */
616     String REVISION_SHOW_ID_TOGGLE= "Revision.ShowId.Toggle"; //$NON-NLS-1$
617 /**
618      * Name of the action for emacs recenter.
619      * Value: <code>"RECENTER"</code>
620      * @since 3.3
621      */
622     String RECENTER= "Recenter"; //$NON-NLS-1$
623
624     /**
625      * Name of the action for toggling the display of whitespace characters.
626      * Value: <code>"ShowWhitespaceCharacters"</code>
627      * @since 3.3
628      */
629     String SHOW_WHITESPACE_CHARACTERS= "ShowWhitespaceCharacters"; //$NON-NLS-1$
630
631     /**
632      * Name of the action displaying information for the
633      * current caret location in a sticky hover.
634      *
635      * Value: <code>"ShowInformation"</code>
636      * @see IInformationProvider
637      * @since 3.3
638      */
639     String SHOW_INFORMATION= "ShowInformation"; //$NON-NLS-1$
640 }
641

A to Z: JavaDoc & Examples

---

Daily Java News & Articles

---

Open Source Projects

---

Open Source Codes

---

Free Computer Books

---

Remove Frame

---

Popular Tags