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.
Interface Summary Interface Description IActionBarsUsed by a part to access its menu, toolbar, and status line managers. IActionBars2Interface extention to
IActionBarsthat provides an additional cool bar manager.
IActionDelegateInterface for actions contributed via an extension point. IActionDelegate2Interface extension to
IActionDelegateadding lifecycle methods.
IActionDelegateWithEvent Deprecated.Use org.eclipse.ui.IActionDelegate2 instead. IActionFilterAn adapter which performs action filtering. IAggregateWorkingSetContains a set of
IContainmentAdapterThis adapter interface provides a way to test element containment in a model-independent way. IContributorResourceAdapterThe 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. IDecoratorManagerManages the decorators contributed via the
IEditorActionBarContributorA editor action bar contributor defines the actions for one or more editors. IEditorActionDelegateInterface for an action that is contributed into an editor-activated menu or tool bar. IEditorDescriptorDescription of an editor in the workbench editor registry. IEditorInput
IEditorInputis a light weight descriptor of editor input, like a file name but more abstract.
IEditorLauncherAn editor launcher is used to launch external editors on a file in the local file system. IEditorMatchingStrategyAn 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. IEditorPartAn editor is a visual component within a workbench page. IEditorReferenceImplements a reference to an editor. IEditorRegistryRegistry of editors known to the workbench. IEditorSiteThe primary interface between an editor part and the workbench. IElementFactoryA factory for re-creating objects from a previously saved memento. IExportWizardInterface for export wizards. IFileEditorInputThis interface defines a file-oriented input to an editor. IFileEditorMappingAn association between a file name/extension and a list of known editors for files of that type. IFolderLayoutAn
IFolderLayoutis used to define the initial views within a folder.
IImportWizardInterface for import wizards. IInPlaceEditorInterface for editor parts that represent an in-place style editor. IInPlaceEditorInputThis interface defines an editor input for in-place editors. IKeyBindingService Deprecated.See IContextService to manage scopes and IHandlerService to manage handlers. ILocalWorkingSetManagerA 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. IMarkerActionFilterDescribes the public attributes for a marker and the acceptable values each may have. IMarkerHelpContextProviderProvides a help context for a given marker. IMarkerHelpRegistryRegistry of F1 help contexts and resolutions for markers. IMarkerResolutionResolution for a marker. IMarkerResolution2Extends
IMarkerResolutionGeneratorCreates resolutions for a given marker. IMarkerResolutionGenerator2A 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.
IMarkerResolutionRelevanceA relevance for the marker resolution. IMementoInterface to a memento used for saving the important state of an object in a form that can be persisted in the file system. INavigationHistoryManages a list of entries to keep a history of locations on editors, enabling the user to go back and forward without losing context. INavigationLocationRepresents the context marked for the user in the navigation history. INavigationLocationProviderShould be implemented by editors that wish to contribute to the navigation history. INestableKeyBindingService Deprecated.This is now handled by
IServiceLocatorwhich can be nested.
INewWizardInterface for creation wizards. INullSelectionListenerInterface for listening to
IObjectActionDelegateInterface for an object action that is contributed into a popup menu for a view or editor. IPageLayoutA page layout defines the initial layout for a perspective within a page in a workbench window. IPageListenerInterface for listening to page lifecycle events. IPageServiceA page service tracks the page and perspective lifecycle events within a workbench window. IPartListenerInterface for listening to part lifecycle events. IPartListener2Interface for listening to part lifecycle events. IPartServiceA part service tracks the creation and activation of parts within a workbench page. IPathEditorInputThis interface defines an editor input based on the local file system path of a file. IPersistableObjects implementing this interface are capable of saving their state in an
IPersistableEditorAn editor can implement this interface and participate in the workbench session save/restore cycle using
IMemento, similar to how
IPersistableElementInterface for asking an object to store its state in a memento. IPerspectiveDescriptorA perspective descriptor describes a perspective in an
IPerspectiveFactoryA perspective factory generates the initial page layout and visible action set for a page. IPerspectiveListenerInterface for listening to perspective lifecycle events. IPerspectiveListener2Extension interface to
IPerspectiveListenerwhich adds support for listening to part-specific perspective lifecycle events.
IPerspectiveListener3Extension interface to
IPerspectiveListenerwhich adds support for listening to perspective open and close events.
IPerspectiveListener4Extension interface to
IPerspectiveListenerwhich adds support for listening to perspective pre-deactivate events.
IPerspectiveRegistryThe workbench's global registry of perspectives. IPlaceholderFolderLayoutAn
IPlaceholderFolderLayoutis used to define the initial view placeholders within a folder.
IPluginContributionAn interface that descriptor classes may implement in addition to their descriptor interface. IProjectActionFilterDescribes the public attributes for a project and the acceptable values each may have. IPropertyListenerInterface for listening for property changes on an object. IResourceActionFilterDescribes the public attributes for a resource and the acceptable values each may have. IReusableEditorInterface for reusable editors. ISaveableFilterA filter for selecting Saveables. ISaveablePartWorkbench parts implement or adapt to this interface to participate in the enablement and execution of the
ISaveablePart2Workbench 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. ISaveablesLifecycleListenerListener for events fired by implementers of
ISaveablesSourceRepresents a source of Saveable objects (units of saveability). ISecondarySaveableSourceInterface for parts providing an adapter to
ISaveablePartobjects created or managed originally by other parts.
ISelectionListenerInterface for listening to selection changes. ISelectionServiceA selection service tracks the selection within an object. ISharedImagesA registry for common images used by the workbench which may be useful to other plug-ins. IShowEditorInputShows the given editor input. ISizeProviderInterface implemented by objects that are capable of computing a preferred size. ISourceProviderA provider of notifications for when a change has occurred to a particular type of source. ISourceProviderListenerA listener to changes in a particular source of information. ISourcesA source is type of event change that can occur within the workbench. IStartupPlug-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. IStorageEditorInputInterface for a
IStorageinput to an editor.
IURIEditorInputThis interface defines an editor input based on a URI. IViewActionDelegateInterface for an action that is contributed into a view's local tool bar, pulldown menu, or popup menu. IViewLayoutRepresents the layout info for a view or placeholder in an
IViewPartA view is a visual component within a workbench page. IViewReferenceDefines a reference to an IViewPart. IViewSiteThe primary interface between a view part and the workbench. IWindowListenerInterface for listening to window lifecycle events. IWorkbenchA workbench is the root object for the Eclipse Platform user interface. IWorkbenchActionConstantsAction ids for standard actions, groups in the workbench menu bar, and global actions. IWorkbenchCommandConstantsConstants for all commands defined by the Eclipse workbench. IWorkbenchListenerInterface for listening to workbench lifecycle events. IWorkbenchPageA workbench page consists of an arrangement of views and editors intended to be presented together to the user in a single workbench window. IWorkbenchPartA workbench part is a visual component within a workbench page. IWorkbenchPart2Extends
IWorkbenchPart, adding the name and status text properties.
IWorkbenchPart3A part can provide arbitrary properties. IWorkbenchPartConstantsThis interface describes the constants used for
IWorkbenchPartDescriptorDescription of a workbench part. IWorkbenchPartReferenceImplements a reference to a IWorkbenchPart. IWorkbenchPartSiteThe primary interface between a workbench part and the workbench. IWorkbenchPreferenceConstantsPreference ids exposed by the Eclipse Platform User Interface. IWorkbenchPreferencePageInterface for workbench preference pages. IWorkbenchPropertyPageInterface for workbench property pages. IWorkbenchPropertyPageMultiThis interface is similar to
IWorkbenchPropertyPagewith the addition of support for multiple selection.
IWorkbenchSiteThe common interface between the workbench and its parts, including pages within parts. IWorkbenchWindowA workbench window is a top level window in a workbench. IWorkbenchWindowActionDelegateInterface for an action that is contributed into the workbench window menu or tool bar. IWorkbenchWindowPulldownDelegateInterface for a pulldown action that is contributed into the workbench window tool bar. IWorkbenchWindowPulldownDelegate2Extension of IWorkbenchWindowPulldownDelegate that allows the delegate dropdown menu to be a child of a Menu item. IWorkbenchWizardImplementors represent creation wizards that are to be contributed to the workbench's creation wizard extension point. IWorkingSetA working set holds a number of IAdaptable elements. IWorkingSetElementAdapterInterface that describes a mechanism that may be provided by working set extensions to help manage the addition of elements to working sets. IWorkingSetManagerA working set manager stores working sets and provides property change notification when a working set is added or removed. IWorkingSetUpdaterAn
IWorkingSetUpdatercan be used to dynamically update the content of a working set.
Class Summary Class Description AbstractSourceProviderAn implementation of
ISourceProviderthat provides listener support.
ActiveShellExpressionAn expression that checks the active shell variable. BasicWorkingSetElementAdapterBasic IWorkingSetElementAdapter implementation that allows plugins to describe simple declarative element adapters. ExtensionFactoryFactory for the workbench's public extensions. LegacyHandlerSubmissionExpressionAn expression encapsulating all of the information from legacy handler submissions. NavigationLocationDefault implementation of INavigationLocation. OpenAndLinkWithEditorHelperHelper for opening editors on the viewer's selection and link the selection with the editor. PerspectiveAdapterThis adapter class provides default implementations for the methods described by the
IPerspectiveListenerinterface and its extension interfaces.
PlatformUIThe central class for access to the Eclipse Platform User Interface. ResourceWorkingSetFilterA resource working set filter filters resources from a view that are neither a parent nor children of a working set element. SaveableA
Saveablerepresents a unit of saveability, e.g. an editable subset of the underlying domain model that may contain unsaved changes.
SaveablesLifecycleEventEvent object describing a change to a set of Saveable objects. SelectionEnablerDetermines the enablement status given a selection. SubActionBarsGeneric implementation of the
SubActionBars2A implementation of the extended
WorkbenchEncodingWorkbenchEncoding is a utility class for plug-ins that want to use the list of encodings defined by default in the workbench. XMLMementoThis class represents the default implementation of the
Exception Summary Exception Description MultiPartInitExceptionA checked exception indicating one or more workbench parts could not be initialized correctly. PartInitExceptionA checked exception indicating a workbench part cannot be initialized correctly. WorkbenchExceptionA checked exception indicating a recoverable error occured internal to the workbench.