Java Doc for EditorPart.java in  » IDE-Eclipse » ui-workbench » org » eclipse » ui » part » Java Source Code / Java DocumentationJava Source Code and Java Documentation

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>
 

Subclasses must implement the following methods:

• IEditorPart.init - to initialize editor when assigned its site
• IWorkbenchPart.createPartControl - to create the editor's controls
• IWorkbenchPart.setFocus - to accept focus
• IEditorPart.isDirty - to decide whether a significant change has occurred
• IEditorPart.doSave - to save contents of editor
• IEditorPart.doSaveAs - to save contents of editor
• IEditorPart.isSaveAsAllowed - to control Save As

Subclasses may extend or reimplement the following methods as required:

• IExecutableExtension.setInitializationData - extend to provide additional initialization when editor extension is instantiated
• IWorkbenchPart.dispose - extend to provide additional cleanup
• IAdaptable.getAdapter - reimplement to make the editor adaptable

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.

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.