001: /*******************************************************************************
002: * Copyright (c) 2000, 2007 IBM Corporation and others.
003: * All rights reserved. This program and the accompanying materials
004: * are made available under the terms of the Eclipse Public License v1.0
005: * which accompanies this distribution, and is available at
006: * http://www.eclipse.org/legal/epl-v10.html
007: *
008: * Contributors:
009: * IBM Corporation - initial API and implementation
010: * Kiryl Kazakevich, Intel - bug 88359
011: * Tonny Madsen, RCP Company - bug 201055
012: *******************************************************************************/package org.eclipse.ui;
013:
014: /**
015: * Preference ids exposed by the Eclipse Platform User Interface.
016: * These preference settings can be obtained from the UI plug-in's
017: * preference store.
018: *
019: * @see PlatformUI#PLUGIN_ID
020: * @see PlatformUI#getPreferenceStore()
021: */
022: public interface IWorkbenchPreferenceConstants {
023:
024: /**
025: * A named preference for whether to show an editor when its
026: * input file is selected in the Navigator (and vice versa).
027: * <p>
028: * Value is of type <code>boolean</code>.
029: * </p>
030: */
031: public static final String LINK_NAVIGATOR_TO_EDITOR = "LINK_NAVIGATOR_TO_EDITOR"; //$NON-NLS-1$
032:
033: /**
034: * A named preference for how a new perspective is opened.
035: * <p>
036: * Value is of type <code>String</code>. The possible values are defined
037: * by <code>OPEN_PERSPECTIVE_WINDOW, OPEN_PERSPECTIVE_PAGE and
038: * OPEN_PERSPECTIVE_REPLACE</code>.
039: * </p>
040: *
041: * @see #OPEN_PERSPECTIVE_WINDOW
042: * @see #OPEN_PERSPECTIVE_PAGE
043: * @see #OPEN_PERSPECTIVE_REPLACE
044: * @see #NO_NEW_PERSPECTIVE
045: */
046: public static final String OPEN_NEW_PERSPECTIVE = "OPEN_NEW_PERSPECTIVE"; //$NON-NLS-1$
047:
048: /**
049: * A named preference for how a new perspective is opened
050: * when the alternate key modifiers are pressed. The alternate key modifiers
051: * are platform dependent.
052: * <p>
053: * Value is of type <code>String</code>. The possible values are defined
054: * by <code>OPEN_PERSPECTIVE_WINDOW, OPEN_PERSPECTIVE_PAGE and
055: * OPEN_PERSPECTIVE_REPLACE</code>.
056: * </p>
057: * @deprecated Workbench no longer supports alternate key modifier to open
058: * a new perspective. Callers should use IWorkbench.showPerspective methods.
059: */
060: public static final String ALTERNATE_OPEN_NEW_PERSPECTIVE = "ALTERNATE_OPEN_NEW_PERSPECTIVE"; //$NON-NLS-1$
061:
062: /**
063: * A named preference for how a new perspective is opened
064: * when the shift key modifier is pressed.
065: * <p>
066: * Value is of type <code>String</code>. The possible values are defined
067: * by <code>OPEN_PERSPECTIVE_WINDOW, OPEN_PERSPECTIVE_PAGE and
068: * OPEN_PERSPECTIVE_REPLACE</code>.
069: * </p>
070: *
071: * @deprecated Workbench no longer supports shift key modifier to open
072: * a new perspective. Callers should use IWorkbench.showPerspective methods.
073: */
074: public static final String SHIFT_OPEN_NEW_PERSPECTIVE = "SHIFT_OPEN_NEW_PERSPECTIVE"; //$NON-NLS-1$
075:
076: /**
077: * A named preference for how a new perspective should be opened
078: * when a new project is created.
079: * <p>
080: * Value is of type <code>String</code>. The possible values are defined
081: * by the constants <code>OPEN_PERSPECTIVE_WINDOW, OPEN_PERSPECTIVE_PAGE,
082: * OPEN_PERSPECTIVE_REPLACE, and NO_NEW_PERSPECTIVE</code>.
083: * </p>
084: *
085: * @see #OPEN_PERSPECTIVE_WINDOW
086: * @see #OPEN_PERSPECTIVE_PAGE
087: * @see #OPEN_PERSPECTIVE_REPLACE
088: * @see #NO_NEW_PERSPECTIVE
089: * @deprecated in 3.0. This preference is IDE-specific, and is therefore found
090: * only in IDE configurations. IDE-specific tools should use
091: * <code>org.eclipse.ui.ide.IDE.Preferences.PROJECT_OPEN_NEW_PERSPECTIVE</code>
092: * instead.
093: */
094: public static final String PROJECT_OPEN_NEW_PERSPECTIVE = "PROJECT_OPEN_NEW_PERSPECTIVE"; //$NON-NLS-1$
095:
096: /**
097: * A preference value indicating that an action should open a new
098: * perspective in a new window.
099: *
100: * @see #PROJECT_OPEN_NEW_PERSPECTIVE
101: */
102: public static final String OPEN_PERSPECTIVE_WINDOW = "OPEN_PERSPECTIVE_WINDOW"; //$NON-NLS-1$
103:
104: /**
105: * A preference value indicating that an action should open a new
106: * perspective in a new page.
107: *
108: * @see #PROJECT_OPEN_NEW_PERSPECTIVE
109: * @deprecated Opening a Perspective in a new page is no longer
110: * supported functionality as of 2.0.
111: */
112: public static final String OPEN_PERSPECTIVE_PAGE = "OPEN_PERSPECTIVE_PAGE"; //$NON-NLS-1$
113:
114: /**
115: * A preference value indicating that an action should open a new
116: * perspective by replacing the current perspective.
117: *
118: * @see #PROJECT_OPEN_NEW_PERSPECTIVE
119: */
120: public static final String OPEN_PERSPECTIVE_REPLACE = "OPEN_PERSPECTIVE_REPLACE"; //$NON-NLS-1$
121:
122: /**
123: * A preference value indicating that an action should not open a
124: * new perspective.
125: *
126: * @see #PROJECT_OPEN_NEW_PERSPECTIVE
127: */
128: public static final String NO_NEW_PERSPECTIVE = "NO_NEW_PERSPECTIVE"; //$NON-NLS-1$
129:
130: /**
131: * A named preference indicating the default workbench perspective.
132: */
133: public static final String DEFAULT_PERSPECTIVE_ID = "defaultPerspectiveId"; //$NON-NLS-1$
134:
135: /**
136: * A named preference indicating the presentation factory
137: * to use for the workbench look and feel.
138: *
139: * @since 3.0
140: */
141: public static final String PRESENTATION_FACTORY_ID = "presentationFactoryId"; //$NON-NLS-1$
142:
143: /**
144: * A named preference indicating where the perspective bar should be docked.
145: * The default value (when this preference is not set) is <code>TOP_RIGHT</code>.
146: * <p>
147: * This preference may be one of the following values:
148: * {@link #TOP_RIGHT}, {@link #TOP_LEFT}, or {@link #LEFT}.
149: * </p>
150: *
151: * @since 3.0
152: */
153: public static String DOCK_PERSPECTIVE_BAR = "DOCK_PERSPECTIVE_BAR"; //$NON-NLS-1$
154:
155: /**
156: * A named preference indicating where the fast view bar should be docked in a
157: * fresh workspace. This preference is meaningless after a workspace has been
158: * setup, since the fast view bar state is then persisted in the workbench. This
159: * preference is intended for applications that want the initial docking location
160: * to be somewhere specific. The default value (when this preference is not set)
161: * is the bottom.
162: *
163: * @see #LEFT
164: * @see #BOTTOM
165: * @see #RIGHT
166: * @since 3.0
167: */
168: public static final String INITIAL_FAST_VIEW_BAR_LOCATION = "initialFastViewBarLocation"; //$NON-NLS-1$
169:
170: /**
171: * Constant to be used when referring to the top right of the workbench window.
172: *
173: * @see #DOCK_PERSPECTIVE_BAR
174: * @since 3.0
175: */
176: public static final String TOP_RIGHT = "topRight"; //$NON-NLS-1$
177:
178: /**
179: * Constant to be used when referring to the top left of the workbench window.
180: *
181: * @see #DOCK_PERSPECTIVE_BAR
182: * @since 3.0
183: */
184: public static final String TOP_LEFT = "topLeft"; //$NON-NLS-1$
185:
186: /**
187: * Constant to be used when referring to the left side of the workbench window.
188: *
189: * @see #DOCK_PERSPECTIVE_BAR
190: * @see #INITIAL_FAST_VIEW_BAR_LOCATION
191: * @since 3.0
192: */
193: public static final String LEFT = "left"; //$NON-NLS-1$
194:
195: /**
196: * Constant to be used when referring to the bottom of the workbench window.
197: *
198: * @see #INITIAL_FAST_VIEW_BAR_LOCATION
199: * @since 3.0
200: */
201: public static final String BOTTOM = "bottom"; //$NON-NLS-1$
202:
203: /**
204: * Constant to be used when referring to the right side of the workbench window.
205: *
206: * @see #INITIAL_FAST_VIEW_BAR_LOCATION
207: * @since 3.0
208: */
209: public static final String RIGHT = "right"; //$NON-NLS-1$
210:
211: /**
212: * A named preference indicating whether the workbench should show the
213: * introduction component (if available) on startup.
214: *
215: * <p>
216: * The default value for this preference is: <code>true</code> (show intro)
217: * </p>
218: *
219: * @see org.eclipse.ui.application.WorkbenchWindowAdvisor#openIntro()
220: * @since 3.0
221: */
222: public static final String SHOW_INTRO = "showIntro"; //$NON-NLS-1$
223:
224: /**
225: * A named preference for whether the workbench should show traditional style tabs in
226: * editors and views.
227: *
228: * Boolean-valued: <code>true</code> if editors and views should use a traditional style of tab and
229: * <code>false</code> if editors should show new style tab (3.0 style)
230: * <p>
231: * The default value for this preference is: <code>true</code>
232: * </p>
233: *
234: * @since 3.0
235: */
236: public static String SHOW_TRADITIONAL_STYLE_TABS = "SHOW_TRADITIONAL_STYLE_TABS"; //$NON-NLS-1$
237:
238: /**
239: * A named preference for whether the workbench should show text
240: * on the perspective bar.
241: *
242: * Boolean-valued: <code>true</code>, if editors should show text on the perspective bar,
243: * <code>false</code> otherwise.
244: * <p>
245: * The default value for this preference is: <code>true</code> (show text on the perspective bar)
246: * </p>
247: *
248: * @since 3.0
249: */
250: public static String SHOW_TEXT_ON_PERSPECTIVE_BAR = "SHOW_TEXT_ON_PERSPECTIVE_BAR"; //$NON-NLS-1$
251:
252: /**
253: * A named preference for whether the workbench should show the "open perspective" button
254: * on the perspective bar.
255: *
256: * Boolean-valued: <code>true</code>, if editors should show "open perspective" button on the perspective bar,
257: * <code>false</code> otherwise.
258: * <p>
259: * The default value for this preference is: <code>true</code>
260: * (show "open perspective" button on the perspective bar)
261: * </p>
262: *
263: * @since 3.4
264: */
265: public static String SHOW_OPEN_ON_PERSPECTIVE_BAR = "SHOW_OPEN_ON_PERSPECTIVE_BAR"; //$NON-NLS-1$
266:
267: /**
268: * A named preference for whether the workbench should show the "Other..." menu item
269: * in the perspective menu.
270: *
271: * Boolean-valued: <code>true</code>, if editors should show text on the "Other..." menu item,
272: * <code>false</code> otherwise.
273: * <p>
274: * The default value for this preference is: <code>true</code> (show the "Other..." menu
275: * item in the perspective menu)
276: * </p>
277: *
278: * @since 3.4
279: */
280: public static String SHOW_OTHER_IN_PERSPECTIVE_MENU = "SHOW_OTHER_IN_PERSPECTIVE_MENU"; //$NON-NLS-1$
281:
282: /**
283: * A named preference for the text of the Help Contents action.
284: *
285: * String-valued. If not specified, <code>"&Help Contents"</code> is used.
286: * <p>
287: * The default value for this preference is: <code>null</code>
288: * </p>
289: *
290: * @since 3.0
291: */
292: public static String HELP_CONTENTS_ACTION_TEXT = "helpContentsActionText"; //$NON-NLS-1$
293:
294: /**
295: * A named preference for the text of the Help Search action.
296: *
297: * String-valued. If not specified, <code>"S&earch"</code> is used.
298: * <p>
299: * The default value for this preference is: <code>null</code>
300: * </p>
301: *
302: * @since 3.1
303: */
304: public static String HELP_SEARCH_ACTION_TEXT = "helpSearchActionText"; //$NON-NLS-1$
305:
306: /**
307: * A named preference for the text of the Dynamic Help action.
308: *
309: * String-valued. If not specified, <code>"&Dynamic Help"</code> is used.
310: * <p>
311: * The default value for this preference is: <code>null</code>
312: * </p>
313: *
314: * @since 3.1
315: */
316: public static String DYNAMIC_HELP_ACTION_TEXT = "dynamicHelpActionText"; //$NON-NLS-1$
317:
318: /**
319: * A named preference for enabling animations when a layout transition occurs
320: * <p>
321: * The default value for this preference is: <code>true</code> (show animations when a transition occurs)
322: * </p>
323: *
324: * @since 3.1
325: */
326: public static final String ENABLE_ANIMATIONS = "ENABLE_ANIMATIONS"; //$NON-NLS-1$
327:
328: /**
329: * <p>
330: * Workbench preference id for the key configuration identifier to be
331: * treated as the default.
332: * </p>
333: * <p>
334: * The default value for this preference is
335: * <code>"org.eclipse.ui.defaultAcceleratorConfiguration"</code>.
336: * <p>
337: *
338: * @since 3.1
339: */
340: public static final String KEY_CONFIGURATION_ID = "KEY_CONFIGURATION_ID"; //$NON-NLS-1$
341:
342: /**
343: * <p>
344: * Workbench preference identifier for the minimum width of editor tabs. By
345: * default, Eclipse does not define this value and allows SWT to determine
346: * this constant. We use <code>-1</code> internally to signify "use
347: * default".
348: * </p>
349: * <p>
350: * The default value for this preference is <code>-1</code>.
351: * </p>
352: *
353: * @since 3.1
354: */
355: public static final String EDITOR_MINIMUM_CHARACTERS = "EDITOR_MINIMUM_CHARACTERS"; //$NON-NLS-1$
356:
357: /**
358: * <p>
359: * Workbench preference identifier for the minimum width of view tabs.
360: * </p>
361: * <p>
362: * The default value for this preference is <code>1</code>.
363: * </p>
364: *
365: * @since 3.2
366: */
367: public static final String VIEW_MINIMUM_CHARACTERS = "VIEW_MINIMUM_CHARACTERS"; //$NON-NLS-1$
368:
369: /**
370: * Stores whether or not system jobs are being shown.
371: *
372: * @since 3.1
373: */
374: public static final String SHOW_SYSTEM_JOBS = "SHOW_SYSTEM_JOBS";//$NON-NLS-1$
375:
376: /**
377: * Workbench preference for the current theme.
378: *
379: * @since 3.1
380: */
381: public static String CURRENT_THEME_ID = "CURRENT_THEME_ID"; //$NON-NLS-1$
382:
383: /**
384: * A preference value indicating whether editors should be closed before saving
385: * the workbench state when exiting. The default is <code>false</code>.
386: *
387: * @since 3.1
388: */
389: public static final String CLOSE_EDITORS_ON_EXIT = "CLOSE_EDITORS_ON_EXIT"; //$NON-NLS-1$
390:
391: /**
392: * Stores whether or not to show progress while starting the workbench.
393: * The default is <code>false</code>.
394: *
395: * @since 3.1
396: */
397: public static final String SHOW_PROGRESS_ON_STARTUP = "SHOW_PROGRESS_ON_STARTUP"; //$NON-NLS-1$
398:
399: /**
400: * Stores whether or not to show the memory monitor in the workbench window.
401: *
402: * @since 3.1
403: */
404: public static final String SHOW_MEMORY_MONITOR = "SHOW_MEMORY_MONITOR"; //$NON-NLS-1$
405:
406: /**
407: * Stores whether or not to use the window working set as the default
408: * working set for newly created views (without previously stored state).
409: * This is a hint that view implementors should honor.
410: *
411: * @since 3.2
412: */
413: public static final String USE_WINDOW_WORKING_SET_BY_DEFAULT = "USE_WINDOW_WORKING_SET_BY_DEFAULT"; //$NON-NLS-1$
414:
415: /**
416: * Stores whether or not to show the text widget that allows type-ahead search
417: * in the case where a FilteredTree is used to display and filter tree items.
418: *
419: * @since 3.2
420: */
421: public static final String SHOW_FILTERED_TEXTS = "SHOW_FILTERED_TEXTS"; //$NON-NLS-1$
422:
423: /**
424: * Stores whether or not views may be detached. The default is <code>true</code>.
425: *
426: * @since 3.2
427: */
428: public static final String ENABLE_DETACHED_VIEWS = "ENABLE_DETACHED_VIEWS"; //$NON-NLS-1$
429:
430: /**
431: * Stores whether or not the workbench prompts for saving when a dirty
432: * editor or view is closed, but the Saveable objects are still open in
433: * other parts. If
434: * <code>true<code> (default), the user will be prompted. If <code>false</code>, there will be
435: * no prompt.
436: *
437: * @see Saveable
438: * @since 3.2
439: */
440: public static final String PROMPT_WHEN_SAVEABLE_STILL_OPEN = "PROMPT_WHEN_SAVEABLE_STILL_OPEN"; //$NON-NLS-1$
441:
442: /**
443: * Lists the extra perspectives to show in the perspective bar.
444: * The value is a comma-separated list of perspective ids.
445: * The default is the empty string.
446: *
447: * @since 3.2
448: */
449: public static final String PERSPECTIVE_BAR_EXTRAS = "PERSPECTIVE_BAR_EXTRAS"; //$NON-NLS-1$
450:
451: /**
452: * Allows locking the trim to prevent user dragging on startup.
453: * The default is <code>false</code>.
454: *
455: * @since 3.2
456: */
457: public static final String LOCK_TRIM = "LOCK_TRIM"; //$NON-NLS-1$
458:
459: /**
460: * A named preference for providing the 3.3 presentation's min/max behaviour
461: * <p>
462: * The default value for this preference is: <code>false</code>; use the 3.2
463: * behaviour.
464: * </p>
465: *
466: * @since 3.3
467: */
468: public static final String ENABLE_NEW_MIN_MAX = "ENABLE_MIN_MAX"; //$NON-NLS-1$
469:
470: /**
471: * A named preference for disabling opening a new fast view
472: * from the fast view bar controls ("Show View as a fast view" button
473: * or "New Fast View" submenu).
474: * <p>
475: * Value is of type <code>boolean</code>.
476: * </p><p>
477: * The default is <code>false</code>.
478: * </p>
479: *
480: * @since 3.3
481: */
482: public static final String DISABLE_NEW_FAST_VIEW = "disableNewFastView"; //$NON-NLS-1$
483:
484: /**
485: * A named preference for enabling the 3.2 behavior for closing sticky views.
486: * When not enabled a sticky view is closed in all perspectives when the view is closed.
487: * <p>
488: * The default value for this preference is: <code>false</code>; use the 3.2
489: * behaviour.
490: * </p>
491: *
492: * @since 3.3
493: */
494: public static final String ENABLE_32_STICKY_CLOSE_BEHAVIOR = "ENABLE_32_STICKY_CLOSE_BEHAVIOR"; //$NON-NLS-1$
495: }
|