Package SpecificationThis package provides application programming interfaces for interaction with and extension of the Eclipse Platform User Interface.
The PlatformUI class provides access to a single workbench. A workbench is the root object for the UI and has one or more workbench windows. Each workbench window has a collection of workbench pages, only one of which is active and visible to the end user. Each workbench page has a collection of workbench parts. A page's parts are arranged (tiled or stacked) for presentation on the screen. Within a page and its parts the user can interact with and modify a model (typically resources in a workspace). There are two kinds of workbench parts: views and editors. An editor is typically used to edit or browse a document or input object. A view is typically used to navigate a hierarchy of information (like the workspace), open an editor, or display properties for the active editor.
The platform creates a workbench when the workbench plug-in is activated. Since this happens at most once during the life of the running platform, there is only one workbench instance. Due to its singular nature, it is commonly referred to as the workbench.
Within a workbench the user will interact with many different resource
types. Because different tools are required for each, the workbench
defines a number of extension points which allow for the integration of
new tools. There are extension points for views, editors, action
sets, import wizards, export wizards, etc.
ClassDescriptionAn implementation of
ISourceProviderthat provides listener support.An expression that checks the active shell variable.Basic IWorkingSetElementAdapter implementation that allows plugins to describe simple declarative element adapters.Factory for the workbench's public extensions.Used by a part to access its menu, toolbar, and status line managers.Interface extention to
IActionBarsthat provides an additional cool bar manager.Interface for actions contributed via an extension point.Interface extension to
IActionDelegateadding lifecycle methods.Deprecated.Use org.eclipse.ui.IActionDelegate2 instead.An adapter which performs action filtering.Contains a set of
IWorkingSet.This adapter interface provides a way to test element containment in a model-independent way.The IContributorResourceAdapter is an interface that defines the API required to get a resource that an object adapts to for use of object contributions, decorators and property pages that have adaptable = true.Manages the decorators contributed via the
org.eclipse.ui.decoratorextension point.A editor action bar contributor defines the actions for one or more editors.Interface for an action that is contributed into an editor-activated menu or tool bar.Description of an editor in the workbench editor registry.
IEditorInputis a light weight descriptor of editor input, like a file name but more abstract.An editor launcher is used to launch external editors on a file in the local file system.An editor matching strategy allows editor extensions to provide their own algorithm for matching the input of an open editor of that type to a given editor input.An editor is a visual component within a workbench page.Implements a reference to an editor.Registry of editors known to the workbench.The primary interface between an editor part and the workbench.A factory for re-creating objects from a previously saved memento.Interface for export wizards.This interface defines a file-oriented input to an editor.An association between a file name/extension and a list of known editors for files of that type.An
IFolderLayoutis used to define the initial views within a folder.Interface for import wizards.Interface for editor parts that represent an in-place style editor.This interface defines an editor input for in-place editors.Deprecated.See IContextService to manage scopes and IHandlerService to manage handlers.A local working set manager can be used to manage a set of working sets independently from the working sets managed by the global working set manager.Describes the public attributes for a marker and the acceptable values each may have.Provides a help context for a given marker.Registry of F1 help contexts and resolutions for markers.Resolution for a marker.Extends
IMarkerResolution.Creates resolutions for a given marker.A marker resolution generator should implement this interface rather than
IMarkerResolutionGeneratorif it can determine whether a particular marker has any resolutions more efficiently than computing all the resolutions.A relevance for the marker resolution.Interface to a memento used for saving the important state of an object in a form that can be persisted in the file system.Manages a list of entries to keep a history of locations on editors, enabling the user to go back and forward without losing context.Represents the context marked for the user in the navigation history.Should be implemented by editors that wish to contribute to the navigation history.Deprecated.This is now handled by
IServiceLocatorwhich can be nested.Interface for creation wizards.Interface for listening to
nullselection changes.Interface for an object action that is contributed into a popup menu for a view or editor.A page layout defines the initial layout for a perspective within a page in a workbench window.Interface for listening to page lifecycle events.A page service tracks the page and perspective lifecycle events within a workbench window.Interface for listening to part lifecycle events.Interface for listening to part lifecycle events.A part service tracks the creation and activation of parts within a workbench page.This interface defines an editor input based on the local file system path of a file.Objects implementing this interface are capable of saving their state in an
IMemento.An editor can implement this interface and participate in the workbench session save/restore cycle using
IMemento, similar to how
IViewPartcurrently works.Interface for asking an object to store its state in a memento.A perspective descriptor describes a perspective in an
IPerspectiveRegistry.A perspective factory generates the initial page layout and visible action set for a page.Interface for listening to perspective lifecycle events.Extension interface to
IPerspectiveListenerwhich adds support for listening to part-specific perspective lifecycle events.Extension interface to
IPerspectiveListenerwhich adds support for listening to perspective open and close events.Extension interface to
IPerspectiveListenerwhich adds support for listening to perspective pre-deactivate events.The workbench's global registry of perspectives.An
IPlaceholderFolderLayoutis used to define the initial view placeholders within a folder.An interface that descriptor classes may implement in addition to their descriptor interface.Describes the public attributes for a project and the acceptable values each may have.Interface for listening for property changes on an object.Describes the public attributes for a resource and the acceptable values each may have.Interface for reusable editors.A filter for selecting Saveables.Workbench parts implement or adapt to this interface to participate in the enablement and execution of the
Save Asactions.Workbench parts implement or adapt to this interface to participate in actions that require a prompt for the user to provide input on what to do with unsaved data when the part is closed or the Workbench is shut down.Listener for events fired by implementers of
ISaveablesSource.Represents a source of Saveable objects (units of saveability).Interface for parts providing an adapter to
ISaveablePartobjects created or managed originally by other parts.Interface for listening to selection changes.A selection service tracks the selection within an object.A registry for common images used by the workbench which may be useful to other plug-ins.Shows the given editor input.Interface implemented by objects that are capable of computing a preferred size.A provider of notifications for when a change has occurred to a particular type of source.A listener to changes in a particular source of information.A source is type of event change that can occur within the workbench.Plug-ins that register a startup extension will be activated after the Workbench initializes and have an opportunity to run code that can't be implemented using the normal contribution mechanisms.Interface for a
IStorageinput to an editor.This interface defines an editor input based on a URI.Interface for an action that is contributed into a view's local tool bar, pulldown menu, or popup menu.Represents the layout info for a view or placeholder in an
IPageLayout.A view is a visual component within a workbench page.Defines a reference to an IViewPart.The primary interface between a view part and the workbench.Interface for listening to window lifecycle events.A workbench is the root object for the Eclipse Platform user interface.Action ids for standard actions, groups in the workbench menu bar, and global actions.Constants for all commands defined by the Eclipse workbench.Interface for listening to workbench lifecycle events.A workbench page consists of an arrangement of views and editors intended to be presented together to the user in a single workbench window.A workbench part is a visual component within a workbench page.Extends
IWorkbenchPart, adding the name and status text properties.A part can provide arbitrary properties.This interface describes the constants used for
IWorkbenchPartproperties.Description of a workbench part.Implements a reference to a IWorkbenchPart.The primary interface between a workbench part and the workbench.Preference ids exposed by the Eclipse Platform User Interface.Interface for workbench preference pages.Interface for workbench property pages.This interface is similar to
IWorkbenchPropertyPagewith the addition of support for multiple selection.The common interface between the workbench and its parts, including pages within parts.A workbench window is a top level window in a workbench.Interface for an action that is contributed into the workbench window menu or tool bar.Interface for a pulldown action that is contributed into the workbench window tool bar.Extension of IWorkbenchWindowPulldownDelegate that allows the delegate dropdown menu to be a child of a Menu item.Implementors represent creation wizards that are to be contributed to the workbench's creation wizard extension point.A working set holds a number of IAdaptable elements.Interface that describes a mechanism that may be provided by working set extensions to help manage the addition of elements to working sets.A working set manager stores working sets and provides property change notification when a working set is added or removed.An
IWorkingSetUpdatercan be used to dynamically update the content of a working set.
IWorkingSetUpdater2can be used to restore the content of a working set, if the working set content shouldn't be persisted by the framework.An expression encapsulating all of the information from legacy handler submissions.A checked exception indicating one or more workbench parts could not be initialized correctly.Default implementation of INavigationLocation.Helper for opening editors on the viewer's selection and link the selection with the editor.A checked exception indicating a workbench part cannot be initialized correctly.This adapter class provides default implementations for the methods described by the
IPerspectiveListenerinterface and its extension interfaces.The central class for access to the Eclipse Platform User Interface.A resource working set filter filters resources from a view that are neither a parent nor children of a working set element.A
Saveablerepresents a unit of saveability, e.g. an editable subset of the underlying domain model that may contain unsaved changes.Event object describing a change to a set of Saveable objects.Determines the enablement status given a selection.Selection listeners are notified of all selections in the workbench.A model containing selection values.Static class to hold the predicates for this factory.Generic implementation of the
IActionBarsinterface.A implementation of the extended
IActionBars2interface.WorkbenchEncoding is a utility class for plug-ins that want to use the list of encodings defined by default in the workbench.A checked exception indicating a recoverable error occured internal to the workbench.This class represents the default implementation of the