《精通Eclipse》第18章常用插件扩展点试读.docx
《《精通Eclipse》第18章常用插件扩展点试读.docx》由会员分享,可在线阅读,更多相关《《精通Eclipse》第18章常用插件扩展点试读.docx(44页珍藏版)》请在冰豆网上搜索。
《精通Eclipse》第18章常用插件扩展点试读
第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文件的编辑框,将如下代码块插入到最后一行的项之前:
point="org.eclipse.ui.perspectives">
name="myplugin透视图"
icon="icons/selectall.gif"
class=".chengang.SamplePerspective"
id=".chengang.SamplePerspective">
代码说明:
❑org.eclipse.ui.perspectives是透视图的扩展点。
❑name:
透视图的名称。
❑icon:
透视图的图标。
❑class:
透视图所对应的类(还没编写,下一步将完成此类)。
❑id:
透视图标识,建议设置成和class一样的名称,省得以后扩展点设置得太多,让人糊涂。
18.1.3建立透视图类
在18.1.2小节的plugin.xml中提前设置了透视图对应的类.chengang.SamplePerspective,这一步就在包.chengang中创建此类。
透视图类必须实现IperspectiveFactory接口,此接口只有一种方法createInitialLayout,先让它空实现。
SamplePerspective类的代码如下:
//--------文件名:
SamplePerspective.java--------------------
publicclassSamplePerspectiveimplementsIPerspectiveFactory{
publicvoidcreateInitialLayout(IPageLayoutlayout){}
}
18.1.4运行插件
运行插件,然后在新Eclipse环境中选择主菜单“窗口→打开透视图→其他”选项。
在弹出窗口中,可以看到一个名为myplugin透视图的项,如图18.2所示。
选择并打开“myplugin透视图”选项后,显示如图18.3所示的Eclipse界面。
我们发现该透视图光秃秃的什么也没有。
没关系,下面就会向这个透视图中加入两个视图。
图18.2选择透视图
图18.3myplugin透视图的效果图
18.1.5总结
由本节可以看到,在Eclipse插件环境中,创建一个菜单、按钮、透视图界面是多么简单,都不用编写实际界面的创建代码,只要设置一些扩展点就行了。
18.2在透视图中加入视图(views)
接着18.1节的内容,给透视图加入两个视图,实现的步骤如下所述。
18.2.1修改plugin.xml文件,设置视图的扩展点
打开plugin.xml文件的编辑框,将如下代码块插入到最后一行的之前:
point="org.eclipse.ui.views">
name="myplugin2视图"
id="com.glchengang.myplugin2.view">
name="视图1"
icon="icons/prev.gif"
category="com.glchengang.myplugin2.view"
class=".chengang.View1"
id=".chengang.View1">
name="视图2"
icon="icons/project.gif"
category="com.glchengang.myplugin2.view"
class=".chengang.View2"
id=".chengang.View2">
代码说明:
❑org.eclipse.ui.views是视图的扩展点。
❑…是视图的分组名及id标识,它的效果体现在“显示视图”窗口里,显示视图的打开方法是:
在主菜单选择“窗口→显示视图→其他”选项,图18.4中的左图是本例设置的效果。
项中的id属性要保证它在Eclipse的所有插件中惟一。
如果和Ant插件的id相同,原Ant组就会被myplugin2视图组抹掉了(右图)。
如果删除掉不设置,则Eclipse会自动新增一个“其他”组,并将两视图加入(中图)。
❑的category是表示本视图属于哪个组,与上面项的id值相同。
❑的class是视图所对应的类(还没编写,下一步将完成这两个类)。
❑的id是视图标识,建议设置成和class一样的名称。
图18.4显示视图窗口
18.2.2创建视图类
在18.2.1小节的plugin.xml中提前设置了视图对应的类:
.chengang.View1、View2,本小节就来在包.chengang中创建这两个视图类。
视图的类必须继承抽象类ViewPart,此类有两种方法createPartControl、setFocus。
我们要在createPartControl方法创建两个视图的界面组件,第一个视图创建一个列表,第二个视图创建一个文本框。
而setFocus是关于视图焦点的方法,一般都不用写,让它空实现。
两类的代码如下:
//--------文件名:
View1.java--------------------
publicclassView1extendsViewPart{
publicvoidcreatePartControl(Compositeparent){
CompositetopComp=newComposite(parent,SWT.NONE);
topComp.setLayout(newFillLayout());
Listlist=newList(topComp,SWT.BORDER);
list.add("中国");
list.add("美国");
list.add("法国");
}
publicvoidsetFocus(){}
}
//--------文件名:
View2.java--------------------
publicclassView2extendsViewPart{
publicvoidcreatePartControl(Compositeparent){
CompositetopComp=newComposite(parent,SWT.NONE);
topComp.setLayout(newFillLayout());
Texttext=newText(topComp,SWT.BORDER);
text.setText("我是text框");
}
publicvoidsetFocus(){}
}
18.2.3修改透视图类SamplePerspective
在18.1节加入一个透视图时,建立了一个透视图类SamplePerspective,当时有一个继承自接口的方法createInitialLayout,它还是空实现的。
本例将通过修改这种方法,将两个视图加入到透视图中。
createInitialLayout方法的代码如下:
//参数IPageLayout是用于透视图的布局
publicvoidcreateInitialLayout(IPageLayoutlayout){
//得本透视图的编辑空间标识
StringeditorArea=layout.getEditorArea();
/*
*将视图1加入到透视图的左部
*"left"视图区的id标识为"left"
*IPageLayout.LEFT在透视图布局中的位置靠左
*0.2f占用透视图20%的宽度
*editorArea使用透视图的编辑空间
*/
IFolderLayoutleft=layout.createFolder("left",IPageLayout.LEFT,0.2f,editorArea);
left.addView(".chengang.View1");//参数为plugin.xml中视图1的id标识
//将视图2加入到透视图的底部
IFolderLayoutbottom=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标识来取得视图对象,具体语句如下:
IWorkbenchPagewbp=getViewSite().getPage();
IViewPartview2=wbp.findView(".chengang.View2");
得到了视图2的对象后,其他一切就都好办了,先给出修改后View1如下:
publicclassView1extendsViewPart{
publicvoidcreatePartControl(Compositeparent){
CompositetopComp=newComposite(parent,SWT.NONE);
topComp.setLayout(newFillLayout());
finalListlist=newList(topComp,SWT.BORDER);
list.add("中国");
list.add("美国");
list.add("法国");
//列表选择事件监听
list.addSelectionListener(newSelectionListener(){
publicvoidwidgetSelected(SelectionEvente){
//由IWorkbenchPage取出view2
IWorkbenchPagewbp=getViewSite().getPage();
IViewPartview2=wbp.findView(".chengang.View2");
//将当前选择的列表项显示在文本框中
Texttext=((View2)view2).getText();
text.setText(list.getSelection()[0]);
}
publicvoidwidgetDefaultSelected(SelectionEvente){}
});
}
publicvoidsetFocus(){}
}
然后将View2的文本框对象改成类的实例变量,并编写它相应的set/get方法,代码如下:
publicclassView2extendsViewPart{
privateTexttext;
publicvoidcreatePartControl(Compositeparent){
CompositetopComp=newComposite(parent,SWT.NONE);
topComp.setLayout(newFillLayout());
text=newText(topComp,SWT.BORDER);
text.setText("我是text框");
}
publicvoidsetFocus(){}
//文本框text相应的set/get方法
publicTextgetText(){returntext;}
publicvoidsetText(Texttext){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”这种标识符在系统开发中会经常用到,最好建立一个常量专用类来集中放置这些字符串常量,然后系统中用的时候只用其常量名就行了,否则把标识符的字串分散在代码中,以后改起来会让你痛不欲生。
常量类的示意代码如下:
publicfinalclassStringConstants{
publicfinalstaticStringVIEW1=".chengang.View1";
publicfinalstaticStringVIEW2=".chengang.View2";
}
要用的时候则这样写:
findView(StringConstants.VIEW2);
18.4给视图加下拉菜单和按钮
本例将给视图加入下拉菜单和按钮,如图18.6所示。
同时再为列表添加一个右键菜单,这样读者可以用来和视图的下拉菜单进行比较阅读。
图18.6效果图
18.4.1创建ActionGroup类
加入菜单和按钮的方法与SWT/JFace组件的一样。
先创建一个ActionGroup代码如下:
//--------文件名:
MyActionGroup.java----------
publicclassMyActionGroupextendsActionGroup{
/*
*加入按钮
*/
publicvoidfillActionBars(IActionBarsactionBars){
if(actionBars==null)
return;
IToolBarManagertoolBar=actionBars.getToolBarManager();
toolBar.add(newAction1());
toolBar.add(newAction2());
}
/*
*加入下拉菜单、右键弹出菜单
*/
publicvoidfillContextMenu(IMenuManagermenu){
if(menu==null)
return;
menu.add(newAction1());
menu.add(newAction2());
}
privateclassAction1extendsAction{
publicAction1(){
ImageDescriptorimageDesc=WorkbenchImages.getImageDescriptor(IworkbenchGraphicConstants.IMG_ETOOL_HOME_NAV);
setHoverImageDescriptor(imageDesc);
setText("Action1");
}
publicvoidrun(){}
}
privateclassAction2extendsAction{
publicAction2(){
ImageDescriptorimageDesc=WorkbenchImages.getImageDescriptor(IworkbenchGraphicConstants.IMG_ETOOL_IMPORT_WIZ);
setHoverImageDescriptor(imageDesc);
setText("Action2");
}
publicvoidrun(){}
}
}
程序说明:
❑本程序中含有两个Action类:
Action1、Action2,和以往的Action不同之处在于它的图像描述符是直接从Eclipse环境中取得。
既然插件在Eclipse环境内运行,那么Eclipse环境本身的图标就可以直接拿来使用。
❑fillContextMenu方法比起以前的少了几句。
在18.4.2小节,可以看到它移出到View1类中去了,主要原因是为了此方法兼顾添加视图的下拉菜单。
18.4.2修改View1类
在View1中增加了三种方法,分别用来加入视图的导航栏按钮、下拉菜单,以及加入列表List的右键菜单。
代码如下:
publicclassView1extendsViewPart{
privateListlist;//将List写成类的实例变量,以扩大它的可访问范围
publicvoidcreatePartControl(Compositeparent){
CompositetopComp=newComposite(parent,SWT.NONE);
topComp.setLayout(newFillLayout());
list=newList(topComp,SWT.BORDER);
list.add("中国");
list.add("美国");
list.add("法国");
//列表选择事件监听(和以前一样,省略)
/*
*加入导航栏按钮、下拉菜单、右键菜单
*/
MyActionGroupactionGroup=newMyActionGroup();
fillViewAction(actionGroup);//加入视图的导航栏按钮
fillViewMenu(actionGroup);//加入视图的下拉菜单
fillListMenu(actionGroup);//加入视图的下拉菜单
}
/**
*加入视图的导航栏按钮
*/
privatevoidfillViewAction(MyActionGroupactionGroup){
IActionBarsbars=getViewSite().getActionBars();
actionGroup.fillActionBars(bars);
}
/**
*加入视图的下拉菜单
*/
privatevoidfillViewMenu(MyActionGroupactionGroup){
IMenuManagermenu=getViewSite().getActionBars().getMenuManager();
actionGroup.fillContextMenu(menu);
}
/**
*加入列表List的右键菜单
*/
privatevoidfillListMenu(MyActionGroupactionGroup){
MenuManagermenu1=newMenuManager();
Menum=menu1.createContextMenu(list);
list.setMenu(m);
actionGroup.fillContextMenu(menu1);
}
publicvoidsetFocus(){}
}
程序说明:
❑过去写在ActionGroup中的两句移到了fillListMenu方法中。
❑视图加按钮、菜单的方式和以前SWT/JFace的方式是一样的。
只不过以前用自己生成MenuManager对象等,而现在的插件就只需要使用视图已有的MenuManager对象。
18.5加入编辑器(editors)
本节将给出如下的实例:
双击视图1中的列表项,将在透视图中加入相应的编辑器。
这种效果就像在Eclipse中双击Java源文件,就会打开该源文件相对应的编辑器一样。
效果如图18.