public abstract class ViewPart extends WorkbenchPart implements IViewPart
This class should be subclassed by clients wishing to define new views.
The name of the subclass should be given as the "class"
attribute in a view extension contributed to the workbench's
view extension point (named "org.eclipse.ui.views").
For example, the plug-in's XML markup might contain:
<extension point="org.eclipse.ui.views">
<view id="com.example.myplugin.view"
name="My View"
class="com.example.myplugin.MyView"
icon="images/eview.gif"
/>
</extension>
where com.example.myplugin.MyView is the name of the
ViewPart subclass.
Subclasses must implement the following methods:
createPartControl - to create the view's controls setFocus - to accept focusSubclasses may extend or reimplement the following methods as required:
setInitializationData - extend to provide additional
initialization when view extension is instantiatedinit(IWorkbenchPartSite) - extend to provide additional
initialization when view is assigned its sitedispose - extend to provide additional cleanupgetAdapter - reimplement to make their view adaptablePROP_TITLE| Modifier | Constructor and Description |
|---|---|
protected |
ViewPart()
Creates a new view.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
checkSite(IWorkbenchPartSite site)
Checks that the given site is valid for this type of part.
|
IViewSite |
getViewSite()
Returns the site for this view.
|
void |
init(IViewSite site)
Initializes this view with the given view site.
|
void |
init(IViewSite site,
IMemento memento)
Initializes this view with the given view site.
|
void |
saveState(IMemento memento)
Saves the object state within a memento.
|
protected void |
setContentDescription(String description)
Sets the content description for this part.
|
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.
|
addPartPropertyListener, addPropertyListener, createPartControl, dispose, firePartPropertyChanged, firePropertyChange, getAdapter, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, getTitleToolTip, internalSetContentDescription, internalSetPartName, removePartPropertyListener, removePropertyListener, setDefaultTitle, setFocus, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusyaddListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObjectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddPropertyListener, createPartControl, dispose, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener, setFocusgetAdapterprotected ViewPart()
public IViewSite getViewSite()
IViewPart(IViewSite) getSite().
The site can be null while the view is being initialized.
After the initialization is complete, this value must be non-null
for the remainder of the view's life cycle.
getViewSite in interface IViewPartnull if the view
has not yet been initializedpublic void init(IViewSite site) throws PartInitException
IViewPartThis method is automatically called by the workbench shortly after the part is instantiated. It marks the start of the views's lifecycle. Clients must not call this method.
init in interface IViewPartsite - the view sitePartInitException - if this view was not initialized successfullypublic void init(IViewSite site, IMemento memento) throws PartInitException
IViewPartThis method is automatically called by the workbench shortly after the part is instantiated. It marks the start of the views's lifecycle. Clients must not call this method.
init in interface IViewPartsite - the view sitememento - the IViewPart state or null if there is no previous saved statePartInitException - if this view was not initialized successfullypublic void saveState(IMemento memento)
IViewPartsaveState in interface IPersistablesaveState in interface IViewPartmemento - a memento to receive the object stateprotected void setPartName(String partName)
WorkbenchPartsetPartName and setContentDescription are intended to replace setTitle. This may change a value that was previously set using setTitle.
setPartName in class WorkbenchPartpartName - the part name, as it should be displayed in tabs.protected void setContentDescription(String description)
WorkbenchPartThis may overwrite a value that was previously set in setTitle
setContentDescription in class WorkbenchPartdescription - the content descriptionpublic void setInitializationData(IConfigurationElement cfig, String propertyName, Object data)
WorkbenchPartIConfigurationElement.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 IExecutableExtensionsetInitializationData in class WorkbenchPartcfig - 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 final void checkSite(IWorkbenchPartSite site)
IViewSite.checkSite in class WorkbenchPartsite - the site to check