Eclipse插件（RCP）创建多页编辑器

傷城~ 2023-10-05 21:49 59阅读 0赞

#### Eclipse插件（RCP）创建多页编辑器 ####

*  前言
 *  一、MultiPageEditor是什么？
 *  二、创建多页编辑器示例
 *   *  1.引入依赖
     *  2.扩展自定义编辑器
     *  3.创建编辑器类
     *  4.运行，查看结果
 *  总结

--------------------

## 前言 ##

Eclipse 插件都有一个`Plugin.xml` 文件，当我们使用eclipse编辑器打开该文件时会发现，该文件的编辑器很特别，它有很多可切换的页签，这类编辑器就是今天的主角**多页编辑器**，官方叫**MultiPageEditor**。

--------------------

## 一、MultiPageEditor是什么？ ##

## 二、创建多页编辑器示例 ##

### 1.引入依赖 ###

*  `org.eclipse.ui`
 *  `org.eclipse.core.resources`
 *  `org.eclipse.ui.ide`

### 2.扩展自定义编辑器 ###

打开`pugin.xml`,在扩展点`org.eclipse.ui.editors` 下扩展自己的编辑器

**注意：** 请设置属性 `default="true"`,若设置为`false`,打开`.xml`文件时不会使用自定义的编辑器`DemoEditor`，而是使用`Eclipse`平台自带的普通文编编辑器。这并不是自己定义的编辑的有问题，您需要通过右键子菜单 **`Open with...`** ，选择 `DemoEditor` 打开。

### 3.创建编辑器类 ###

*  要实现多页编辑器，需要继承 `MultiPageEditorPart`
 *  多页编辑器需要定义不同页显示的内容，因此要重写 `createPages` 方法，该方法中需要使用 `addPage` 和 `setPageText(pageIndex, "PageName")` 配合设置多页内容。

**代码示例：**

package cn.xzbd.rcp01;
    
    import org.eclipse.core.resources.IMarker;
    import org.eclipse.core.runtime.IProgressMonitor;
    import org.eclipse.jface.viewers.TreeViewer;
    import org.eclipse.swt.SWT;
    import org.eclipse.ui.IEditorInput;
    import org.eclipse.ui.IEditorSite;
    import org.eclipse.ui.IFileEditorInput;
    import org.eclipse.ui.PartInitException;
    import org.eclipse.ui.editors.text.TextEditor;
    import org.eclipse.ui.ide.IGotoMarker;
    import org.eclipse.ui.part.MultiPageEditorPart;
    
    
    public class DemoEditor extends MultiPageEditorPart {
        
    
    	private TreeViewer treeViewer;
    	private TextEditor textEditor;
    
    	public void init(IEditorSite site, IEditorInput input) throws PartInitException {
        
    		if (!(input instanceof IFileEditorInput))
    			throw new PartInitException("Invalid Input: Must be IFileEditorInput");
    		super.init(site, input);
    	}
    
    	@Override
    	public void doSave(IProgressMonitor monitor) {
        
    		textEditor.doSave(monitor);
    
    	}
    
    	@Override
    	public void doSaveAs() {
        
    		textEditor.doSaveAs();
    		setInput(textEditor.getEditorInput());
    		updateTitle();
    
    	}
    
    	@Override
    	public boolean isSaveAsAllowed() {
        
    		return true;
    	}
    
    	@Override
    	protected void createPages() {
        
    		createPropertiesPage();
    		createSourcePage();
    		updateTitle();
    
    	}
    
    	void createPropertiesPage() {
        
    		treeViewer = new TreeViewer(getContainer(), SWT.MULTI | SWT.FULL_SELECTION);
    		int index = addPage(treeViewer.getControl());
    		setPageText(index, "Overview");
    	}
    
    	void createSourcePage() {
        
    		try {
        
    			textEditor = new TextEditor();
    			int index = addPage(textEditor, getEditorInput());
    			setPageText(index, "Source");
    		} catch (PartInitException e) {
        
    			e.printStackTrace();
    		}
    	}
    
    	void updateTitle() {
        
    		IEditorInput input = getEditorInput();
    		setPartName(input.getName());
    		setTitleToolTip(input.getToolTipText());
    	}
    
    	@Override
    	public void setFocus() {
        
    		switch (getActivePage()) {
        
    		case 0:
    			treeViewer.getTree().setFocus();
    			break;
    		case 1:
    			textEditor.setFocus();
    			break;
    		}
    	}
    
    	public void gotoMarker(IMarker marker) {
        
    		setActivePage(1);
    		((IGotoMarker) textEditor.getAdapter(IGotoMarker.class)).gotoMarker(marker);
    	}
    
    }

### 4.运行，查看结果 ###

*  Overview 视图  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5bCP5a2Q5a6d5LiB_size_20_color_FFFFFF_t_70_g_se_x_16]
 *  Source视图  
    ![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5bCP5a2Q5a6d5LiB_size_20_color_FFFFFF_t_70_g_se_x_16 1]

--------------------

## 总结 ##

欲知更多细节，请参考 [eclipse插件开发\_第三版.zip][eclipse_.zip] CHAPTER 8 中 8.2小结

[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5bCP5a2Q5a6d5LiB_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/58bb0610e66c4a8a91eea7163fc716bd.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5bCP5a2Q5a6d5LiB,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5bCP5a2Q5a6d5LiB_size_20_color_FFFFFF_t_70_g_se_x_16 1]: https://img-blog.csdnimg.cn/e45f0f9aa3a24d13b7a5ca9e0c6d61fb.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5bCP5a2Q5a6d5LiB,size_20,color_FFFFFF,t_70,g_se,x_16
[eclipse_.zip]: https://download.csdn.net/download/m0_47406832/22657040