public abstract class WorkbenchPart extends EventManager implements IWorkbenchPart2, IExecutableExtension, IWorkbenchPartOrientation
This class is not intended to be subclassed by clients outside this
package; clients should instead subclass ViewPart or
EditorPart.
ViewPart,
EditorPartPROP_TITLE| Modifier | Constructor and Description |
|---|---|
protected |
WorkbenchPart()
Creates a new workbench part.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addPropertyListener(IPropertyListener l)
Adds a listener for changes to properties of this workbench part.
|
protected void |
checkSite(IWorkbenchPartSite site)
Checks that the given site is valid for this type of part.
|
abstract void |
createPartControl(Composite parent)
Creates the SWT controls for this workbench part.
|
void |
dispose()
The
WorkbenchPart implementation of this
IWorkbenchPart method disposes the title image
loaded by setInitializationData. |
protected void |
firePropertyChange(int propertyId)
Fires a property changed event.
|
Object |
getAdapter(Class adapter)
Returns an object which is an instance of the given class
associated with this object.
|
protected IConfigurationElement |
getConfigurationElement()
Returns the configuration element for this part.
|
String |
getContentDescription()
Returns the content description of this part.
|
protected Image |
getDefaultImage()
Returns the default title image.
|
int |
getOrientation()
Return the orientation of this part.
|
String |
getPartName()
Returns the name of this part.
|
IWorkbenchPartSite |
getSite()
Returns the site for this workbench part.
|
String |
getTitle()
Returns the title of this workbench part.
|
Image |
getTitleImage()
Returns the title image of this workbench part.
|
String |
getTitleToolTip()
Returns the title tool tip text of this workbench part.
|
void |
removePropertyListener(IPropertyListener l)
Removes the given property listener from this workbench part.
|
protected void |
setContentDescription(String description)
Sets the content description for this part.
|
abstract void |
setFocus()
Asks this part to take focus within the workbench.
|
void |
setInitializationData(IConfigurationElement cfig,
String propertyName,
Object data)
This method is called by the implementation of the method
IConfigurationElement.createExecutableExtension
on a newly constructed extension, passing it its relevant configuration
information. |
protected void |
setPartName(String partName)
Sets the name of this part.
|
protected void |
setSite(IWorkbenchPartSite site)
Sets the part site.
|
protected void |
setTitle(String title)
Deprecated.
new code should use setPartName and setContentDescription
|
protected void |
setTitleImage(Image titleImage)
Sets or clears the title image of this part.
|
protected void |
setTitleToolTip(String toolTip)
Sets or clears the title tool tip text of this part.
|
void |
showBusy(boolean busy)
Show that this part is busy due to a Job running that it
is listening to.
|
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObjectpublic void addPropertyListener(IPropertyListener l)
IWorkbenchPart
The property ids are defined in IWorkbenchPartConstants.
addPropertyListener in interface IWorkbenchPartl - a property listenerpublic abstract void createPartControl(Composite parent)
IWorkbenchPartClients 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:
IActionBars.ISelectionService (optional). createPartControl in interface IWorkbenchPartparent - the parent controlpublic void dispose()
WorkbenchPart implementation of this
IWorkbenchPart method disposes the title image
loaded by setInitializationData. Subclasses may extend.dispose in interface IWorkbenchPartprotected void firePropertyChange(int propertyId)
propertyId - the id of the property that changedpublic Object getAdapter(Class adapter)
null if
no such object can be found.
Subclasses may override this method (however, if they do so, they
should invoke the method on their superclass to ensure that the
Platform's adapter manager is consulted).getAdapter in interface IAdaptableadapter - the adapter class to look upnull if this object does not
have an adapter for the given classprotected IConfigurationElement getConfigurationElement()
protected Image getDefaultImage()
public IWorkbenchPartSite getSite()
IWorkbenchPartnull while the workbench part is being initialized. After
the initialization is complete, this value must be non-null
for the remainder of the part's life cycle.getSite in interface IWorkbenchPartnull if the part
has not yet been initializedpublic String getTitle()
PROP_TITLE.
The title is used to populate the title bar of this part's visual container.
It is considered bad practise to overload or extend this method. Parts should set their title by calling setPartName and/or setContentDescription.
getTitle in interface IWorkbenchPartnull)public Image getTitleImage()
IWorkbenchPartPROP_TITLE.
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.
getTitleImage in interface IWorkbenchPartpublic String getTitleToolTip()
IWorkbenchPartPROP_TITLE.
The tool tip text is used to populate the title bar of this part's visual container.
getTitleToolTip in interface IWorkbenchPartnull)public void removePropertyListener(IPropertyListener l)
IWorkbenchPartremovePropertyListener in interface IWorkbenchPartl - a property listenerpublic abstract void setFocus()
IWorkbenchPart
Clients should not call this method (the workbench calls this method at
appropriate times). To have the workbench activate a part, use
IWorkbenchPage.activate(IWorkbenchPart) instead.
setFocus in interface IWorkbenchPartpublic void setInitializationData(IConfigurationElement cfig, String propertyName, Object data)
IConfigurationElement.createExecutableExtension
on a newly constructed extension, passing it its relevant configuration
information. Most executable extensions only make use of the first
two call arguments.
Regular executable extensions specify their Java implementation class name as an attribute of the configuration element for the extension. For example
<action run="com.example.BaseAction"/>
In the above example, this method would be called with a reference
to the <action> element (first argument), and
"run" as the name of the attribute that defined
this executable extension (second argument).
The last parameter is for the specific use of extension adapters and is typically not used by regular executable extensions.
There are two supported ways of associating additional adapter-specific data with the configuration in a way that is transparent to the extension point implementor:
(1) by specifying adapter data as part of the implementation
class attribute value. The Java class name can be followed
by a ":" separator, followed by any adapter data in string
form. For example, if the extension point specifies an attribute
"run" to contain the name of the extension implementation,
an adapter can be configured as
<action run="com.example.ExternalAdapter:./cmds/util.exe -opt 3"/>
(2) by converting the attribute used to specify the executable extension to a child element of the original configuration element, and specifying the adapter data in the form of xml markup. Using this form, the example above would become
<action>
<run class="com.xyz.ExternalAdapter">
<parameter name="exec" value="./cmds/util.exe"/>
<parameter name="opt" value="3"/>
</run >
</action>
Form (2) will typically only be used for extension points that anticipate the majority of extensions configured into it will in fact be in the form of adapters.
In either case, the specified adapter class is instantiated using its 0-argument public constructor. The adapter data is passed as the last argument of this method. The data argument is defined as Object. It can have the following values:
null, if no adapter data was suppliedStringHashtable containing the actual
parameter names and values (both Strings)WorkbenchPart implementation of this
IExecutableExtension records the configuration element in
and internal state variable (accessible via getConfigElement).
It also loads the title image, if one is specified in the configuration element.
Subclasses may extend.
Should not be called by clients. It is called by the core plugin when creating
this executable extension.setInitializationData in interface IExecutableExtensioncfig - the configuration element used to trigger this execution.
It can be queried by the executable extension for specific
configuration propertiespropertyName - the name of an attribute of the configuration element
used on the createExecutableExtension(String) call. This
argument can be used in the cases where a single configuration element
is used to define multiple executable extensions.data - adapter data in the form of a String,
a Hashtable, or null.IConfigurationElement.createExecutableExtension(String)protected void setSite(IWorkbenchPartSite site)
Subclasses must invoke this method from IEditorPart.init
and IViewPart.init.
site - the workbench part siteprotected void checkSite(IWorkbenchPartSite site)
site - the site to checkprotected void setTitle(String title)
This may change a title that was previously set using setPartName or setContentDescription.
title - the title, or null to clearprotected void setTitleImage(Image titleImage)
titleImage - the title image, or null to clearprotected void setTitleToolTip(String toolTip)
getTitleToolTiptoolTip - the new tool tip text, or null to clearpublic void showBusy(boolean busy)
busy - boolean to indicate that the busy state has started
or ended.IWorkbenchSiteProgressService.showBusyForFamily(Object)public String getPartName()
IWorkbenchPartConstants.PROP_PART_NAME.
It is considered bad practise to overload or extend this method. Parts should call setPartName to change their part name.
getPartName in interface IWorkbenchPart2null)protected void setPartName(String partName)
setPartName and setContentDescription are intended to replace setTitle. This may change a value that was previously set using setTitle.
partName - the part name, as it should be displayed in tabs.public String getContentDescription()
IWorkbenchPartConstants.PROP_CONTENT_DESCRIPTION.
It is considered bad practise to overload or extend this method. Parts should call setContentDescription to change their content description.
getContentDescription in interface IWorkbenchPart2null)protected void setContentDescription(String description)
This may overwrite a value that was previously set in setTitle
description - the content descriptionpublic int getOrientation()
IWorkbenchPartOrientationgetOrientation in interface IWorkbenchPartOrientationWindow.getDefaultOrientation(),
SWT.RIGHT_TO_LEFT,
SWT.LEFT_TO_RIGHT,
Window.getDefaultOrientation()Guidelines for using Eclipse APIs. Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.