RCP+常见的扩展点指南.doc

·247·
第18章 常用插件扩展点
常用插件扩展点
在第17章对plugin.xml作了少量介绍，plugin.xml是插件和Eclipse内核的接口，Eclipse就像一所大宅子，它的外墙（plugin.xml）有很多的门（扩展点），要熟练进出这座大宅子，先得搞清楚它有哪些门（扩展点）。
插件的扩展点非常之多，但很多扩展点都不常用到，只要熟悉一些主要的扩展点即可。本节将面向实际开发需要来介绍这些扩展点，并且本章所有实例都在第17章建立的myplugin2插件项目的基础上创建。
18.1 加入透视图（perspectives）
开发一个插件，最常用的方式就是新增一个属于本插件专有的透视图，然后在此透视图基础上来展开功能，本书也采用这种方式。
18.1.1 准备工作
先将以前用到的包括图标的icons目录复制一份到myplugin2项目中，复制后的路径如图18.1所示。

图18.1 图标的路径
18.1.2 修改plugin.xml文件，设置透视图的扩展点
打开plugin.xml文件的编辑框，将如下代码块插入到最后一行的</plugin>项之前：
<extension
point="org.eclipse.ui.perspectives">
<perspective
name="myplugin透视图"
icon="icons/selectall.gif"
class=".chengang.SamplePerspective"
id=".chengang.SamplePerspective">
</perspective>
</extension>
代码说明：
q org.eclipse.ui.perspectives是透视图的扩展点。
q name：透视图的名称。
q icon：透视图的图标。
q class：透视图所对应的类（还没编写，下一步将完成此类）。
q id：透视图标识，建议设置成和class一样的名称，省得以后扩展点设置得太多，让人糊涂。
18.1.3 建立透视图类
在18.1.2小节的plugin.xml中提前设置了透视图对应的类.chengang.Sample Perspective，这一步就在包.chengang中创建此类。透视图类必须实现Iperspective Factory接口，此接口只有一种方法createInitialLayout，先让它空实现。
SamplePerspective类的代码如下：
//--------文件名：SamplePerspective.java--------------------
public class SamplePerspective implements IPerspectiveFactory {
public void createInitialLayout(IPageLayout layout) {}
}
18.1.4 运行插件
运行插件，然后在新Eclipse环境中选择主菜单“窗口→打开透视图→其他”选项。在弹出窗口中，可以看到一个名为myplugin透视图的项，如图18.2所示。
选择并打开“myplugin透视图”选项后，显示如图18.3所示的Eclipse界面。我们发现该透视图光秃秃的什么也没有。没关系，下面就会向这个透视图中加入两个视图。

图18.2 选择透视图

图18.3 myplugin透视图的效果图
18.1.5 总结
由本节可以看到，在Eclipse插件环境中，创建一个菜单、按钮、透视图界面是多么简单，都不用编写实际界面的创建代码，只要设置一些扩展点就行了。
18.2 在透视图中加入视图（views）
接着18.1节的内容，给透视图加入两个视图，实现的步骤如下所述。
18.2.1 修改plugin.xml文件，设置视图的扩展点
打开plugin.xml文件的编辑框，将如下代码块插入到最后一行的</plugin>之前：
<extension
point="org.eclipse.ui.views">
<category
name="myplugin2视图"
id="com.glchengang.myplugin2.view">
</category>
<view
name="视图1"
icon="icons/prev.gif"
category="com.glchengang.myplugin2.view"
class=".chengang.View1"
id=".chengang.View1">
</view>
<view
name="视图2"
icon="icons/project.gif"
category="com.glchengang.myplugin2.view"
class=".chengang.View2"
id=".chengang.View2">
</view>
</extension>
代码说明：
q org.eclipse.ui.views是视图的扩展点。
q <category>…</category>是视图的分组名及id标识，它的效果体现在“显示视图”窗口里，显示视图的打开方法是：在主菜单选择“窗口→显示视图→其他”选项，图18.4中的左图是本例设置的效果。
<category>项中的id属性要保证它在Eclipse的所有插件中惟一。如果和Ant插件的id相同，原Ant组就会被myplugin2视图组抹掉了（右图）。如果删除掉<category>不设置，则Eclipse会自动新增一个“其他”组，并将两视图加入（中图）。
q <view>的category是表示本视图属于哪个组，与上面<category>项的id值相同。
q <view>的class是视图所对应的类（还没编写，下一步将完成这两个类）。
q <view>的id是视图标识，建议设置成和class一样的名称。

图18.4 显示视图窗口
18.2.2 创建视图类
在18.2.1小节的plugin.xml中提前设置了视图对应的类：.chengang.View1、View2，本小节就来在包.chengang中创建这两个视图类。
视图的类必须继承抽象类ViewPart，此类有两种方法createPartControl、setFocus。我们要在createPartControl方法创建两个视图的界面组件，第一个视图创建一个列表，第二个视图创建一个文本框。而setFocus是关于视图焦点的方法，一般都不用写，让它空实现。
两类的代码如下：
//--------文件名：View1.java--------------------
public class View1 extends ViewPart {
public void createPartControl(Composite parent) {
Composite topComp = new Composite(parent, SWT.NONE);
topComp.setLayout(new FillLayout());
List list = new List(topComp, SWT.BORDER);
list.add("中国");
list.add("美国");
list.add("法国");
}
public void setFocus() {}
}

//--------文件名：View2.java--------------------
public class View2 extends ViewPart {
public void createPartControl(Composite parent) {
Composite topComp = new Composite(parent, SWT.NONE);
topComp.setLayout(new FillLayout());
Text text = new Text(topComp, SWT.BORDER);
text.setText("我是text框");
}
public void setFocus() {}
}
18.2.3 修改透视图类SamplePerspective
在18.1节加入一个透视图时，建立了一个透视图类SamplePerspective，当时有一个继承自接口的方法createInitialLayout，它还是空实现的。本例将通过修改这种方法，将两个视图加入到透视图中。createInitialLayout方法的代码如下：
//参数IPageLayout是用于透视图的布局
public void createInitialLayout(IPageLayout layout) {
//得本透视图的编辑空间标识
String editorArea = layout.getEditorArea();
/*
* 将视图1加入到透视图的左部
* "left" 视图区的id标识为"left"
* IPageLayout.LEFT 在透视图布局中的位置靠左
* 0.2f 占用透视图20%的宽度
* editorArea 使用透视图的编辑空间
*/
IFolderLayout left = layout.createFolder("left", IPageLayout.LEFT, 0.2f, editorArea);
left.addView(".chengang.View1"); //参数为plugin.xml中视图1的id标识
//将视图2加入到透视图的底部
IFolderLayout bottom = layout.createFolder("bottom", IPageLayout.BOTTOM, 0.8f, editorArea);
bottom.addView(".chengang.View2");
/*
* 将17.2.2小节第4点所定义的actionset（主菜单、工具栏按钮）加入到本透视图。这个效果要在
* plugin.xml文件的action设置中将visible="false"才看得出效果，这时打
* 开其他透视图，action设置的主菜单、工具栏按钮将不会出现在界面上，只有打
* 开本透视图才会出现，因为本透视图用下面的语句手工加入了此action
* 参数myplugin2.actionSet为action在plugin.xml文件中设置的id标识
*/
layout.addActionSet("myplugin2.actionSet");
}
18.2.4 运行插件
运行插件后，打开myplugin透视图，效果如图18.5所示。如果两个视图还没有显示在透视图上，则需要把透视图先关闭，再打开，以应用新的透视图设置。

图18.5 加入两视图后的透视图
18.3 在视图之间实现事件监听
两个视图中的组件之间的互动，在开发插件时是经常碰到的问题。例如，在18.2.4小节的界面中，单击视图1列表中的某项时，视图2的文本框也作相应显示。本节将实现此功能。
18.3.1 修改View1.java、View2.java
首先，要在两视图中互动就必须先解决“如何在视图1中取得视图2的对象”的问题。Eclipse通过plugin.xml来加载插件和插件中的扩展点（如视图），所以可以由视图的id标识来取得视图对象，具体语句如下：
IWorkbenchPage wbp = getViewSite().getPage();
IViewPart view2 = wbp.findView(".chengang.View2");
得到了视图2的对象后，其他一切就都好办了，先给出修改后View1如下：
public class View1 extends ViewPart {
public void createPartControl(Composite parent) {
Composite topComp = new Composite(parent, SWT.NONE);
topComp.setLayout(new FillLayout());
final List list = new List(topComp, SWT.BORDER);
list.add("中国");
list.add("美国");
list.add("法国");
//列表选择事件监听
list.addSelectionListener(new SelectionListener() {
public void widgetSelected(SelectionEvent e) {
//由IWorkbenchPage取出view2
IWorkbenchPage wbp = getViewSite().getPage();
IViewPart view2 = wbp.findView(".chengang.View2");
//将当前选择的列表项显示在文本框中
Text text = ((View2) view2).getText();
text.setText(list.getSelection()[0]);
}
public void widgetDefaultSelected(SelectionEvent e) {}
});
}
public void setFocus() {}
}
然后将View2的文本框对象改成类的实例变量，并编写它相应的set/get方法，代码 如下：
public class View2 extends ViewPart {
private Text text;
public void createPartControl(Composite parent) {
Composite topComp = new Composite(parent, SWT.NONE);
topComp.setLayout(new FillLayout());
text = new Text(topComp, SWT.BORDER);
text.setText("我是text框");
}
public void setFocus() {}
//文本框text相应的set/get方法
public Text getText() {return text;}
public void setText(Text text) {this.text = text;}
}
18.3.2 总结
（1）在插件中IWorkbenchPage对象比较重要，在这里再给出一种获得此对象的方法。当不是在视图里而是在Action里要取IWorkbenchPage对象时，就可以用下面的方法：
Myplugin2Plugin.getDefault().getWorkbench().getActiveWorkbenchWindow(). getActivePage();
（2）IWorkbenchPage.findView(".chengang.View2")，中的参数为“视图2”在plugin.xml中设置的id标识，由此可见plugin.xml文件在插件中的地位是极其重要的。IWorkbenchPage除了findView方法之外，还有findEditor方法是用来得到编辑器的。
像“.chengang.View2”这种标识符在系统开发中会经常用到，最好建立一个常量专用类来集中放置这些字符串常量，然后系统中用的时候只用其常量名就行了，否则把标识符的字串分散在代码中，以后改起来会让你痛不欲生。
常量类的示意代码如下：
public final class StringConstants {
public final static String VIEW1 = ".chengang.View1";
public final static String VIEW2 = ".chengang.View2";
}
要用的时候则这样写：findView(StringConstants.VIEW2);
18.4 给视图加下拉菜单和按钮
本例将给视图加入下拉菜单和按钮，如图18.6所示。同时再为列表添加一个右键菜单，这样读者可以用来和视图的下拉菜单进行比较阅读。

图18.6 效果图
18.4.1 创建ActionGroup类
加入菜单和按钮的方法与SWT/JFace组件的一样。先创建一个ActionGroup代码如下：
//--------文件名：MyActionGroup.java----------
public class MyActionGroup extends ActionGroup {
/*
* 加入按钮
*/
public void fillActionBars(IActionBars actionBars) {
if (actionBars == null)
return;
IToolBarManager toolBar = actionBars.getToolBarManager();
toolBar.add(new Action1());
toolBar.add(new Action2());
}

/*
* 加入下拉菜单、右键弹出菜单
*/
public void fillContextMenu(IMenuManager menu) {
if (menu == null)
return;
menu.add(new Action1());
menu.add(new Action2());
}

private class Action1 extends Action {
public Action1() {
ImageDescriptor imageDesc=WorkbenchImages.getImageDescriptor(IworkbenchGraphic Constants.IMG_ETOOL_HOME_NAV);
setHoverImageDescriptor(imageDesc);
setText("Action1");
}
public void run() {}
}

private class Action2 extends Action {
public Action2() {
ImageDescriptor imageDesc = WorkbenchImages.getImageDescriptor(Iworkbench GraphicConstants.IMG_ETOOL_IMPORT_WIZ);
setHoverImageDescriptor(imageDesc);
setText("Action2");
}
public void run() {}
}
}
程序说明：
q 本程序中含有两个Action类：Action1、Action2，和以往的Action不同之处在于它的图像描述符是直接从Eclipse环境中取得。既然插件在Eclipse环境内运行，那么Eclipse环境本身的图标就可以直接拿来使用。
q fillContextMenu方法比起以前的少了几句。在18.4.2小节，可以看到它移出到View1类中去了，主要原因是为了此方法兼顾添加视图的下拉菜单。
18.4.2 修改View1类
在View1中增加了三种方法，分别用来加入视图的导航栏按钮、下拉菜单，以及加入列表List的右键菜单。代码如下：
public class View1 extends ViewPart {
private List list; //将List写成类的实例变量，以扩大它的可访问范围

public void createPartControl(Composite parent) {
Composite topComp = new Composite(parent, SWT.NONE);
topComp.setLayout(new FillLayout());
list = new List(topComp, SWT.BORDER);
list.add("中国");
list.add("美国");
list.add("法国");
//列表选择事件监听(和以前一样，省略)
/*
* 加入导航栏按钮、下拉菜单、右键菜单
*/
MyActionGroup actionGroup = new MyActionGroup();
fillViewAction(actionGroup);//加入视图的导航栏按钮
fillViewMenu(actionGroup);//加入视图的下拉菜单
fillListMenu(actionGroup);// 加入视图的下拉菜单
}

/**
* 加入视图的导航栏按钮
*/
private void fillViewAction(MyActionGroup actionGroup) {
IActionBars bars = getViewSite().getActionBars();
actionGroup.fillActionBars(bars);
}

/**
* 加入视图的下拉菜单
*/
private void fillViewMenu(MyActionGroup actionGroup) {
IMenuManager menu = getViewSite().getActionBars().getMenuManager();
actionGroup.fillContextMenu(menu);
}

/**
* 加入列表List的右键菜单
*/
private void fillListMenu(MyActionGroup actionGroup) {
MenuManager menu1 = new MenuManager();
Menu m = menu1.createContextMenu(list);
list.setMenu(m);
actionGroup.fillContextMenu(menu1);
}

public void setFocus() {}
}
程序说明：
q 过去写在ActionGroup中的两句移到了fillListMenu方法中。
q 视图加按钮、菜单的方式和以前SWT/JFace的方式是一样的。只不过以前用自己生成MenuManager对象等，而现在的插件就只需要使用视图已有的MenuManager 对象。
18.5 加入编辑器（editors）
本节将给出如下的实例：双击视图1中的列表项，将在透视图中加入相应的编辑器。这种效果就像在Eclipse中双击Java源文件，就会打开该源文件相对应的编辑器一样。效果如图18.7所示。

图18.7 编辑器效果图
和以前一样，先来修改plugin.xml文件将编辑器的扩展点加入，然后再创建相应的编辑器类，最后编写列表双击的事件代码。
18.5.1 修改plugin.xml文件，设置三个编辑器的扩展点
<extension
point="org.eclipse.ui.editors">
<editor
name="中国Editor"
icon="icons/project.gif"
class=".chengang.ChinaEditor"
id=".chengang.ChinaEditor">
</editor>
<editor
name="美国Editor"
icon="icons/prev.gif"
class=".chengang.UsaEditor"
id=".chengang.UsaEditor">
</editor>
<editor
name="法国Editor"
icon="icons/remove.gif"
class=".chengang.FranceEditor"
id=".chengang.FranceEditor">
</editor>
</extension>
代码说明：
编辑器的扩展点是org.eclipse.ui.editors，它各项的含义和视图扩展点基本一样，请参照18.2.1小节的视图扩展点的说明。这里强调一点：icon也是必填项。
18.5.2 创建三个编辑器类
在18.5.1小节的plugin.xml中，提前设置了编辑器对应的类.chengang.ChinaEditor和UsaEditor、FranceEditor，本小节就来在包.chengang中创建这三个编辑器类。
编辑器必须实现IEditorPart接口，但通常是继承抽象类EditorPart类（EditorPart是IEditorPart的子类）。如果继承EditorPart则必须实现该抽象类的七种方法，在此先实现方法init、createPartControl。本例只给出了ChinaEditor的代码，UsaEditor、FranceEditor与之完全类似，ChinaEditor的代码如下：
//---------- 文件名：ChinaEditor.java --------------
public class ChinaEditor extends EditorPart {
/**
* Editor的初始化方法。本方法前两句是固定不变的
*/
public void init(IEditorSite site, IEditorInput input) throws PartInitException {
System.out.println("init");
setSite(site);
setInput(input);
//设置Editor标题栏的显示名称。不要，则名称用plugin.xml中的name属性
//setPartName(input.getName());
//设置Editor标题栏的图标。不要，则会自动使用一个默认的图标
//setTitleImage(input.getImageDescriptor().createImage());
}

/**
* 在此方法中创建Editor中的界面组件
*/
public void createPartControl(Composite parent) {
System.out.println("createPartControl");
Composite topComp = new Composite(parent, SWT.NONE);
topComp.setLayout(new FillLayout());
Text text = new Text(topComp, SWT.BORDER);
text.setText("中国之编辑器");
}
//此五个抽象类的方法下面将讲解，现在让它空实现
public void doSave(IProgressMonitor monitor) {}
public boolean isSaveAsAllowed() {return false;}
public void doSaveAs() {}
public boolean isDirty() {return false;}
public void setFocus() {}
}
18.5.3 创建IEditorInput
获取视图对象是用IWorkbenchPage的findView方法，方法参数是视图在plugin.xml中的id标识。获取编辑器对象是用findEditor方法，但该方法的参数却不是id标识的字符串，而是一个IEditorInput对象。另外，加载一个编辑器是用IWorkbenchPage的openEditor (editorInput, editorID)方法。
由上可知，编辑器都会要对应一个IEditorInput和一个EditorPart，而且在IWorkbenchPage中是根据IEditorInput来取得EditorPart，如图18.8所示。

图18.8 编辑器的组成
在本小节将要创建三个Editor相对应的IEditorInput。在这里只给出了ChinaEditor对应的IEditorInput，其他两个与之类似，请读者查阅配书光盘的代码。
//--------- 文件名：ChinaEditorInput.java -----------
public class ChinaEditorInput implements IEditorInput {
/**
* 返回true，则打开该编辑器后它会出现在Eclipse主菜单“文件”
* 最下部的最近打开的文档栏中。返回false则不出现在其中
*/
public boolean exists() {
return true;
}

/**
* 编辑器标题栏的图标，不过它还需要在ChinaEditor中用
* setTitleImage方法设置，才能出现在标题栏中
*/
public ImageDescriptor getImageDescriptor() {
return WorkbenchImages.getImageDescriptor(IWorkbenchGraphicConstants.IMG_
ETOOL_HOME_NAV);
}

/**
* 编辑器标题栏的显示名称，和上面的getImageDescriptor
* 一样也要在ChinaEditor中用setPartName方法设置，才能出现在标题栏中
*/
public String getName() {
return "中国的编辑器";
}

/**
* 编辑器标题栏的小黄条提示文字，不需像getName那样在ChinaEditor中再设置
*/
public String getToolTipText() {
return "这是视图1列表中的中国项对应的编辑器";
}

/**
* 返回一个可以用做保存本编辑输入数据状态的对象，本例让它空实现
*/
public IPersistableElement getPersistable() {
return null;
}

/**
* 得到一个编辑器的适配器，本例让它空实现
* IAdaptable a = new ChinaEditorInput();
* IFoo x = (IFoo)a.getAdapter(IFoo.class);
* if (x != null)
* [用x来做IFoo的事情]
*/
public Object getAdapter(Class adapter) {
return null;
}
}
18.5.4 打开编辑器
有了EditorPart和IEditorInput后，就可以在Eclipse中打开编辑器了。本例是要实现双击视图1的列表，则会打开列表项相对应的编辑器，因此在View1类的List对象添加一个鼠标双击事件监听器。另外还要考虑到，如果已经打开了列表项对应的编辑器，则下次再双击时就不再打开该项的编辑器，而是将其设成当前选择的编辑器。
查找编辑器的方法是：IEditorPart editor = IWorkbenchPage.findEditor(IEditorInput);
打开编辑器的方法是：IWorkbenchPage.