IWorkbenchPreferenceConstants


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   *     Kiryl Kazakevich, Intel - bug 88359
11   *******************************************************************************/
12  package org.eclipse.ui;
13  
14  
15  /**
16   * Preference ids exposed by the Eclipse Platform User Interface.
17   * These preference settings can be obtained from the UI plug-in's
18   * preference store.
19   * 
20   * @see PlatformUI#PLUGIN_ID
21   * @see PlatformUI#getPreferenceStore()
22   */
23  public interface IWorkbenchPreferenceConstants {
24      
25      /**
26       * A named preference for whether to show an editor when its
27       * input file is selected in the Navigator (and vice versa).
28       * <p>
29       * Value is of type <code>boolean</code>.
30       * </p>
31       */
32      public static final String   LINK_NAVIGATOR_TO_EDITOR = "LINK_NAVIGATOR_TO_EDITOR"; //$NON-NLS-1$
33  
34      /**
35       * A named preference for how a new perspective is opened.
36       * <p>
37       * Value is of type <code>String</code>.  The possible values are defined 
38       * by <code>OPEN_PERSPECTIVE_WINDOW, OPEN_PERSPECTIVE_PAGE and 
39       * OPEN_PERSPECTIVE_REPLACE</code>.
40       * </p>
41       * 
42       * @see #OPEN_PERSPECTIVE_WINDOW
43       * @see #OPEN_PERSPECTIVE_PAGE
44       * @see #OPEN_PERSPECTIVE_REPLACE
45       * @see #NO_NEW_PERSPECTIVE
46       */
47      public static final String   OPEN_NEW_PERSPECTIVE = "OPEN_NEW_PERSPECTIVE"; //$NON-NLS-1$
48  
49      /**
50       * A named preference for how a new perspective is opened
51       * when the alternate key modifiers are pressed.  The alternate key modifiers
52       * are platform dependent.
53       * <p>
54       * Value is of type <code>String</code>.  The possible values are defined 
55       * by <code>OPEN_PERSPECTIVE_WINDOW, OPEN_PERSPECTIVE_PAGE and 
56       * OPEN_PERSPECTIVE_REPLACE</code>.
57       * </p>
58       * @deprecated Workbench no longer supports alternate key modifier to open
59       *      a new perspective. Callers should use IWorkbench.showPerspective methods.
60       */
61      public static final String   ALTERNATE_OPEN_NEW_PERSPECTIVE = "ALTERNATE_OPEN_NEW_PERSPECTIVE"; //$NON-NLS-1$
62  
63      /**
64       * A named preference for how a new perspective is opened
65       * when the shift key modifier is pressed.  
66       * <p>
67       * Value is of type <code>String</code>.  The possible values are defined 
68       * by <code>OPEN_PERSPECTIVE_WINDOW, OPEN_PERSPECTIVE_PAGE and 
69       * OPEN_PERSPECTIVE_REPLACE</code>.
70       * </p>
71       * 
72       * @deprecated Workbench no longer supports shift key modifier to open
73       *      a new perspective. Callers should use IWorkbench.showPerspective methods.
74       */
75      public static final String   SHIFT_OPEN_NEW_PERSPECTIVE = "SHIFT_OPEN_NEW_PERSPECTIVE"; //$NON-NLS-1$
76  
77      /**
78       * A named preference for how a new perspective should be opened
79       * when a new project is created.
80       * <p>
81       * Value is of type <code>String</code>.  The possible values are defined 
82       * by the constants <code>OPEN_PERSPECTIVE_WINDOW, OPEN_PERSPECTIVE_PAGE, 
83       * OPEN_PERSPECTIVE_REPLACE, and NO_NEW_PERSPECTIVE</code>.
84       * </p>
85       * 
86       * @see #OPEN_PERSPECTIVE_WINDOW
87       * @see #OPEN_PERSPECTIVE_PAGE
88       * @see #OPEN_PERSPECTIVE_REPLACE
89       * @see #NO_NEW_PERSPECTIVE
90       * @deprecated in 3.0. This preference is IDE-specific, and is therefore found
91       * only in IDE configurations. IDE-specific tools should use 
92       * <code>org.eclipse.ui.ide.IDE.Preferences.PROJECT_OPEN_NEW_PERSPECTIVE</code>
93       * instead.
94       */
95      public static final String   PROJECT_OPEN_NEW_PERSPECTIVE = "PROJECT_OPEN_NEW_PERSPECTIVE"; //$NON-NLS-1$
96  
97      /**
98       * A preference value indicating that an action should open a new 
99       * perspective in a new window.
100      * 
101      * @see #PROJECT_OPEN_NEW_PERSPECTIVE
102      */
103     public static final String   OPEN_PERSPECTIVE_WINDOW = "OPEN_PERSPECTIVE_WINDOW"; //$NON-NLS-1$
104 
105     /**
106      * A preference value indicating that an action should open a new 
107      * perspective in a new page.
108      * 
109      * @see #PROJECT_OPEN_NEW_PERSPECTIVE
110      * @deprecated Opening a Perspective in a new page is no longer
111      * supported functionality as of 2.0.
112      */
113     public static final String   OPEN_PERSPECTIVE_PAGE = "OPEN_PERSPECTIVE_PAGE"; //$NON-NLS-1$
114 
115     /**
116      * A preference value indicating that an action should open a new 
117      * perspective by replacing the current perspective.
118      * 
119      * @see #PROJECT_OPEN_NEW_PERSPECTIVE
120      */
121     public static final String   OPEN_PERSPECTIVE_REPLACE = "OPEN_PERSPECTIVE_REPLACE"; //$NON-NLS-1$
122 
123     /**
124      * A preference value indicating that an action should not open a 
125      * new perspective.
126      * 
127      * @see #PROJECT_OPEN_NEW_PERSPECTIVE
128      */
129     public static final String   NO_NEW_PERSPECTIVE = "NO_NEW_PERSPECTIVE"; //$NON-NLS-1$
130 
131     /**
132      * A named preference indicating the default workbench perspective.
133      */
134     public static final String   DEFAULT_PERSPECTIVE_ID = "defaultPerspectiveId"; //$NON-NLS-1$
135 
136     /**
137      * A named preference indicating the presentation factory
138      * to use for the workbench look and feel.
139      * 
140      * @since 3.0
141      */
142     public static final String   PRESENTATION_FACTORY_ID = "presentationFactoryId"; //$NON-NLS-1$
143 
144     /**
145      * A named preference indicating where the perspective bar should be docked.
146      * The default value (when this preference is not set) is <code>TOP_RIGHT</code>.
147      * <p>
148      * This preference may be one of the following values:
149      * {@link #TOP_RIGHT}, {@link #TOP_LEFT}, or {@link #LEFT}.
150      * </p>
151      *
152      * @since 3.0
153      */
154     public static String   DOCK_PERSPECTIVE_BAR = "DOCK_PERSPECTIVE_BAR"; //$NON-NLS-1$   
155 
156     /**
157      * A named preference indicating where the fast view bar should be docked in a
158      * fresh workspace.  This preference is meaningless after a workspace has been
159      * setup, since the fast view bar state is then persisted in the workbench.  This
160      * preference is intended for applications that want the initial docking location
161      * to be somewhere specific.  The default value (when this preference is not set)
162      * is the bottom.
163      * 
164      * @see #LEFT
165      * @see #BOTTOM
166      * @see #RIGHT
167      * @since 3.0
168      */
169     public static final String   INITIAL_FAST_VIEW_BAR_LOCATION = "initialFastViewBarLocation"; //$NON-NLS-1$
170 
171     /**
172      * Constant to be used when referring to the top right of the workbench window. 
173      *
174      * @see #DOCK_PERSPECTIVE_BAR
175      * @since 3.0
176      */
177     public static final String   TOP_RIGHT = "topRight"; //$NON-NLS-1$
178 
179     /**
180      * Constant to be used when referring to the top left of the workbench window. 
181      *
182      * @see #DOCK_PERSPECTIVE_BAR
183      * @since 3.0
184      */
185     public static final String   TOP_LEFT = "topLeft"; //$NON-NLS-1$
186 
187     /**
188      * Constant to be used when referring to the left side of the workbench window. 
189      *
190      * @see #DOCK_PERSPECTIVE_BAR
191      * @see #INITIAL_FAST_VIEW_BAR_LOCATION
192      * @since 3.0
193      */
194     public static final String   LEFT = "left"; //$NON-NLS-1$
195 
196     /**
197      * Constant to be used when referring to the bottom of the workbench window. 
198      *
199      * @see #INITIAL_FAST_VIEW_BAR_LOCATION
200      * @since 3.0
201      */
202     public static final String   BOTTOM = "bottom"; //$NON-NLS-1$
203 
204     /**
205      * Constant to be used when referring to the right side of the workbench window. 
206      *
207      * @see #INITIAL_FAST_VIEW_BAR_LOCATION
208      * @since 3.0
209      */
210     public static final String   RIGHT = "right"; //$NON-NLS-1$
211 
212     /**
213      * A named preference indicating whether the workbench should show the 
214      * introduction component (if available) on startup.
215      * 
216      * <p>
217      * The default value for this preference is: <code>true</code> (show intro)
218      * </p> 
219      * 
220      * @see org.eclipse.ui.application.WorkbenchWindowAdvisor#openIntro()
221      * @since 3.0
222      */
223     public static final String   SHOW_INTRO = "showIntro"; //$NON-NLS-1$
224 
225     /**
226      * A named preference for whether the workbench should show traditional style tabs in
227      * editors and views.
228      * 
229      * Boolean-valued: <code>true</code> if editors and views should use a traditional style of tab and
230      * <code>false</code> if editors should show new style tab (3.0 style)
231      * <p>
232      * The default value for this preference is: <code>true</code>
233      * </p>
234      * 
235      * @since 3.0
236      */
237     public static String   SHOW_TRADITIONAL_STYLE_TABS = "SHOW_TRADITIONAL_STYLE_TABS"; //$NON-NLS-1$
238 
239     /**
240      * A named preference for whether the workbench should show text 
241      * on the perspective bar. 
242      * 
243      * Boolean-valued: <code>true</code>, if editors should show text on the perspective bar,
244      * <code>false</code> otherwise.
245      * <p>
246      * The default value for this preference is: <code>true</code> (show text on the perspective bar)
247      * </p>
248      * 
249      * @since 3.0
250      */
251     public static String   SHOW_TEXT_ON_PERSPECTIVE_BAR = "SHOW_TEXT_ON_PERSPECTIVE_BAR"; //$NON-NLS-1$
252 
253     /**
254      * A named preference for the text of the Help Contents action. 
255      * 
256      * String-valued.  If not specified, <code>"&Help Contents"</code> is used.
257      * <p>
258      * The default value for this preference is: <code>null</code>
259      * </p>
260      * 
261      * @since 3.0
262      */
263     public static String   HELP_CONTENTS_ACTION_TEXT = "helpContentsActionText"; //$NON-NLS-1$
264     
265     /**
266      * A named preference for the text of the Help Search action. 
267      * 
268      * String-valued.  If not specified, <code>"S&earch"</code> is used.
269      * <p>
270      * The default value for this preference is: <code>null</code>
271      * </p>
272      * 
273      * @since 3.1
274      */
275     public static String   HELP_SEARCH_ACTION_TEXT = "helpSearchActionText"; //$NON-NLS-1$
276     
277     /**
278      * A named preference for the text of the Dynamic Help action. 
279      * 
280      * String-valued.  If not specified, <code>"&Dynamic Help"</code> is used.
281      * <p>
282      * The default value for this preference is: <code>null</code>
283      * </p>
284      * 
285      * @since 3.1
286      */
287     public static String   DYNAMIC_HELP_ACTION_TEXT = "dynamicHelpActionText"; //$NON-NLS-1$
288     
289     /**
290      * A named preference for enabling animations when a layout transition occurs
291      * <p>
292      * The default value for this preference is: <code>true</code> (show animations when a transition occurs)
293      * </p>
294      * 
295      * @since 3.1
296      */
297     public static final String   ENABLE_ANIMATIONS = "ENABLE_ANIMATIONS"; //$NON-NLS-1$
298     
299     /**
300      * <p>
301      * Workbench preference id for the key configuration identifier to be
302      * treated as the default.
303      * </p>
304      * <p>
305      * The default value for this preference is
306      * <code>"org.eclipse.ui.defaultAcceleratorConfiguration"</code>.
307      * <p>
308      * 
309      * @since 3.1
310      */
311     public static final String   KEY_CONFIGURATION_ID = "KEY_CONFIGURATION_ID"; //$NON-NLS-1$
312     
313     /**
314      * <p>
315      * Workbench preference identifier for the minimum width of editor tabs. By
316      * default, Eclipse does not define this value and allows SWT to determine
317      * this constant. We use <code>-1</code> internally to signify "use
318      * default".
319      * </p>
320      * <p>
321      * The default value for this preference is <code>-1</code>.
322      * </p>
323      * 
324      * @since 3.1
325      */
326     public static final String   EDITOR_MINIMUM_CHARACTERS = "EDITOR_MINIMUM_CHARACTERS"; //$NON-NLS-1$
327 
328     /**
329      * <p>
330      * Workbench preference identifier for the minimum width of view tabs. 
331      * </p>
332      * <p>
333      * The default value for this preference is <code>1</code>.
334      * </p>
335      * 
336      * @since 3.2
337      */
338     public static final String   VIEW_MINIMUM_CHARACTERS = "VIEW_MINIMUM_CHARACTERS"; //$NON-NLS-1$
339     
340     /**
341      * Stores whether or not system jobs are being shown.
342      * 
343      * @since 3.1
344      */
345     public static final String   SHOW_SYSTEM_JOBS = "SHOW_SYSTEM_JOBS";//$NON-NLS-1$
346 
347     /**
348      * Workbench preference for the current theme.
349      * 
350      * @since 3.1
351      */
352     public static String   CURRENT_THEME_ID = "CURRENT_THEME_ID"; //$NON-NLS-1$
353 
354     /**
355      * A preference value indicating whether editors should be closed before saving 
356      * the workbench state when exiting.  The default is <code>false</code>.
357      * 
358      * @since 3.1
359      */
360     public static final String   CLOSE_EDITORS_ON_EXIT = "CLOSE_EDITORS_ON_EXIT"; //$NON-NLS-1$
361     
362     /**
363      * Stores whether or not to show progress while starting the workbench.
364      * The default is <code>false</code>.
365      * 
366      * @since 3.1
367      */
368     public static final String   SHOW_PROGRESS_ON_STARTUP = "SHOW_PROGRESS_ON_STARTUP"; //$NON-NLS-1$
369     
370     /**
371      * Stores whether or not to show the memory monitor in the workbench window.
372      * 
373      * @since 3.1
374      */
375     public static final String   SHOW_MEMORY_MONITOR = "SHOW_MEMORY_MONITOR"; //$NON-NLS-1$
376     
377     /**
378      * Stores whether or not to use the window working set as the default
379      * working set for newly created views (without previously stored state).
380      * This is a hint that view implementors should honor.
381      * 
382      * @since 3.2
383      */
384     public static final String   USE_WINDOW_WORKING_SET_BY_DEFAULT = "USE_WINDOW_WORKING_SET_BY_DEFAULT"; //$NON-NLS-1$
385     
386     /**
387      * Stores whether or not to show the text widget that allows type-ahead search 
388      * in the case where a FilteredTree is used to display and filter tree items.
389      * 
390      * @since 3.2
391      */
392     public static final String   SHOW_FILTERED_TEXTS = "SHOW_FILTERED_TEXTS"; //$NON-NLS-1$
393 
394     /**
395      * Stores whether or not views may be detached. The default is <code>true</code>.
396      * 
397      * @since 3.2
398      */
399     public static final String   ENABLE_DETACHED_VIEWS = "ENABLE_DETACHED_VIEWS"; //$NON-NLS-1$
400 
401     /**
402      * Stores whether or not the workbench prompts for saving when a dirty
403      * editor or view is closed, but the Saveable objects are still open in
404      * other parts. If
405      * <code>true<code> (default), the user will be prompted. If <code>false</code>, there will be
406      * no prompt.
407      * 
408      * @see Saveable
409      * @since 3.2
410      */
411     public static final String   PROMPT_WHEN_SAVEABLE_STILL_OPEN = "PROMPT_WHEN_SAVEABLE_STILL_OPEN"; //$NON-NLS-1$
412     
413     /**
414      * Lists the extra perspectives to show in the perspective bar.
415      * The value is a comma-separated list of perspective ids.
416      * The default is the empty string.
417      * 
418      * @since 3.2
419      */
420     public static final String   PERSPECTIVE_BAR_EXTRAS = "PERSPECTIVE_BAR_EXTRAS"; //$NON-NLS-1$
421 
422     /**
423      * Allows locking the trim to prevent user dragging on startup.
424      * The default is <code>false</code>.
425      * 
426      * @since 3.2
427      */
428     public static final String   LOCK_TRIM = "LOCK_TRIM"; //$NON-NLS-1$
429     
430     /**
431      * A named preference for providing the 3.3 presentation's min/max behaviour
432      * <p>
433      * The default value for this preference is: <code>false</code>; use the 3.2
434      * behaviour.
435      * </p>
436      * 
437      * @since 3.3
438      */
439     public static final String   ENABLE_NEW_MIN_MAX = "ENABLE_MIN_MAX"; //$NON-NLS-1$
440 
441     /**                                                                                   
442      * A named preference for disabling opening a new fast view
443      * from the fast view bar controls ("Show View as a fast view" button
444      * or "New Fast View" submenu).
445      * <p>
446      * Value is of type <code>boolean</code>.
447      * </p><p>
448      * The default is <code>false</code>.
449      * </p>
450      * 
451      * @since 3.3
452      */
453     public static final String   DISABLE_NEW_FAST_VIEW = "disableNewFastView"; //$NON-NLS-1$
454     
455     /**
456      * A named preference for enabling the 3.2 behavior for closing sticky views.
457      * When not enabled a sticky view is closed in all perspectives when the view is closed.
458      * <p>
459      * The default value for this preference is: <code>false</code>; use the 3.2
460      * behaviour.
461      * </p>
462      * 
463      * @since 3.3
464      */
465     public static final String   ENABLE_32_STICKY_CLOSE_BEHAVIOR = "ENABLE_32_STICKY_CLOSE_BEHAVIOR"; //$NON-NLS-1$
466 }
467
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags