Eclipse Platform
2.0

Package org.eclipse.ui

Application programming interfaces for interaction with and extension of the Eclipse Platform User Interface.

See:
          Description

Interface Summary
IActionBars Used by a part to access its menu, toolbar, and status line managers.
IActionDelegate Interface for actions contributed via an extension point.
IActionDelegateWithEvent This interface is a mixin interface for action delegates, adding the ability to examine the triggering SWT event when it is run.
IActionFilter An adapter which performs action filtering.
ICapabilityInstallWizard Interface for project capability install wizard.
ICapabilityUninstallWizard Interface for project capability uninstall wizard.
ICapabilityWizard Deprecated. use ICapabilityInstallWizard instead.
IContributorResourceAdapter 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.
IDecoratorManager Manages the decorators contributed via the decorators extension point.
IEditorActionBarContributor A editor action bar contributor defines the actions for one or more editors.
IEditorActionDelegate Interface for an action that is contributed into an editor-activated menu or tool bar.
IEditorDescriptor Description of an editor in the workbench editor registry.
IEditorInput IEditorInput is a light weight descriptor of editor input, like a file name but more abstract.
IEditorLauncher An editor launcher is used to launch external editors on an IFileinput.
IEditorPart An editor is a visual component within a workbench page.
IEditorReference Implements a reference to a editor.
IEditorRegistry Registry of editors known to the workbench.
IEditorSite The primary interface between an editor part and the outside world.
IElementFactory A factory for re-creating objects from a previously saved memento.
IExportWizard Interface for export wizards.
IFileEditorInput This interface defines a file-oriented input to an editor.
IFileEditorMapping An association between a file name/extension and a list of known editors for files of that type.
IFolderLayout An IFolderLayout is used to define the initial pages within a folder.
IImportWizard Interface for import wizards.
IKeyBindingService The key binding service is responsible for invoking an action when the action's sequence of accelerator keys is pressed.
IMarkerActionFilter Describes the public attributes for a marker and the acceptables values each may have.
IMarkerHelpRegistry Registry of F1 help contexts and resolutions for markers.
IMarkerResolution Resolution for a marker.
IMarkerResolutionGenerator Creates resolutions for a given marker.
IMemento Interface to a memento used for saving the important state of an object in a form that can be persisted in the file system.
INewWizard Interface for creation wizards.
INullSelectionListener Interface for listening to null selection changes.
IObjectActionDelegate Interface for an object action that is contributed into a popup menu for a view or editor.
IPageLayout A page layout defines the initial layout for a page in a workbench window.
IPageListener Interface for listening to page lifecycle events.
IPageService A page service tracks the page and perspective lifecycle events within a workbench window.
IPartListener Interface for listening to part lifecycle events.
IPartService A part service tracks the creation and activation of parts within a workbench page.
IPersistableElement Interface for asking an object to store its state in a memento.
IPerspectiveDescriptor A perspective descriptor describes a perspective in an IPerspectiveRegistry.
IPerspectiveFactory A perspective factory generates the initial page layout and visible action set for a page.
IPerspectiveListener Interface for listening to a perspective lifecycle events.
IPerspectiveRegistry The workbench's global registry of perspectives.
IPlaceholderFolderLayout An IPlaceholderFolderLayout is used to define the initial places for page placeholders within a folder placeholder.
IProjectActionFilter Describes the public attributes for a project and the acceptables values each may have.
IPropertyListener Interface for listening for property changes on an object.
IResourceActionFilter Describes the public attributes for a resource and the acceptables values each may have.
IReusableEditor Interface for reusable editors.
ISelectionListener Interface for listening to selection changes.
ISelectionService A selection service tracks the selection within an object.
ISharedImages A registry for common images used by the workbench which may be useful to other plug-ins.
IStartup Plugins 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.
IStorageEditorInput Interface for a IStorage input to an editor.
IViewActionDelegate Interface for an action that is contributed into a view's local tool bar, pulldown menu, or popup menu.
IViewPart A view is a visual component within a workbench page.
IViewReference Defines a reference to an IViewPart.
IViewSite The primary interface between a view part and the outside world.
IWindowListener Interface for listening to window lifecycle events.
IWorkbench A workbench is the root object for the Eclipse Platform user interface.
IWorkbenchActionConstants Action ids for standard actions, groups in the workbench menu bar, and global actions.
IWorkbenchPage A workbench page consists of an arrangement of views and editors intended to be presented together to the user in a single workbench window.
IWorkbenchPart A workbench part is a visual component within a workbench page.
IWorkbenchPartDescriptor Description of a workbench part.
IWorkbenchPartReference Implements a reference to a IWorkbenchPart.
IWorkbenchPartSite The primary interface between a workbench part and the outside world.
IWorkbenchPreferenceConstants Preference ids exposed by the Eclipse Platform User Interface.
IWorkbenchPreferencePage Interface for workbench preference pages.
IWorkbenchPropertyPage Interface for workbench property pages.
IWorkbenchSite The common interface between the workbench and its parts, including pages within parts.
IWorkbenchWindow A workbench window is a top level window in a workbench.
IWorkbenchWindowActionDelegate Interface for an action that is contributed into the workbench window menu or tool bar.
IWorkbenchWindowPulldownDelegate Interface for a pulldown action that is contributed into the workbench window tool bar.
IWorkbenchWindowPulldownDelegate2 Extension of IWorkbenchWindowPulldownDelegate that allows the delegate dropdown menu to be a child of a Menu item.
IWorkbenchWizard Implementors represent creation wizards that are to be contributed to the workbench's creation wizard extension point.
IWorkingSet A working set holds a number of IAdaptable elements.
IWorkingSetManager A working set manager stores working sets and provides property change notification when a working set is added or removed.
 

Class Summary
PlatformUI The central class for access to the Eclipse Platform User Interface.
ResourceWorkingSetFilter A resource working set filter filters resources from a view that * are neither a parent nor children of a working set element.
XMLMemento This class represents the default implementation of the IMemento interface.
 

Exception Summary
PartInitException A checked exception indicating a workbench part cannot be initialized correctly.
WorkbenchException A checked exception indicating a recoverable error occured internal to the workbench.
 

Package org.eclipse.ui Description

Application programming interfaces for interaction with and extension of the Eclipse Platform User Interface.

Package Specification

This 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 wzards, export wizards, etc.
 


Eclipse Platform
2.0

Copyright (c) IBM Corp. and others 2000, 2002. All Rights Reserved.