PreferenceConstants


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   *******************************************************************************/
11  package org.eclipse.jdt.ui;
12  
13  import java.util.Locale  ;
14  
15  import org.eclipse.core.runtime.preferences.DefaultScope;
16  import org.eclipse.core.runtime.preferences.InstanceScope;
17  
18  import org.eclipse.core.resources.ProjectScope;
19  
20  import org.eclipse.swt.SWT;
21  import org.eclipse.swt.graphics.RGB;
22  
23  import org.eclipse.jface.action.Action;
24  import org.eclipse.jface.preference.IPreferenceStore;
25  import org.eclipse.jface.preference.PreferenceConverter;
26  import org.eclipse.jface.resource.ColorRegistry;
27  
28  import org.eclipse.ui.PlatformUI;
29  import org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants;
30  import org.eclipse.ui.texteditor.AbstractTextEditor;
31  
32  import org.eclipse.jdt.core.IClasspathEntry;
33  import org.eclipse.jdt.core.IJavaProject;
34  import org.eclipse.jdt.core.JavaCore;
35  
36  import org.eclipse.jdt.internal.corext.fix.CleanUpConstants;
37  
38  import org.eclipse.jdt.ui.text.IJavaColorConstants;
39  
40  import org.eclipse.jdt.internal.ui.IJavaThemeConstants;
41  import org.eclipse.jdt.internal.ui.JavaPlugin;
42  import org.eclipse.jdt.internal.ui.javaeditor.SemanticHighlightings;
43  import org.eclipse.jdt.internal.ui.preferences.NewJavaProjectPreferencePage;
44  import org.eclipse.jdt.internal.ui.preferences.formatter.FormatterProfileManager;
45  import org.eclipse.jdt.internal.ui.text.java.ProposalSorterRegistry;
46  import org.eclipse.jdt.internal.ui.text.spelling.JavaSpellingEngine;
47  import org.eclipse.jdt.internal.ui.text.spelling.SpellCheckEngine;
48  import org.eclipse.jdt.internal.ui.text.spelling.SpellingEngine;
49  
50  /**
51   * Preference constants used in the JDT-UI preference store. Clients should only read the
52   * JDT-UI preference store using these values. Clients are not allowed to modify the 
53   * preference store programmatically.
54   * 
55   * @since 2.0
56    */
57  public class PreferenceConstants {
58  
59      private PreferenceConstants() {
60      }
61      
62      /**
63       * A named preference that controls return type rendering of methods in the UI.
64       * <p>
65       * Value is of type <code>Boolean</code>: if <code>true</code> return types
66       * are rendered
67       * </p>
68       */
69      public static final String   APPEARANCE_METHOD_RETURNTYPE= "org.eclipse.jdt.ui.methodreturntype";//$NON-NLS-1$
70  
71      /**
72       * A named preference that controls type parameter rendering of methods in the UI.
73       * <p>
74       * Value is of type <code>Boolean</code>: if <code>true</code> return types
75       * are rendered
76       * </p>
77       * @since 3.1
78       */
79      public static final String   APPEARANCE_METHOD_TYPEPARAMETERS= "org.eclipse.jdt.ui.methodtypeparametesr";//$NON-NLS-1$
80  
81      /**
82       * A named preference that controls if override indicators are rendered in the UI.
83       * <p>
84       * Value is of type <code>Boolean</code>: if <code>true</code> override 
85       * indicators are rendered
86       * </p>
87       * @deprecated Override Indicator is now controlled on the platform's decorator preference page
88       */
89      public static final String   APPEARANCE_OVERRIDE_INDICATOR= "org.eclipse.jdt.ui.overrideindicator";//$NON-NLS-1$
90  
91      /**
92       * A named preference that controls if quick assist light bulbs are shown.
93       * <p>
94       * Value is of type <code>Boolean</code>: if <code>true</code> light bulbs are shown
95       * for quick assists.
96       * </p>
97       * 
98       * @since 3.0
99       */
100     public static final String   EDITOR_QUICKASSIST_LIGHTBULB="org.eclipse.jdt.quickassist.lightbulb"; //$NON-NLS-1$
101 
102 
103 
104     /**
105      * A named preference that defines the pattern used for package name compression.
106      * <p>
107      * Value is of type <code>String</code>. For example for the given package name 'org.eclipse.jdt' pattern
108      * '.' will compress it to '..jdt', '1~' to 'o~.e~.jdt'.
109      * </p>
110      */ 
111     public static final String   APPEARANCE_PKG_NAME_PATTERN_FOR_PKG_VIEW= "PackagesView.pkgNamePatternForPackagesView";//$NON-NLS-1$
112 
113     /**
114      * A named preference that controls if package name compression is turned on or off.
115      * <p>
116      * Value is of type <code>Boolean</code>.
117      * </p>
118      * 
119      * @see #APPEARANCE_PKG_NAME_PATTERN_FOR_PKG_VIEW
120      */ 
121     public static final String   APPEARANCE_COMPRESS_PACKAGE_NAMES= "org.eclipse.jdt.ui.compresspackagenames";//$NON-NLS-1$
122 
123     /**
124      * A named preference that controls if empty inner packages are folded in
125      * the hierarchical mode of the package explorer.
126      * <p>
127      * Value is of type <code>Boolean</code>: if <code>true</code> empty
128      * inner packages are folded.
129      * </p>
130      * @since 2.1
131      */
132     public static final String   APPEARANCE_FOLD_PACKAGES_IN_PACKAGE_EXPLORER= "org.eclipse.jdt.ui.flatPackagesInPackageExplorer";//$NON-NLS-1$
133 
134     /**
135      * A named preference that defines how member elements are ordered by the
136      * Java views using the <code>JavaElementSorter</code>.
137      * <p>
138      * Value is of type <code>String</code>: A comma separated list of the
139      * following entries. Each entry must be in the list, no duplication. List
140      * order defines the sort order.
141      * <ul>
142      * <li><b>T</b>: Types</li>
143      * <li><b>C</b>: Constructors</li>
144      * <li><b>I</b>: Initializers</li>
145      * <li><b>M</b>: Methods</li>
146      * <li><b>F</b>: Fields</li>
147      * <li><b>SI</b>: Static Initializers</li>
148      * <li><b>SM</b>: Static Methods</li>
149      * <li><b>SF</b>: Static Fields</li>
150      * </ul>
151      * </p>
152      * @since 2.1
153      */
154     public static final String   APPEARANCE_MEMBER_SORT_ORDER= "outlinesortoption"; //$NON-NLS-1$
155 
156     /**
157      * A named preference that defines how member elements are ordered by visibility in the
158      * Java views using the <code>JavaElementSorter</code>.
159      * <p>
160      * Value is of type <code>String</code>: A comma separated list of the
161      * following entries. Each entry must be in the list, no duplication. List
162      * order defines the sort order.
163      * <ul>
164      * <li><b>B</b>: Public</li>
165      * <li><b>V</b>: Private</li>
166      * <li><b>R</b>: Protected</li>
167      * <li><b>D</b>: Default</li>
168      * </ul>
169      * </p>
170      * @since 3.0
171      */
172     public static final String   APPEARANCE_VISIBILITY_SORT_ORDER= "org.eclipse.jdt.ui.visibility.order"; //$NON-NLS-1$
173     
174     /**
175      * A named preferences that controls if Java elements are also sorted by 
176      * visibility.
177      * <p>
178      * Value is of type <code>Boolean</code>.
179      * </p>
180      * @since 3.0
181      */
182     public static final String   APPEARANCE_ENABLE_VISIBILITY_SORT_ORDER= "org.eclipse.jdt.ui.enable.visibility.order"; //$NON-NLS-1$
183 
184     /**
185      * A named preference that controls category rendering of Java elements in the UI.
186      * <p>
187      * Value is of type <code>Boolean</code>: if <code>true</code> category is rendered
188      * </p>
189      * @since 3.2
190      */
191     public static final String   APPEARANCE_CATEGORY= "org.eclipse.jdt.ui.category";//$NON-NLS-1$
192 
193     /**
194      * The symbolic font name for the font used to display Javadoc 
195      * (value <code>"org.eclipse.jdt.ui.javadocfont"</code>).
196      * 
197      * @since 3.3
198      */
199     public final static String   APPEARANCE_JAVADOC_FONT= "org.eclipse.jdt.ui.javadocfont"; //$NON-NLS-1$
200 
201     /**
202      * A named preference that controls if prefix removal during setter/getter generation is turned on or off. 
203      * <p>
204      * Value is of type <code>Boolean</code>.
205      * </p>
206      * @deprecated Use JavaCore preference store (key JavaCore.
207      * CODEASSIST_FIELD_PREFIXES and CODEASSIST_STATIC_FIELD_PREFIXES)
208      */ 
209     public static final String   CODEGEN_USE_GETTERSETTER_PREFIX= "org.eclipse.jdt.ui.gettersetter.prefix.enable";//$NON-NLS-1$
210 
211     /**
212      * A named preference that holds a list of prefixes to be removed from a local variable to compute setter 
213      * and getter names.
214      * <p>
215      * Value is of type <code>String</code>: comma separated list of prefixed
216      * </p>
217      * 
218      * @deprecated Use JavaCore preference store (key JavaCore.
219      * CODEASSIST_FIELD_PREFIXES and CODEASSIST_STATIC_FIELD_PREFIXES)
220      */ 
221     public static final String   CODEGEN_GETTERSETTER_PREFIX= "org.eclipse.jdt.ui.gettersetter.prefix.list";//$NON-NLS-1$
222 
223     /**
224      * A named preference that controls if suffix removal during setter/getter generation is turned on or off.
225      * <p>
226      * Value is of type <code>Boolean</code>.
227      * </p>
228      * @deprecated Use JavaCore preference store (key JavaCore.
229      * CODEASSIST_FIELD_PREFIXES and CODEASSIST_STATIC_FIELD_PREFIXES)
230      */ 
231     public static final String   CODEGEN_USE_GETTERSETTER_SUFFIX= "org.eclipse.jdt.ui.gettersetter.suffix.enable";//$NON-NLS-1$
232 
233     /**
234      * A named preference that holds a list of suffixes to be removed from a local variable to compute setter 
235      * and getter names.
236      * <p>
237      * Value is of type <code>String</code>: comma separated list of suffixes
238      * </p>
239      * @deprecated Use setting from JavaCore preference store (key JavaCore.
240      * CODEASSIST_FIELD_SUFFIXES and CODEASSIST_STATIC_FIELD_SUFFIXES)
241      */ 
242     public static final String   CODEGEN_GETTERSETTER_SUFFIX= "org.eclipse.jdt.ui.gettersetter.suffix.list"; //$NON-NLS-1$
243 
244     /**
245      * A named preference that controls whether the keyword "this" will be added
246      * automatically to field accesses in generated methods.
247      * <p>
248      * Value is of type <code>Boolean</code>.
249      * </p>
250      * @since 3.0
251      */
252     public static final String   CODEGEN_KEYWORD_THIS= "org.eclipse.jdt.ui.keywordthis"; //$NON-NLS-1$
253 
254     /**
255      * A named preference that controls whether to use the prefix "is" or the prefix "get" for
256      * automatically created getters which return a boolean field.
257      * <p>
258      * Value is of type <code>Boolean</code>.
259      * </p>
260      * @since 3.0
261      */
262     public static final String   CODEGEN_IS_FOR_GETTERS= "org.eclipse.jdt.ui.gettersetter.use.is"; //$NON-NLS-1$
263     
264     
265     /**
266      * A named preference that defines the preferred variable names for exceptions in
267      * catch clauses.
268      * <p>
269      * Value is of type <code>String</code>.
270      * </p>
271      * @since 3.0
272      */ 
273     public static final String   CODEGEN_EXCEPTION_VAR_NAME= "org.eclipse.jdt.ui.exception.name"; //$NON-NLS-1$
274     
275     /**
276      * A named preference that controls if comment stubs will be added
277      * automatically to newly created types and methods.
278      * <p>
279      * Value is of type <code>Boolean</code>.
280      * </p>
281      * @since 2.1
282      */
283     public static final String   CODEGEN_ADD_COMMENTS= "org.eclipse.jdt.ui.javadoc"; //$NON-NLS-1$
284 
285     /**
286      * A named preference that controls if a comment stubs will be added
287      * automatically to newly created types and methods.
288      * <p>
289      * Value is of type <code>Boolean</code>.
290      * </p>
291      * @deprecated Use CODEGEN_ADD_COMMENTS instead (Name is more precise).
292      */
293     public static final String   CODEGEN__JAVADOC_STUBS= CODEGEN_ADD_COMMENTS;
294 
295     /**
296      * A named preference that controls if a non-javadoc comment gets added to methods generated via the 
297      * "Override Methods" operation.
298      * <p>
299      * Value is of type <code>Boolean</code>.
300      * </p>
301      * @deprecated New code template story: user can
302      * specify the overriding method comment.
303      */
304     public static final String   CODEGEN__NON_JAVADOC_COMMENTS= "org.eclipse.jdt.ui.seecomments"; //$NON-NLS-1$
305 
306     /**
307      * A named preference that controls if a file comment gets added to newly created files.
308      * <p>
309      * Value is of type <code>Boolean</code>.
310      * </p>
311      * @deprecated New code template story: user can
312      * specify the new file code template.
313      */
314     public static final String   CODEGEN__FILE_COMMENTS= "org.eclipse.jdt.ui.filecomments"; //$NON-NLS-1$
315     
316     /**
317      * A named preference that controls whether to add a override annotation for newly created methods
318      * <p>
319      * Value is of type <code>Boolean</code>.
320      * </p>
321      * @since 3.1
322      */
323     public static final String   CODEGEN_USE_OVERRIDE_ANNOTATION= "org.eclipse.jdt.ui.overrideannotation"; //$NON-NLS-1$
324     
325     /**
326      * A named preference that holds a list of semicolon separated fully qualified type names with wild card characters.
327      * @since 3.0
328      */ 
329     public static final String   TYPEFILTER_ENABLED= "org.eclipse.jdt.ui.typefilter.enabled"; //$NON-NLS-1$
330     
331     /**
332      * A named preference that holds a list of semicolon separated fully qualified type names with wild card characters.
333      * @since 3.0
334      */ 
335     public static final String   TYPEFILTER_DISABLED= "org.eclipse.jdt.ui.typefilter.disabled"; //$NON-NLS-1$
336     
337     
338     /**
339      * A named preference that holds a list of semicolon separated package names. The list specifies the import order used by
340      * the "Organize Imports" operation.
341      * <p>
342      * Value is of type <code>String</code>: semicolon separated list of package
343      * names
344      * </p>
345      */
346     public static final String   ORGIMPORTS_IMPORTORDER= "org.eclipse.jdt.ui.importorder"; //$NON-NLS-1$
347         
348     /**
349      * A named preference that specifies the number of imports added before a star-import declaration is used.
350      * <p>
351      * Value is of type <code>Integer</code>: positive value specifying the number of non star-import is used
352      * </p>
353      */
354     public static final String   ORGIMPORTS_ONDEMANDTHRESHOLD= "org.eclipse.jdt.ui.ondemandthreshold"; //$NON-NLS-1$
355 
356     /**
357      * A named preference that specifies the number of static imports added before a star-import declaration is used.
358      * <p>
359      * Value is of type <code>Integer</code>: positive value specifying the number of non star-import is used
360      * </p>
361      * @since 3.2
362      */
363     public static final String   ORGIMPORTS_STATIC_ONDEMANDTHRESHOLD= "org.eclipse.jdt.ui.staticondemandthreshold"; //$NON-NLS-1$
364     
365     /**
366      * A named preferences that controls if types that start with a lower case letters get added by the
367      * "Organize Import" operation.
368      * <p>
369      * Value is of type <code>Boolean</code>.
370      * </p>
371      */
372     public static final String   ORGIMPORTS_IGNORELOWERCASE= "org.eclipse.jdt.ui.ignorelowercasenames"; //$NON-NLS-1$
373     
374     /**
375      * A named preference that specifies whether children of a compilation unit are shown in the package explorer.
376      * <p>
377      * Value is of type <code>Boolean</code>.
378      * </p>
379      */
380     public static final String   SHOW_CU_CHILDREN= "org.eclipse.jdt.ui.packages.cuchildren"; //$NON-NLS-1$
381 
382     /**
383      * A named preference that controls whether the package explorer's selection is linked to the active editor.
384      * <p>
385      * Value is of type <code>Boolean</code>.
386      * </p>
387      * @deprecated Since 3.3. Not used anymore. Package view always restores with the last recently used setting.
388      */
389     public static final String   LINK_PACKAGES_TO_EDITOR= "org.eclipse.jdt.ui.packages.linktoeditor"; //$NON-NLS-1$
390 
391     /**
392      * A named preference that controls whether the hierarchy view's selection is linked to the active editor.
393      * <p>
394      * Value is of type <code>Boolean</code>.
395      * </p>
396      * @deprecated Since 3.3. Not used anymore. Type hierarchy view always restores with the last recently used setting.
397      */
398     public static final String   LINK_TYPEHIERARCHY_TO_EDITOR= "org.eclipse.jdt.ui.packages.linktypehierarchytoeditor"; //$NON-NLS-1$
399 
400     /**
401      * A named preference that controls whether the projects view's selection is
402      * linked to the active editor.
403      * <p>
404      * Value is of type <code>Boolean</code>.
405      * </p>
406      * @since 2.1
407      */
408     public static final String   LINK_BROWSING_PROJECTS_TO_EDITOR= "org.eclipse.jdt.ui.browsing.projectstoeditor"; //$NON-NLS-1$
409 
410     /**
411      * A named preference that controls whether the packages view's selection is
412      * linked to the active editor.
413      * <p>
414      * Value is of type <code>Boolean</code>.
415      * </p>
416      * @since 2.1
417      */
418     public static final String   LINK_BROWSING_PACKAGES_TO_EDITOR= "org.eclipse.jdt.ui.browsing.packagestoeditor"; //$NON-NLS-1$
419 
420 
421 
422     /**
423      * A named preference that controls whether the types view's selection is
424      * linked to the active editor.
425      * <p>
426      * Value is of type <code>Boolean</code>.
427      * </p>
428      * @since 2.1
429      */
430     public static final String   LINK_BROWSING_TYPES_TO_EDITOR= "org.eclipse.jdt.ui.browsing.typestoeditor"; //$NON-NLS-1$
431 
432     /**
433      * A named preference that controls whether the members view's selection is
434      * linked to the active editor.
435      * <p>
436      * Value is of type <code>Boolean</code>.
437      * </p>
438      * @since 2.1
439      */
440     public static final String   LINK_BROWSING_MEMBERS_TO_EDITOR= "org.eclipse.jdt.ui.browsing.memberstoeditor"; //$NON-NLS-1$
441     /**
442      * A named preference that controls whether new projects are generated using source and output folder.
443      * <p>
444      * Value is of type <code>Boolean</code>. if <code>true</code> new projects are created with a source and
445      * output folder. If <code>false</code> source and output folder equals to the project.
446      * </p>
447      */
448     public static final String   SRCBIN_FOLDERS_IN_NEWPROJ= "org.eclipse.jdt.ui.wizards.srcBinFoldersInNewProjects"; //$NON-NLS-1$
449 
450     /**
451      * A named preference that specifies the source folder name used when creating a new Java project. Value is inactive
452      * if <code>SRCBIN_FOLDERS_IN_NEWPROJ</code> is set to <code>false</code>.
453      * <p>
454      * Value is of type <code>String</code>. 
455      * </p>
456      * 
457      * @see #SRCBIN_FOLDERS_IN_NEWPROJ
458      */
459     public static final String   SRCBIN_SRCNAME= "org.eclipse.jdt.ui.wizards.srcBinFoldersSrcName"; //$NON-NLS-1$
460 
461     /**
462      * A named preference that specifies the output folder name used when creating a new Java project. Value is inactive
463      * if <code>SRCBIN_FOLDERS_IN_NEWPROJ</code> is set to <code>false</code>.
464      * <p>
465      * Value is of type <code>String</code>. 
466      * </p>
467      * 
468      * @see #SRCBIN_FOLDERS_IN_NEWPROJ
469      */
470     public static final String   SRCBIN_BINNAME= "org.eclipse.jdt.ui.wizards.srcBinFoldersBinName"; //$NON-NLS-1$
471 
472     /**
473      * A named preference that holds a list of possible JRE libraries used by the New Java Project wizard. A library 
474      * consists of a description and an arbitrary number of <code>IClasspathEntry</code>s, that will represent the 
475      * JRE on the new project's class path. 
476      * <p>
477      * Value is of type <code>String</code>: a semicolon separated list of encoded JRE libraries. 
478      * <code>NEWPROJECT_JRELIBRARY_INDEX</code> defines the currently used library. Clients
479      * should use the method <code>encodeJRELibrary</code> to encode a JRE library into a string
480      * and the methods <code>decodeJRELibraryDescription(String)</code> and <code>
481      * decodeJRELibraryClasspathEntries(String)</code> to decode the description and the array
482      * of class path entries from an encoded string.
483      * </p>
484      * 
485      * @see #NEWPROJECT_JRELIBRARY_INDEX
486      * @see #encodeJRELibrary(String, IClasspathEntry[])
487      * @see #decodeJRELibraryDescription(String)
488      * @see #decodeJRELibraryClasspathEntries(String)
489      */
490     public static final String   NEWPROJECT_JRELIBRARY_LIST= "org.eclipse.jdt.ui.wizards.jre.list"; //$NON-NLS-1$
491 
492     /**
493      * A named preferences that specifies the current active JRE library.
494      * <p>
495      * Value is of type <code>Integer</code>: an index into the list of possible JRE libraries.
496      * </p>
497      * 
498      * @see #NEWPROJECT_JRELIBRARY_LIST
499      */
500     public static final String   NEWPROJECT_JRELIBRARY_INDEX= "org.eclipse.jdt.ui.wizards.jre.index"; //$NON-NLS-1$
501 
502     /**
503      * A named preference that controls if a new type hierarchy gets opened in a 
504      * new type hierarchy perspective or inside the type hierarchy view part.
505      * <p>
506      * Value is of type <code>String</code>: possible values are <code>
507      * OPEN_TYPE_HIERARCHY_IN_PERSPECTIVE</code> or <code>
508      * OPEN_TYPE_HIERARCHY_IN_VIEW_PART</code>.
509      * </p>
510      * 
511      * @see #OPEN_TYPE_HIERARCHY_IN_PERSPECTIVE
512      * @see #OPEN_TYPE_HIERARCHY_IN_VIEW_PART
513      */
514     public static final String   OPEN_TYPE_HIERARCHY= "org.eclipse.jdt.ui.openTypeHierarchy"; //$NON-NLS-1$
515 
516     /**
517      * A string value used by the named preference <code>OPEN_TYPE_HIERARCHY</code>.
518      * 
519      * @see #OPEN_TYPE_HIERARCHY
520      */
521     public static final String   OPEN_TYPE_HIERARCHY_IN_PERSPECTIVE= "perspective"; //$NON-NLS-1$
522 
523     /**
524      * A string value used by the named preference <code>OPEN_TYPE_HIERARCHY</code>.
525      * 
526      * @see #OPEN_TYPE_HIERARCHY
527      */
528     public static final String   OPEN_TYPE_HIERARCHY_IN_VIEW_PART= "viewPart"; //$NON-NLS-1$
529     
530     /**
531      * A named preference that controls the behavior when double clicking on a container in the packages view. 
532      * <p>
533      * Value is of type <code>String</code>: possible values are <code>
534      * DOUBLE_CLICK_GOES_INTO</code> or <code>
535      * DOUBLE_CLICK_EXPANDS</code>.
536      * </p>
537      * 
538      * @see #DOUBLE_CLICK_EXPANDS
539      * @see #DOUBLE_CLICK_GOES_INTO
540      */
541     public static final String   DOUBLE_CLICK= "packageview.doubleclick"; //$NON-NLS-1$
542 
543     /**
544      * A string value used by the named preference <code>DOUBLE_CLICK</code>.
545      * 
546      * @see #DOUBLE_CLICK
547      */
548     public static final String   DOUBLE_CLICK_GOES_INTO= "packageview.gointo"; //$NON-NLS-1$
549 
550     /**
551      * A string value used by the named preference <code>DOUBLE_CLICK</code>.
552      * 
553      * @see #DOUBLE_CLICK
554      */
555     public static final String   DOUBLE_CLICK_EXPANDS= "packageview.doubleclick.expands"; //$NON-NLS-1$
556 
557     /**
558      * A named preference that controls whether Java views update their presentation while editing or when saving the
559      * content of an editor. 
560      * <p>
561      * Value is of type <code>String</code>: possible values are <code>
562      * UPDATE_ON_SAVE</code> or <code>
563      * UPDATE_WHILE_EDITING</code>.
564      * </p>
565      * 
566      * @see #UPDATE_ON_SAVE
567      * @see #UPDATE_WHILE_EDITING
568      * @deprecated Since 3.0, views now always update while editing
569      */
570     public static final String   UPDATE_JAVA_VIEWS= "JavaUI.update"; //$NON-NLS-1$
571 
572     /**
573      * A string value used by the named preference <code>UPDATE_JAVA_VIEWS</code>
574      * 
575      * @see #UPDATE_JAVA_VIEWS
576      * @deprecated Since 3.0, views now always update while editing
577      */
578     public static final String   UPDATE_ON_SAVE= "JavaUI.update.onSave"; //$NON-NLS-1$
579 
580     /**
581      * A string value used by the named preference <code>UPDATE_JAVA_VIEWS</code>
582      * 
583      * @see #UPDATE_JAVA_VIEWS
584      * @deprecated Since 3.0, views now always update while editing
585      */
586     public static final String   UPDATE_WHILE_EDITING= "JavaUI.update.whileEditing"; //$NON-NLS-1$
587 
588     /**
589      * A named preference that holds the path of the Javadoc command used by the Javadoc creation wizard.
590      * <p>
591      * Value is of type <code>String</code>.
592      * </p>
593      */
594     public static final String   JAVADOC_COMMAND= "command"; //$NON-NLS-1$
595 
596     /**
597      * A named preference that defines whether the hint to make hover sticky should be shown.
598      *
599      * @see JavaUI
600      * @since 3.0
601      * @deprecated As of 3.3, replaced by {@link AbstractDecoratedTextEditorPreferenceConstants#EDITOR_SHOW_TEXT_HOVER_AFFORDANCE}
602      */
603     public static final String   EDITOR_SHOW_TEXT_HOVER_AFFORDANCE= "PreferenceConstants.EDITOR_SHOW_TEXT_HOVER_AFFORDANCE"; //$NON-NLS-1$
604 
605     /**
606      * A named preference that defines the key for the hover modifiers.
607      *
608      * @see JavaUI
609      * @since 2.1
610      */
611     public static final String   EDITOR_TEXT_HOVER_MODIFIERS= "hoverModifiers"; //$NON-NLS-1$
612 
613     /**
614      * A named preference that defines the key for the hover modifier state masks.
615      * The value is only used if the value of <code>EDITOR_TEXT_HOVER_MODIFIERS</code>
616      * cannot be resolved to valid SWT modifier bits.
617      * 
618      * @see JavaUI
619      * @see #EDITOR_TEXT_HOVER_MODIFIERS
620      * @since 2.1.1
621      */
622     public static final String   EDITOR_TEXT_HOVER_MODIFIER_MASKS= "hoverModifierMasks"; //$NON-NLS-1$
623 
624     /**
625      * The id of the best match hover contributed for extension point
626      * <code>javaEditorTextHovers</code>.
627      *
628      * @since 2.1
629      */
630     public static final String   ID_BESTMATCH_HOVER= "org.eclipse.jdt.ui.BestMatchHover"; //$NON-NLS-1$
631 
632     /**
633      * The id of the source code hover contributed for extension point
634      * <code>javaEditorTextHovers</code>.
635      *
636      * @since 2.1
637      */
638     public static final String   ID_SOURCE_HOVER= "org.eclipse.jdt.ui.JavaSourceHover"; //$NON-NLS-1$
639 
640     /**
641      * The id of the javadoc hover contributed for extension point
642      * <code>javaEditorTextHovers</code>.
643      *
644      * @since 2.1
645      */
646     public static final String   ID_JAVADOC_HOVER= "org.eclipse.jdt.ui.JavadocHover"; //$NON-NLS-1$
647 
648     /**
649      * The id of the problem hover contributed for extension point
650      * <code>javaEditorTextHovers</code>.
651      *
652      * @since 2.1
653      * @deprecated as of 3.0, this hover is no longer available
654      */
655     public static final String   ID_PROBLEM_HOVER= "org.eclipse.jdt.ui.ProblemHover"; //$NON-NLS-1$
656 
657     /**
658      * A named preference that controls whether bracket matching highlighting is turned on or off.
659      * <p>
660      * Value is of type <code>Boolean</code>.
661      * </p>
662      */
663     public final static String   EDITOR_MATCHING_BRACKETS= "matchingBrackets"; //$NON-NLS-1$
664 
665     /**
666      * A named preference that holds the color used to highlight matching brackets.
667      * <p>
668      * Value is of type <code>String</code>. A RGB color value encoded as a string 
669      * using class <code>PreferenceConverter</code>
670      * </p>
671      * 
672      * @see org.eclipse.jface.resource.StringConverter
673      * @see org.eclipse.jface.preference.PreferenceConverter
674      */
675     public final static String   EDITOR_MATCHING_BRACKETS_COLOR=  "matchingBracketsColor"; //$NON-NLS-1$
676 
677     /**
678      * A named preference that controls whether the current line highlighting is turned on or off.
679      * <p>
680      * Value is of type <code>Boolean</code>.
681      * </p>
682      * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
683      */
684     public final static String   EDITOR_CURRENT_LINE= "currentLine"; //$NON-NLS-1$
685 
686     /**
687      * A named preference that holds the color used to highlight the current line.
688      * <p>
689      * Value is of type <code>String</code>. A RGB color value encoded as a string
690      * using class <code>PreferenceConverter</code>
691      * </p>
692      * 
693      * @see org.eclipse.jface.resource.StringConverter
694      * @see org.eclipse.jface.preference.PreferenceConverter
695      * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
696      */
697     public final static String   EDITOR_CURRENT_LINE_COLOR= "currentLineColor"; //$NON-NLS-1$
698 
699     /**
700      * A named preference that controls whether the print margin is turned on or off.
701      * <p>
702      * Value is of type <code>Boolean</code>.
703      * </p>
704      * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
705      */
706     public final static String   EDITOR_PRINT_MARGIN= "printMargin"; //$NON-NLS-1$
707     
708     /**
709      * A named preference that holds the color used to render the print margin.
710      * <p>
711      * Value is of type <code>String</code>. A RGB color value encoded as a string
712      * using class <code>PreferenceConverter</code>
713      * </p>
714      * 
715      * @see org.eclipse.jface.resource.StringConverter
716      * @see org.eclipse.jface.preference.PreferenceConverter
717      * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
718      */
719     public final static String   EDITOR_PRINT_MARGIN_COLOR= "printMarginColor"; //$NON-NLS-1$
720 
721     /**
722      * Print margin column. Integer value.
723      * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
724      */
725     public final static String   EDITOR_PRINT_MARGIN_COLUMN= "printMarginColumn"; //$NON-NLS-1$
726 
727     /**
728      * A named preference that holds the color used for the find/replace scope.
729      * <p>
730      * Value is of type <code>String</code>. A RGB color value encoded as a string
731      * using class <code>PreferenceConverter</code>
732      * </p>
733      * 
734      * @see org.eclipse.jface.resource.StringConverter
735      * @see org.eclipse.jface.preference.PreferenceConverter
736      * @deprecated As of 3.2, use {@link AbstractTextEditor#PREFERENCE_COLOR_FIND_SCOPE} instead}
737      */
738     public final static String   EDITOR_FIND_SCOPE_COLOR= AbstractTextEditor.PREFERENCE_COLOR_FIND_SCOPE;
739 
740     /**
741      * A named preference that specifies if the editor uses spaces for tabs.
742      * <p>
743      * Value is of type <code>Boolean</code>. If <code>true</code>spaces instead of tabs are used
744      * in the editor. If <code>false</code> the editor inserts a tab character when pressing the tab
745      * key.
746      * </p>
747      * @deprecated As of 3.1 replaced by the formatter setting defined in {@link org.eclipse.jdt.core.formatter.DefaultCodeFormatterConstants#FORMATTER_TAB_CHAR}
748      */
749     public final static String   EDITOR_SPACES_FOR_TABS= "spacesForTabs"; //$NON-NLS-1$
750 
751     /**
752      * A named preference that holds the number of spaces used per tab in the editor.
753      * <p>
754      * Value is of type <code>Integer</code>: positive integer value specifying the number of
755      * spaces per tab.
756      * </p>
757      * @deprecated As of 3.0 replaced by {@link AbstractDecoratedTextEditorPreferenceConstants#EDITOR_TAB_WIDTH}
758      */
759     public final static String   EDITOR_TAB_WIDTH= "org.eclipse.jdt.ui.editor.tab.width"; //$NON-NLS-1$
760 
761     /**
762      * A named preference that controls whether the outline view selection
763      * should stay in sync with with the element at the current cursor position.
764      * <p>
765      * Value is of type <code>Boolean</code>.
766      * </p>
767      * @since 2.1
768      */
769     public final static String   EDITOR_SYNC_OUTLINE_ON_CURSOR_MOVE= "JavaEditor.SyncOutlineOnCursorMove"; //$NON-NLS-1$
770 
771     /**
772      * A named preference that controls if correction indicators are shown in the UI.
773      * <p>
774      * Value is of type <code>Boolean</code>.
775      * </p>
776      */
777     public final static String   EDITOR_CORRECTION_INDICATION= "JavaEditor.ShowTemporaryProblem"; //$NON-NLS-1$
778 
779     /**
780      * A named preference that controls whether the editor shows problem indicators in text (squiggly lines). 
781      * <p>
782      * Value is of type <code>Boolean</code>.
783      * </p>
784      * 
785      * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.MarkerAnnotationPreferences}
786      */
787     public final static String   EDITOR_PROBLEM_INDICATION= "problemIndication"; //$NON-NLS-1$
788 
789     /**
790      * A named preference that holds the color used to render problem indicators.
791      * <p>
792      * Value is of type <code>String</code>. A RGB color value encoded as a string
793      * using class <code>PreferenceConverter</code>
794      * </p>
795      * 
796      * @see #EDITOR_PROBLEM_INDICATION
797      * @see org.eclipse.jface.resource.StringConverter
798      * @see org.eclipse.jface.preference.PreferenceConverter
799      * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.MarkerAnnotationPreferences}
800      */
801     public final static String   EDITOR_PROBLEM_INDICATION_COLOR= "problemIndicationColor"; //$NON-NLS-1$
802 
803     /**
804      * A named preference that controls whether the editor shows warning indicators in text (squiggly lines). 
805      * <p>
806      * Value is of type <code>Boolean</code>.
807      * </p>
808      * @since 2.1
809      * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.MarkerAnnotationPreferences}
810      */
811     public final static String   EDITOR_WARNING_INDICATION= "warningIndication"; //$NON-NLS-1$
812 
813     /**
814      * A named preference that holds the color used to render warning indicators.
815      * <p>
816      * Value is of type <code>String</code>. A RGB color value encoded as a string
817      * using class <code>PreferenceConverter</code>
818      * </p>
819      * 
820      * @see #EDITOR_WARNING_INDICATION
821      * @see org.eclipse.jface.resource.StringConverter
822      * @see org.eclipse.jface.preference.PreferenceConverter
823      * @since 2.1
824      * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.MarkerAnnotationPreferences}
825      */
826     public final static String   EDITOR_WARNING_INDICATION_COLOR= "warningIndicationColor"; //$NON-NLS-1$
827     
828     /**
829      * A named preference that controls whether the editor shows task indicators in text (squiggly lines). 
830      * <p>
831      * Value is of type <code>Boolean</code>.
832      * </p>
833      * @since 2.1
834      * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.MarkerAnnotationPreferences}
835      */
836     public final static String   EDITOR_TASK_INDICATION= "taskIndication"; //$NON-NLS-1$
837 
838     /**
839      * A named preference that holds the color used to render task indicators.
840      * <p>
841      * Value is of type <code>String</code>. A RGB color value encoded as a string
842      * using class <code>PreferenceConverter</code>
843      * </p>
844      * 
845      * @see #EDITOR_TASK_INDICATION
846      * @see org.eclipse.jface.resource.StringConverter
847      * @see org.eclipse.jface.preference.PreferenceConverter
848      * @since 2.1
849      * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.MarkerAnnotationPreferences}
850      */
851     public final static String   EDITOR_TASK_INDICATION_COLOR= "taskIndicationColor"; //$NON-NLS-1$
852 
853     /**
854      * A named preference that controls whether the editor shows bookmark
855      * indicators in text (squiggly lines).
856      * <p>
857      * Value is of type <code>Boolean</code>.
858      * </p>
859      * @since 2.1
860      * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.MarkerAnnotationPreferences}
861      */
862     public final static String   EDITOR_BOOKMARK_INDICATION= "bookmarkIndication"; //$NON-NLS-1$
863 
864     /**
865      * A named preference that holds the color used to render bookmark indicators.
866      * <p>
867      * Value is of type <code>String</code>. A RGB color value encoded as a string
868      * using class <code>PreferenceConverter</code>
869      * </p>
870      *
871      * @see #EDITOR_BOOKMARK_INDICATION
872      * @see org.eclipse.jface.resource.StringConverter
873      * @see org.eclipse.jface.preference.PreferenceConverter
874      * @since 2.1
875      * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.MarkerAnnotationPreferences}
876      */
877     public final static String   EDITOR_BOOKMARK_INDICATION_COLOR= "bookmarkIndicationColor"; //$NON-NLS-1$
878 
879     /**
880      * A named preference that controls whether the editor shows search
881      * indicators in text (squiggly lines).
882      * <p>
883      * Value is of type <code>Boolean</code>.
884      * </p>
885      * @since 2.1
886      * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.MarkerAnnotationPreferences}
887      */
888     public final static String   EDITOR_SEARCH_RESULT_INDICATION= "searchResultIndication"; //$NON-NLS-1$
889 
890     /**
891      * A named preference that holds the color used to render search indicators.
892      * <p>
893      * Value is of type <code>String</code>. A RGB color value encoded as a string
894      * using class <code>PreferenceConverter</code>
895      * </p>
896      *
897      * @see #EDITOR_SEARCH_RESULT_INDICATION
898      * @see org.eclipse.jface.resource.StringConverter
899      * @see org.eclipse.jface.preference.PreferenceConverter
900      * @since 2.1
901  &n