Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Eclipse Platform Release 3.0
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES

## 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.
IActionBars2 | Interface extention to `IActionBars` that provides an additional cool bar manager.
IActionDelegate | Interface for actions contributed via an extension point.
IActionDelegate2 | Interface extension to `IActionDelegate` adding lifecycle methods.
IActionDelegateWithEvent | Deprecated. Use org.eclipse.ui.IActionDelegate2 instead.
IActionFilter | An adapter which performs action filtering.
ICapabilityInstallWizard | Interface for project capability install wizard.
ICapabilityUninstallWizard | Interface for project capability uninstall wizard.
IContainmentAdapter | This adapter interface provides a way to test element containment in a model-independent way.
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 a file in the local file system.
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 workbench.
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.
IInPlaceEditor | Interface for editor parts that represent an in-place style editor.
IInPlaceEditorInput | This interface defines an editor input for in-place editors.
IKeyBindingService | The key binding service allows one to query or set the scope of Eclipse for the purposes of resolving key assignments to commands, and to register actions to handle specific commands.
IMarkerActionFilter | Describes the public attributes for a marker and the acceptable values each may have.
IMarkerHelpRegistry | Registry of F1 help contexts and resolutions for markers.
IMarkerResolution | Resolution for a marker.
IMarkerResolution2 | Extends `IMarkerResolution`.
IMarkerResolutionGenerator | Creates resolutions for a given marker.
IMarkerResolutionGenerator2 | A marker resolution generator should implement this interface rather than `IMarkerResolutionGenerator` if it can determine whether a particular marker has any resolutions more efficiently than computing all the resolutions.
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.
INavigationHistory | Manages a list of entries to keep history of locations on editors to enable the user to go back and forward without losing context.
INavigationLocation | Represents the context marked for the user in the navigation history.
INavigationLocationProvider | Should be implemented by editors that wish to contribute to the navigation history.
INestableKeyBindingService | A service that is capable of nesting other services within itself.
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.
IPartListener2 | Interface for listening to part lifecycle events.
IPartService | A part service tracks the creation and activation of parts within a workbench page.
IPathEditorInput | This interface defines an editor input based on the local file system path of a file.
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.
IPerspectiveListener2 | Extension interface to `IPerspectiveListener` which adds support for listening to part-specific 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.
IPluginContribution | An interface that descriptor classes may implement in addition to their descriptor interface.
IProjectActionFilter | Describes the public attributes for a project and the acceptable values each may have.
IPropertyListener | Interface for listening for property changes on an object.
IResourceActionFilter | Describes the public attributes for a resource and the acceptable values each may have.
IReusableEditor | Interface for reusable editors.
ISaveablePart | Workbench parts implement or adapt to this interface to participate in the enablement and execution of the `Save` and `Save As` actions.
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 | 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.
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.
IViewLayout | Represents the layout info for a view or placeholder in an `IPageLayout`.
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 workbench.
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.
IWorkbenchPart2 | Extends `IWorkbenchPart`, adding the name and status text properties.
IWorkbenchPartConstants | This interface describes the constants used for IWorkbenchPart properties
IWorkbenchPartDescriptor | Description of a workbench part.
IWorkbenchPartReference | Implements a reference to a IWorkbenchPart.
IWorkbenchPartSite | The primary interface between a workbench part and the workbench.
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
NavigationLocation | Default implementation of INavigationLocation.
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.
SelectionEnabler | Determines the enablement status given a selection.
SelectionEnabler.SelectionClass |
SubActionBars | Generic implementation of the `IActionBars` interface.
SubActionBars2 | A implementation of the extended `IActionBars2` interface.
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 wizards, export wizards, etc.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Eclipse Platform Release 3.0
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.