public interface IWorkbenchPart extends IAdaptable
A view is typically used to navigate a hierarchy of information (like the workspace), open an editor, or display properties for the active editor. Modifications made in a view are saved immediately.
An editor is typically used to edit or browse a document or input object.
The input is identified using an
IEditorInput. Modifications made
in an editor part follow an open-save-close lifecycle model.
This interface may be implemented directly. For convenience, a base
implementation is defined in
The lifecycle of a workbench part is as follows:
part.createPartControl(parent)to create actual widgets
partOpenedevent to all listeners
partActivatedevent to all listeners
partClosedevent to all listeners
createPartControl has been called, the implementor may
safely reference the controls created. When the part is closed
these controls will be disposed as part of an SWT composite. This
occurs before the
IWorkbenchPart.dispose method is called.
If there is a need to free SWT resources the part should define a dispose
listener for its own control and free those resources from the dispose
listener. If the part invokes any method on the disposed SWT controls
after this point an
SWTError will be thrown.
The last method called on
This signals the end of the part lifecycle.
An important point to note about this lifecycle is that following a call to init, createPartControl may never be called. Thus in the dispose method, implementors must not assume controls were created.
Workbench parts implement the
IAdaptable interface; extensions
are managed by the platform's adapter manager.
|Modifier and Type||Field and Description|
The property id for
|Modifier and Type||Method and Description|
Adds a listener for changes to properties of this workbench part.
Creates the SWT controls for this workbench part.
Disposes of this workbench part.
Returns the site for this workbench part.
Returns the title of this workbench part.
Returns the title image of this workbench part.
Returns the title tool tip text of this workbench part.
Removes the given property listener from this workbench part.
Asks this part to take focus within the workbench.
static final int PROP_TITLE
void addPropertyListener(IPropertyListener listener)
The property ids are defined in
listener- a property listener
void createPartControl(Composite parent)
Clients should not call this method (the workbench calls this method when it needs to, which may be never).
For implementors this is a multi-step process:
parent- the parent control
This is the last method called on the
IWorkbenchPart. At this
point the part controls (if they were ever created) have been disposed as part
of an SWT composite. There is no guarantee that createPartControl() has been
called, so the part controls may never have been created.
Within this method a part may release any resources, fonts, images, etc. held by this part. It is also very important to deregister all listeners from the workbench.
Clients should not call this method (the workbench calls this method at appropriate times).
nullwhile the workbench part is being initialized. After the initialization is complete, this value must be non-
nullfor the remainder of the part's life cycle.
nullif the part has not yet been initialized
The title is used to populate the title bar of this part's visual container.
The title image is usually used to populate the title bar of this part's visual container. Since this image is managed by the part itself, callers must not dispose the returned image.
The tool tip text is used to populate the title bar of this part's visual container.
void removePropertyListener(IPropertyListener listener)
listener- a property listener
Clients should not call this method (the workbench calls this method at
appropriate times). To have the workbench activate a part, use
Copyright (c) 2000, 2013 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.