Eclipse插件（RCP）自定义透视图

红太狼 2023-10-05 22:24 4阅读 0赞

## 目标 ##

解释透视图并在RCP中自定义透视图。

## 透视图 ##

透视图是为方便完成某一任务，对视图、编辑器、操作等组合而成的一个工作台布局，这个布局在工作台中形成的视图就是透视图。如常见的Eclipse默认布局就是java开发透视图，当进入debug模式后就转变为debug调试透视图等等。

Eclipse 提供了对透视图的管理，通常放在菜单 windows -> Perspective 下，如下图所示。  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5bCP5a2Q5a6d5LiB_size_20_color_FFFFFF_t_70_g_se_x_16]

RCP应用是为解决某些特定的业务A而开发的，为了完成这个业务我们需要一些编辑器和视图，以及一些功能菜单。为了方便完成业务A，我们通常会将这些编辑器、视图、功能菜单进行布局，这样我们就相当于定义了一个透视图，我们可以将其命名为业务A透视图。

## 明确需求 ##

现我们已经搭建好一个RCP项目（参考：[Eclipse插件（RCP）项目搭建][Eclipse_RCP]）。  
运行效果如下：  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5bCP5a2Q5a6d5LiB_size_20_color_FFFFFF_t_70_g_se_x_16 1]  
假设我们需要一个如下的透视图。  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5bCP5a2Q5a6d5LiB_size_20_color_FFFFFF_t_70_g_se_x_16 2]

## 自定义透视图 ##

### 扩展透视图 ###

如下打开plugin.xml 扩展透视图  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5bCP5a2Q5a6d5LiB_size_20_color_FFFFFF_t_70_g_se_x_16 3]

1.  添加透视图扩展点 `org.eclipse.ui.perspectives`
2.  右击添加透视图扩展 `perspective`
3.  点击自定义的透视图扩展，绑定扩展点的属性

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>释义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>id</td> 
   <td>透视图ID,一般采用其实现类的全路径类名，应保持唯一</td> 
  </tr> 
  <tr> 
   <td>name</td> 
   <td>透视图的名称，在视图管理菜单中显示</td> 
  </tr> 
  <tr> 
   <td>class</td> 
   <td>透视图的实现类，应实现了IPerspectiveFactory，布局在这个内种定义</td> 
  </tr> 
  <tr> 
   <td>icon</td> 
   <td>透视图的图标，视图管理菜单中显示在name之前</td> 
  </tr> 
  <tr> 
   <td>fiex</td> 
   <td>是否固定</td> 
  </tr> 
 </tbody> 
</table>

Plugin.xml 中生成的配置如下

<extension
             point="org.eclipse.ui.perspectives">
          <perspective
                class="com.xzbd.perspective.MainPerspective"
                name="主透视图"
                id="com.xzbd.perspective.MainPerspective">
          </perspective>
       </extension>

### 定义透视图布局 ###

透视图布局在其实现类中实现，如下我们可以自定义透视图`MainPerspective`

package com.xzbd.perspective;
    
    import org.eclipse.ui.IFolderLayout;
    import org.eclipse.ui.IPageLayout;
    import org.eclipse.ui.IPerspectiveFactory;
    
    import com.xzbd.navigator.MainNavigator;
    import com.xzbd.views.MessageConsoleView;
    
    public class MainPerspective implements IPerspectiveFactory {
        
    	public static final String ID = "com.xzbd.perspective.MainPerspective";
    
    	@Override
    	public void createInitialLayout(IPageLayout layout) {
        
    		// 开始编辑区视图展示
    		layout.setEditorAreaVisible(true);
    		layout.setFixed(false);
    
    		String editorArea = layout.getEditorArea();
    
    		// 左侧 导航
    		IFolderLayout leftTopFolder = layout.createFolder("LEFT", IPageLayout.LEFT, 0.18f, editorArea);
    		leftTopFolder.addView(MainNavigator.ID);
    
    		// 右侧
    		IFolderLayout leftRightFolder = layout.createFolder("RIGHT", IPageLayout.RIGHT, 0.8f, editorArea);
    		leftRightFolder.addView(IPageLayout.ID_OUTLINE);
    
    		// 添加下部视图
    		IFolderLayout tabs = layout.createFolder("BOTTOM", IPageLayout.BOTTOM, 0.6f, editorArea);
    		// 属性
    //		tabs.addPlaceholder(IPageLayout.ID_PROP_SHEET);
    		// console view
    		tabs.addView(MessageConsoleView.ID);
    	}
    
    }

其中  
`MessageConsoleView` 是自定义的一个简单消息输出控制台，实现参考[Eclipse插件（RCP）控制台（Console）个性化][Eclipse_RCP_Console]  
`MainNavigator` 是对CNF的一个实现，可参考[Common Navigator Framwork 实践][Common Navigator Framwork]  
`layout.createFolder("BOTTOM", IPageLayout.BOTTOM, 0.6f, editorArea)` 中第三个参数是一个 0.05到0.95 之间的数，可以查看该方法的注释。

### 将自定义的透视图设置为默认视图 ###

RCP初始化透视图在`ApplicationWorkbenchAdvisor`中设置，只需要重写该类提供的`getInitialWindowPerspectiveId`方法，返回我们自定义的透视图ID即可。相关代码如下：

@Override
    	public String getInitialWindowPerspectiveId() {
        
    		return MainPerspective.ID;
    	}

其中  
**`MainPerspective.ID`与plugin.xml中定义的id应保持一致**

### 测试效果 ###

运行项目后得到的效果如图：  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5bCP5a2Q5a6d5LiB_size_20_color_FFFFFF_t_70_g_se_x_16 4]

## 总结 ##

该文讲述了Eclipse 透视图的概念，介绍了RCP程序自定义透视图的方法。  
相关参考文章：

*  [Eclipse插件（RCP）项目搭建][Eclipse_RCP]
 *  [Eclipse插件（RCP）控制台（Console）个性化][Eclipse_RCP_Console]
 *  [Common Navigator Framwork 实践][Common Navigator Framwork 1]

项目代码见项目[Epx][]

[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5bCP5a2Q5a6d5LiB_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/924f6e0ca77c475892f6a66a2c2af0b5.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5bCP5a2Q5a6d5LiB,size_20,color_FFFFFF,t_70,g_se,x_16
[Eclipse_RCP]: https://blog.csdn.net/m0_47406832/article/details/123290347
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5bCP5a2Q5a6d5LiB_size_20_color_FFFFFF_t_70_g_se_x_16 1]: https://img-blog.csdnimg.cn/84f3826941b540909ad502ec6c0bcc5c.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5bCP5a2Q5a6d5LiB,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5bCP5a2Q5a6d5LiB_size_20_color_FFFFFF_t_70_g_se_x_16 2]: https://img-blog.csdnimg.cn/0514496cffd74dbfae96b5feba5a0b45.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5bCP5a2Q5a6d5LiB,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5bCP5a2Q5a6d5LiB_size_20_color_FFFFFF_t_70_g_se_x_16 3]: https://img-blog.csdnimg.cn/9ecd006cb84d47a3a9b6b3921608ca07.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5bCP5a2Q5a6d5LiB,size_20,color_FFFFFF,t_70,g_se,x_16
[Eclipse_RCP_Console]: https://blog.csdn.net/m0_47406832/article/details/123839863
[Common Navigator Framwork]: https://editor.csdn.net/md?articleId=123890933
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5bCP5a2Q5a6d5LiB_size_20_color_FFFFFF_t_70_g_se_x_16 4]: https://img-blog.csdnimg.cn/5f4ae59fc1ec40d08cbd97e612f105dc.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5bCP5a2Q5a6d5LiB,size_20,color_FFFFFF,t_70,g_se,x_16
[Common Navigator Framwork 1]: https://blog.csdn.net/m0_47406832/article/details/123890933
[Epx]: https://gitee.com/xzbd/epx