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