Eclipse eRCP
Release 1.1

Package org.eclipse.ui

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

See:
          Description

Interface Summary
IContainmentAdapter This adapter interface provides a way to test element containment in a model-independent way.
IElementFactory A factory for re-creating objects from a previously saved memento.
IFolderLayout An IFolderLayout is used to define the initial pages within a folder.
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.
INullSelectionListener Interface for listening to null selection changes.
IPageLayout A page layout defines the initial layout for a page in a workbench org.eclipse.jface.window.
IPageListener Interface for listening to page lifecycle events.
IPageService A page service tracks the page and perspective lifecycle events within a workbench org.eclipse.jface.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.
IPersistable Objects implementing this interface are capable of saving their state in an IMemento.
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 perspective lifecycle events.
IPerspectiveListener2 Extension interface to IPerspectiveListener which adds support for listening to part-specific perspective lifecycle events.
IPerspectiveListener3 Extension interface to IPerspectiveListener which adds support for listening to perspective open and close 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.
IPropertyListener Interface for listening for property changes on an object.
ISaveablePart Workbench parts implement or adapt to this interface to participate in the enablement and execution of the Save and Save As actions.
ISaveablePart2 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.
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.
ISizeProvider WARNING: EXPERIMENTAL!
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.
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 org.eclipse.jface.window lifecycle events.
IWorkbench A workbench is the root object for the Eclipse Platform user interface.
IWorkbenchPage A workbench page consists of an arrangement of views and editors intended to be presented together to the user in a single workbench org.eclipse.jface.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.
IWorkbenchSite The common interface between the workbench and its parts, including pages within parts.
IWorkbenchWindow A workbench org.eclipse.jface.window is a top level org.eclipse.jface.window in a workbench.
 

Class Summary
PartInitException A checked exception indicating a workbench part cannot be initialized correctly.
PerspectiveAdapter This adapter class provides default implementations for the methods described by the IPerspectiveListener interface and its extension interfaces.
PlatformUI The central class for access to the Eclipse Platform User Interface.
WorkbenchEncoding WorkbenchEncoding is a utility class for plug-ins that want to use the list of encodings defined by default in the workbench.
WorkbenchException A checked exception indicating a recoverable error occured internal to the workbench.
XMLMemento This class represents the default implementation of the IMemento interface.
 

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.
 


Eclipse eRCP
Release 1.1