public abstract class EditorPart extends WorkbenchPart implements IEditorPart
This class should be subclassed by clients wishing to define new editors.
The name of the subclass should be given as the "class"
attribute in a editor extension contributed to the workbench's
view extension point (named "org.eclipse.ui.editors").
For example, the plug-in's XML markup might contain:
<extension point="org.eclipse.ui.editors">
<editor id="com.example.myplugin.ed"
name="My Editor"
icon="./images/cedit.gif"
extensions="foo"
class="com.example.myplugin.MyFooEditor"
contributorClass="com.example.myplugin.MyFooEditorContributor"
/>
</extension>
where com.example.myplugin.MyEditor is the name of the
EditorPart subclass.
Subclasses must implement the following methods:
IEditorPart.init - to initialize editor when assigned its siteIWorkbenchPart.createPartControl - to create the editor's controls IWorkbenchPart.setFocus - to accept focusIEditorPart.isDirty - to decide whether a significant change has
occurredIEditorPart.doSave - to save contents of editorIEditorPart.doSaveAs - to save contents of editorIEditorPart.isSaveAsAllowed - to control Save AsSubclasses may extend or reimplement the following methods as required:
IExecutableExtension.setInitializationData - extend to provide additional
initialization when editor extension is instantiatedIWorkbenchPart.dispose - extend to provide additional cleanupIAdaptable.getAdapter - reimplement to make the editor
adaptablePROP_DIRTY, PROP_INPUTPROP_TITLE| Modifier | Constructor and Description |
|---|---|
protected |
EditorPart()
Creates a new workbench editor.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
checkSite(IWorkbenchPartSite site)
Checks that the given site is valid for this type of part.
|
abstract void |
doSave(IProgressMonitor monitor)
Saves the contents of this part.
|
abstract void |
doSaveAs()
Saves the contents of this part to another object.
|
IEditorInput |
getEditorInput()
Returns the input for this editor.
|
IEditorSite |
getEditorSite()
Returns the site for this editor.
|
String |
getTitleToolTip()
Returns the title tool tip text of this workbench part.
|
abstract void |
init(IEditorSite site,
IEditorInput input)
Initializes this editor with the given editor site and input.
|
abstract boolean |
isDirty()
Returns whether the contents of this part have changed since the last save
operation.
|
abstract boolean |
isSaveAsAllowed()
Returns whether the "Save As" operation is supported by this part.
|
boolean |
isSaveOnCloseNeeded()
Returns whether the contents of this part should be saved when the part
is closed.
|
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 |
setInput(IEditorInput input)
Sets the input to this editor.
|
protected void |
setInputWithNotify(IEditorInput input)
Sets the input to this editor and fires a PROP_INPUT property change if
the input has changed.
|
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, removePartPropertyListener, removePropertyListener, 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, removePropertyListener, setFocusgetAdapterpublic abstract void doSave(IProgressMonitor monitor)
ISaveablePart
If the save is successful, the part should fire a property changed event
reflecting the new dirty state (PROP_DIRTY property).
If the save is cancelled through user action, or for any other reason, the
part should invoke setCancelled on the IProgressMonitor
to inform the caller.
This method is long-running; progress and cancellation are provided by the given progress monitor.
doSave in interface ISaveablePartmonitor - the progress monitorpublic abstract void doSaveAs()
ISaveablePart
Implementors are expected to open a "Save As" dialog where the user will
be able to select a new name for the contents. After the selection is made,
the contents should be saved to that new name. During this operation a
IProgressMonitor should be used to indicate progress.
If the save is successful, the part fires a property changed event
reflecting the new dirty state (PROP_DIRTY property).
doSaveAs in interface ISaveablePartpublic IEditorInput getEditorInput()
IEditorPartPROP_INPUT.getEditorInput in interface IEditorPartpublic IEditorSite getEditorSite()
IEditorPart(IEditorSite) getSite().
The site can be null while the editor is being initialized.
After the initialization is complete, this value must be non-null
for the remainder of the editor's life cycle.
getEditorSite in interface IEditorPartnull if the editor
has not yet been initializedpublic String getTitleToolTip()
IWorkbenchPartPROP_TITLE.
The tool tip text is used to populate the title bar of this part's visual container.
getTitleToolTip in interface IWorkbenchPartgetTitleToolTip in class WorkbenchPartnull)public abstract void init(IEditorSite site, IEditorInput input) throws PartInitException
IEditorPart
This method is automatically called shortly after the part is instantiated.
It marks the start of the part's lifecycle. The
IWorkbenchPart.dispose method will be called
automically at the end of the lifecycle. Clients must not call this method.
Implementors of this method must examine the editor input object type to
determine if it is understood. If not, the implementor must throw
a PartInitException
init in interface IEditorPartsite - the editor siteinput - the editor inputPartInitException - if this editor was not initialized successfullypublic abstract boolean isDirty()
ISaveablePartPROP_DIRTY.
Note: this method is called often on a part open or part activation switch, for example by actions to determine their enabled status.
isDirty in interface ISaveableParttrue if the contents have been modified and need
saving, and false if they have not changed since the last
savepublic abstract boolean isSaveAsAllowed()
ISaveablePartisSaveAsAllowed in interface ISaveableParttrue if "Save As" is supported, and false
if not supportedpublic boolean isSaveOnCloseNeeded()
ISaveablePartisSaveOnCloseNeeded in interface ISaveableParttrue if the contents of the part should be saved on
close, and false if the contents are expendableprotected void setInput(IEditorInput input)
Unlike most of the other set methods on this class, this method does not fire a property change. Clients that call this method from a subclass must ensure that they fire an IWorkbenchPartConstants.PROP_INPUT property change after calling this method but before leaving whatever public method they are in. Clients that expose this method as public API must fire the property change within their implementation of setInput.
Note that firing a property change may cause listeners to immediately reach back and call methods on this editor. Care should be taken not to fire the property change until the editor has fully updated its internal state to reflect the new input.
input - the editor inputsetInputWithNotify(IEditorInput)protected void setInputWithNotify(IEditorInput input)
Note that firing a property change may cause other objects to reach back and invoke methods on the editor. Care should be taken not to call this method until the editor has fully updated its internal state to reflect the new input.
input - the editor inputprotected void setContentDescription(String description)
WorkbenchPartThis may overwrite a value that was previously set in setTitle
setContentDescription in class WorkbenchPartdescription - the content descriptionprotected 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.public 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)
IEditorSite.checkSite in class WorkbenchPartsite - the site to check
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.