org.eclipse.ui
Interface IWorkbenchPreferenceConstants


public interface IWorkbenchPreferenceConstants

Preference ids exposed by the Eclipse Platform User Interface. These org.eclipse.jface.preference settings can be obtained from the UI plug-in's org.eclipse.jface.preference store.

See Also:
PlatformUI.PLUGIN_ID, PlatformUI.getPreferenceStore()

Field Summary
static java.lang.String ALTERNATE_OPEN_NEW_PERSPECTIVE
          Deprecated. Workbench no longer supports alternate key modifier to open a new perspective. Callers should use IWorkbench.showPerspective methods.
static java.lang.String BOTTOM
          Constant to be used when referring to the bottom of the workbench org.eclipse.jface.window.
static java.lang.String CLOSE_EDITORS_ON_EXIT
          A org.eclipse.jface.preference value indicating whether editors should be closed before saving the workbench state when exiting.
static java.lang.String CURRENT_THEME_ID
          Workbench org.eclipse.jface.preference for the current theme.
static java.lang.String DEFAULT_PERSPECTIVE_ID
          A named org.eclipse.jface.preference indicating the default workbench perspective.
static java.lang.String DOCK_PERSPECTIVE_BAR
          A named org.eclipse.jface.preference indicating where the perspective bar should be docked.
static java.lang.String DYNAMIC_HELP_ACTION_TEXT
          A named org.eclipse.jface.preference for the text of the Dynamic Help action.
static java.lang.String EDITOR_MINIMUM_CHARACTERS
           Workbench org.eclipse.jface.preference identifier for the minimum width of editor tabs.
static java.lang.String ENABLE_ANIMATIONS
          A named org.eclipse.jface.preference for enabling animations when a layout transition occurs The default value for this org.eclipse.jface.preference is: true (show animations when a transition occurs)
static java.lang.String HELP_CONTENTS_ACTION_TEXT
          A named org.eclipse.jface.preference for the text of the Help Contents action.
static java.lang.String HELP_SEARCH_ACTION_TEXT
          A named org.eclipse.jface.preference for the text of the Help Search action.
static java.lang.String INITIAL_FAST_VIEW_BAR_LOCATION
          A named org.eclipse.jface.preference indicating where the fast view bar should be docked in a fresh workspace.
static java.lang.String KEY_CONFIGURATION_ID
           Workbench org.eclipse.jface.preference id for the key configuration identifier to be treated as the default.
static java.lang.String LEFT
          Constant to be used when referring to the left side of the workbench org.eclipse.jface.window.
static java.lang.String LINK_NAVIGATOR_TO_EDITOR
          A named org.eclipse.jface.preference for whether to show an editor when its input file is selected in the Navigator (and vice versa).
static java.lang.String NO_NEW_PERSPECTIVE
          A org.eclipse.jface.preference value indicating that an action should not open a new perspective.
static java.lang.String OPEN_NEW_PERSPECTIVE
          A named org.eclipse.jface.preference for how a new perspective is opened.
static java.lang.String OPEN_PERSPECTIVE_PAGE
          Deprecated. Opening a Perspective in a new page is no longer supported functionality as of 2.0.
static java.lang.String OPEN_PERSPECTIVE_REPLACE
          A org.eclipse.jface.preference value indicating that an action should open a new perspective by replacing the current perspective.
static java.lang.String OPEN_PERSPECTIVE_WINDOW
          A org.eclipse.jface.preference value indicating that an action should open a new perspective in a new org.eclipse.jface.window.
static java.lang.String PRESENTATION_FACTORY_ID
          A named org.eclipse.jface.preference indicating the presentation factory to use for the workbench look and feel.
static java.lang.String PROJECT_OPEN_NEW_PERSPECTIVE
          Deprecated. in 3.0. This org.eclipse.jface.preference is IDE-specific, and is therefore found only in IDE configurations. IDE-specific tools should use org.eclipse.ui.ide.IDE.Preferences.PROJECT_OPEN_NEW_PERSPECTIVE instead.
static java.lang.String RIGHT
          Constant to be used when referring to the right side of the workbench org.eclipse.jface.window.
static java.lang.String SHIFT_OPEN_NEW_PERSPECTIVE
          Deprecated. Workbench no longer supports shift key modifier to open a new perspective. Callers should use IWorkbench.showPerspective methods.
static java.lang.String SHOW_INTRO
          A named org.eclipse.jface.preference indicating whether the workbench should show the introduction component (if available) on startup.
static java.lang.String SHOW_SYSTEM_JOBS
           Stores whether or not system jobs are being shown.
static java.lang.String SHOW_TEXT_ON_PERSPECTIVE_BAR
          A named org.eclipse.jface.preference for whether the workbench should show text on the perspective bar.
static java.lang.String SHOW_TRADITIONAL_STYLE_TABS
          A named org.eclipse.jface.preference for whether the workbench should show traditional style tabs in editors and views.
static java.lang.String TOP_LEFT
          Constant to be used when referring to the top left of the workbench org.eclipse.jface.window.
static java.lang.String TOP_RIGHT
          Constant to be used when referring to the top right of the workbench org.eclipse.jface.window.
 

Field Detail

LINK_NAVIGATOR_TO_EDITOR

static final java.lang.String LINK_NAVIGATOR_TO_EDITOR
A named org.eclipse.jface.preference for whether to show an editor when its input file is selected in the Navigator (and vice versa).

Value is of type boolean.

See Also:
Constant Field Values

OPEN_NEW_PERSPECTIVE

static final java.lang.String OPEN_NEW_PERSPECTIVE
A named org.eclipse.jface.preference for how a new perspective is opened.

Value is of type String. The possible values are defined by OPEN_PERSPECTIVE_WINDOW, OPEN_PERSPECTIVE_PAGE and OPEN_PERSPECTIVE_REPLACE.

See Also:
OPEN_PERSPECTIVE_WINDOW, OPEN_PERSPECTIVE_PAGE, OPEN_PERSPECTIVE_REPLACE, NO_NEW_PERSPECTIVE, Constant Field Values

ALTERNATE_OPEN_NEW_PERSPECTIVE

static final java.lang.String ALTERNATE_OPEN_NEW_PERSPECTIVE
Deprecated. Workbench no longer supports alternate key modifier to open a new perspective. Callers should use IWorkbench.showPerspective methods.
A named org.eclipse.jface.preference for how a new perspective is opened when the alternate key modifiers are pressed. The alternate key modifiers are platform dependent.

Value is of type String. The possible values are defined by OPEN_PERSPECTIVE_WINDOW, OPEN_PERSPECTIVE_PAGE and OPEN_PERSPECTIVE_REPLACE.

See Also:
Constant Field Values

SHIFT_OPEN_NEW_PERSPECTIVE

static final java.lang.String SHIFT_OPEN_NEW_PERSPECTIVE
Deprecated. Workbench no longer supports shift key modifier to open a new perspective. Callers should use IWorkbench.showPerspective methods.
A named org.eclipse.jface.preference for how a new perspective is opened when the shift key modifier is pressed.

Value is of type String. The possible values are defined by OPEN_PERSPECTIVE_WINDOW, OPEN_PERSPECTIVE_PAGE and OPEN_PERSPECTIVE_REPLACE.

See Also:
Constant Field Values

PROJECT_OPEN_NEW_PERSPECTIVE

static final java.lang.String PROJECT_OPEN_NEW_PERSPECTIVE
Deprecated. in 3.0. This org.eclipse.jface.preference is IDE-specific, and is therefore found only in IDE configurations. IDE-specific tools should use org.eclipse.ui.ide.IDE.Preferences.PROJECT_OPEN_NEW_PERSPECTIVE instead.
A named org.eclipse.jface.preference for how a new perspective should be opened when a new project is created.

Value is of type String. The possible values are defined by the constants OPEN_PERSPECTIVE_WINDOW, OPEN_PERSPECTIVE_PAGE, OPEN_PERSPECTIVE_REPLACE, and NO_NEW_PERSPECTIVE.

See Also:
OPEN_PERSPECTIVE_WINDOW, OPEN_PERSPECTIVE_PAGE, OPEN_PERSPECTIVE_REPLACE, NO_NEW_PERSPECTIVE, Constant Field Values

OPEN_PERSPECTIVE_WINDOW

static final java.lang.String OPEN_PERSPECTIVE_WINDOW
A org.eclipse.jface.preference value indicating that an action should open a new perspective in a new org.eclipse.jface.window.

See Also:
PROJECT_OPEN_NEW_PERSPECTIVE, Constant Field Values

OPEN_PERSPECTIVE_PAGE

static final java.lang.String OPEN_PERSPECTIVE_PAGE
Deprecated. Opening a Perspective in a new page is no longer supported functionality as of 2.0.
A org.eclipse.jface.preference value indicating that an action should open a new perspective in a new page.

See Also:
PROJECT_OPEN_NEW_PERSPECTIVE, Constant Field Values

OPEN_PERSPECTIVE_REPLACE

static final java.lang.String OPEN_PERSPECTIVE_REPLACE
A org.eclipse.jface.preference value indicating that an action should open a new perspective by replacing the current perspective.

See Also:
PROJECT_OPEN_NEW_PERSPECTIVE, Constant Field Values

NO_NEW_PERSPECTIVE

static final java.lang.String NO_NEW_PERSPECTIVE
A org.eclipse.jface.preference value indicating that an action should not open a new perspective.

See Also:
PROJECT_OPEN_NEW_PERSPECTIVE, Constant Field Values

DEFAULT_PERSPECTIVE_ID

static final java.lang.String DEFAULT_PERSPECTIVE_ID
A named org.eclipse.jface.preference indicating the default workbench perspective.

See Also:
Constant Field Values

PRESENTATION_FACTORY_ID

static final java.lang.String PRESENTATION_FACTORY_ID
A named org.eclipse.jface.preference indicating the presentation factory to use for the workbench look and feel.

Since:
3.0
See Also:
Constant Field Values

DOCK_PERSPECTIVE_BAR

static final java.lang.String DOCK_PERSPECTIVE_BAR
A named org.eclipse.jface.preference indicating where the perspective bar should be docked. The default value (when this org.eclipse.jface.preference is not set) is TOP_RIGHT.

This org.eclipse.jface.preference may be one of the following values: TOP_RIGHT, TOP_LEFT, or LEFT.

Since:
3.0
See Also:
Constant Field Values

INITIAL_FAST_VIEW_BAR_LOCATION

static final java.lang.String INITIAL_FAST_VIEW_BAR_LOCATION
A named org.eclipse.jface.preference indicating where the fast view bar should be docked in a fresh workspace. This org.eclipse.jface.preference is meaningless after a workspace has been setup, since the fast view bar state is then persisted in the workbench. This org.eclipse.jface.preference is intended for applications that want the initial docking location to be somewhere specific. The default value (when this org.eclipse.jface.preference is not set) is the bottom.

Since:
3.0
See Also:
LEFT, BOTTOM, RIGHT, Constant Field Values

TOP_RIGHT

static final java.lang.String TOP_RIGHT
Constant to be used when referring to the top right of the workbench org.eclipse.jface.window.

Since:
3.0
See Also:
DOCK_PERSPECTIVE_BAR, Constant Field Values

TOP_LEFT

static final java.lang.String TOP_LEFT
Constant to be used when referring to the top left of the workbench org.eclipse.jface.window.

Since:
3.0
See Also:
DOCK_PERSPECTIVE_BAR, Constant Field Values

LEFT

static final java.lang.String LEFT
Constant to be used when referring to the left side of the workbench org.eclipse.jface.window.

Since:
3.0
See Also:
DOCK_PERSPECTIVE_BAR, INITIAL_FAST_VIEW_BAR_LOCATION, Constant Field Values

BOTTOM

static final java.lang.String BOTTOM
Constant to be used when referring to the bottom of the workbench org.eclipse.jface.window.

Since:
3.0
See Also:
INITIAL_FAST_VIEW_BAR_LOCATION, Constant Field Values

RIGHT

static final java.lang.String RIGHT
Constant to be used when referring to the right side of the workbench org.eclipse.jface.window.

Since:
3.0
See Also:
INITIAL_FAST_VIEW_BAR_LOCATION, Constant Field Values

SHOW_INTRO

static final java.lang.String SHOW_INTRO
A named org.eclipse.jface.preference indicating whether the workbench should show the introduction component (if available) on startup.

The default value for this org.eclipse.jface.preference is: true (show intro)

Since:
3.0
See Also:
WorkbenchWindowAdvisor.openIntro(), Constant Field Values

SHOW_TRADITIONAL_STYLE_TABS

static final java.lang.String SHOW_TRADITIONAL_STYLE_TABS
A named org.eclipse.jface.preference for whether the workbench should show traditional style tabs in editors and views. Boolean-valued: true if editors and views should use a traditional style of tab and false if editors should show new style tab (3.0 style)

The default value for this org.eclipse.jface.preference is: true

Since:
3.0
See Also:
Constant Field Values

SHOW_TEXT_ON_PERSPECTIVE_BAR

static final java.lang.String SHOW_TEXT_ON_PERSPECTIVE_BAR
A named org.eclipse.jface.preference for whether the workbench should show text on the perspective bar. Boolean-valued: true, if editors should show text on the perspective bar, false otherwise.

The default value for this org.eclipse.jface.preference is: true (show text on the perspective bar)

Since:
3.0
See Also:
Constant Field Values

HELP_CONTENTS_ACTION_TEXT

static final java.lang.String HELP_CONTENTS_ACTION_TEXT
A named org.eclipse.jface.preference for the text of the Help Contents action. String-valued. If not specified, "&Help Contents" is used.

The default value for this org.eclipse.jface.preference is: null

Since:
3.0
See Also:
Constant Field Values

HELP_SEARCH_ACTION_TEXT

static final java.lang.String HELP_SEARCH_ACTION_TEXT
A named org.eclipse.jface.preference for the text of the Help Search action. String-valued. If not specified, "S&earch" is used.

The default value for this org.eclipse.jface.preference is: null

Since:
3.1
See Also:
Constant Field Values

DYNAMIC_HELP_ACTION_TEXT

static final java.lang.String DYNAMIC_HELP_ACTION_TEXT
A named org.eclipse.jface.preference for the text of the Dynamic Help action. String-valued. If not specified, "&Dynamic Help" is used.

The default value for this org.eclipse.jface.preference is: null

Since:
3.1
See Also:
Constant Field Values

ENABLE_ANIMATIONS

static final java.lang.String ENABLE_ANIMATIONS
A named org.eclipse.jface.preference for enabling animations when a layout transition occurs

The default value for this org.eclipse.jface.preference is: true (show animations when a transition occurs)

Since:
3.1
See Also:
Constant Field Values

KEY_CONFIGURATION_ID

static final java.lang.String KEY_CONFIGURATION_ID

Workbench org.eclipse.jface.preference id for the key configuration identifier to be treated as the default.

The default value for this org.eclipse.jface.preference is "org.eclipse.ui.defaultAcceleratorConfiguration".

Since:
3.1
See Also:
Constant Field Values

EDITOR_MINIMUM_CHARACTERS

static final java.lang.String EDITOR_MINIMUM_CHARACTERS

Workbench org.eclipse.jface.preference identifier for the minimum width of editor tabs. By default, Eclipse does not define this value and allows SWT to determine this constant. We use -1 internally to signify "use default".

The default value for this org.eclipse.jface.preference is -1.

Since:
3.1
See Also:
Constant Field Values

SHOW_SYSTEM_JOBS

static final java.lang.String SHOW_SYSTEM_JOBS

Stores whether or not system jobs are being shown

.

Since:
3.1
See Also:
Constant Field Values

CURRENT_THEME_ID

static final java.lang.String CURRENT_THEME_ID
Workbench org.eclipse.jface.preference for the current theme.

Since:
3.1
See Also:
Constant Field Values

CLOSE_EDITORS_ON_EXIT

static final java.lang.String CLOSE_EDITORS_ON_EXIT
A org.eclipse.jface.preference value indicating whether editors should be closed before saving the workbench state when exiting. The default is false.

Since:
3.1
See Also:
Constant Field Values