Navigator 之 linkHelper

http://blog.sina.com.cn/s/blog_560eea89010005ql.html

org.eclipse.ui.navigator.linkHelper是一个提供连接到Editor的扩展点.完成Navigator浏览里面"Link With Editor"的功能.
首先看需求.我们在做产品的时候参照了Eclipse里面JDT PackageExplorer关于Link With Editor的功能描述,要点如下:

当Link With Editor有效时:

1). 双击PackageExplorer中的一个文件时,用已经注册的Editor打开这个文件.单击不打开.

2). 在PackageExplorer中双击一个Java文件里的一个Field或者Method时,如果编辑器没有打开这个文件,则要打开这个文件,但不要求Editor定位到文件中相应的位置,但如果当前文件已经被Editor打开了,那么要像点击了Outline一样,让Editor定位到详细位置.在文本Editor中即这个 Field或者Method所在的行数.像我们这样的GraphicalEditor当然就要选中这个Element.

3). 选择不同文件的Editor,PackageExplorer将更换选项为Editor所指向的文件.

4). 选择Editor中不同的Element,PackageExplorer中不必及时更新选中项,应该由Outline负责这件事情.

概括为双向的查找,所以LinkHelper扩展点的功能类要实现Interfaceorg.eclipse.ui.navigator.ILinkHelper.
该Interface有两个Methods:

更新Package Explorer的选择项.
IStructuredSelection findSelection(IEditorInput anInput);

双击Package Explorer中的Item,要调用这个方法让Editor做出反应
void activateEditor(IWorkbenchPage aPage, IStructuredSelectionaSelection);

当然,现在(Eclipse 3.2Edition)的PackageExplorer是在Navigator架构下工作的,所以其实现机制算是相当标准.条条大路通罗马,在Navigator框架下,不按其机制办事虽然不标准,但也可以完成任务,只不过为后来人创造了一些工作困难罢了.

需求已经明确,下面开始探索完成工作的步径.(老板的要求是两天之内完成这项工作,现在是第一天下班前90分钟,不知道我可以找到什么.希望明天这个时候我已经安心地在做着下一个任务了).

既然PackageExplorer已经实现了Linkhelper,那么看看它的源代码,就应该可以找到其中的奥妙,所以第一步,就是到Eclipse的CVS上面DownLoad源程序.
关于获取CVS设置得到源文件的方法请参见网页:
获取Eclipse源代码的CVS设置

Java开发环境中的PackageExplorer属于JDT项目,JDT项目是Eclipse的内置子项目,所以CVS RepositoryPaths 应该选择/cvsroot/eclipse

Package Explorer实现代码在org.eclipse.jdt.ui项目包中.
打开plugin.xml文件,可以发现其中正是实现了全部的Navigator框架.从Viewer定义到Navigator扩展,和我现在最关心的Linkhelper,一包打尽.

剩下的事情就是阅读代码,找到其中的关节.Ok,我现在开始读代码了,事后会把得到的要领进一步整理出来.现在是十点正,我也很期待,看自己这次能不能按时完成任务:)

LinkHelper扩展点有两个子项.

一个是selectionEnablement,用来注册自己会在哪些类型上面发生作用.当单击这些类型的时候,就会调用被指定的实现了ILinkHelper接口的工具类操作当前IWorkbenchPage的Editors,代码体现在activateEditor(IWorkbenchPage page, IStructuredSelection selection).
另一个是editorInputEnabement,用来注册喜欢的Editor输入.这样可以做到根据Editor的变化改变当前的选择项.代码写在public IStructuredSelection findSelection(IEditorInputinput)中.

Ok,这样两边的变化就都被捕获到了.程序写法可以参见示例项目:org.eclipse.ui.navigator.resources.里面有关于文件和文件编辑器之前LinkHelper的完整代码实例.

实现细节不再详述,现在问题的难点在展开PackageExplorer中的一个Java文件后,双击一个方法或变量就会打开Java CodeEditor并且定位到相应的文档位置.

原来在Viewer中双击鼠标之后,双击事件被程序捕获,该程序首先判断是否有注册了的ICommonActionConstants.OPEN对应的值,如果有,则进行Open操作,比如双击了IFile,就会有一个打开文件的Action去做动作.但是如果是Java文件中的一个方法呢,不是IFile类型,程序要打开编辑器,这是怎么实现的?

带着这样的问题,我找到了ICommonActionConstants.OPEN键的值提供者,在JDT里面是一个ID为org.eclipse.jdt.internal.ui.navigator.PackageExplorerOpenActionProvider
的ActionProvider,隶属于org.eclipse.ui.navigator.navigatorConten扩展点,当然,这个就是注册给PackageExplorer Viewer的Content Binding.

于是所有的注意力都集中在这个OpenProvider是如何实现内容的Open.

在PackageExplorerOpenActionProvider类内部有两个Field, 一个是fOpenAndExpand,类型为IAction,运行时指向一个OpenAndExpand实例.
另一个名字叫做fOpenGroup,运行指向一个OpenEditorActionGroup实例.

研究发现,这两个类的程序写得都很不好看,看了一个小时不知所以然.一气之下关之.
终于数分钟之后,找到了ActionProvider的fillActionBars方法,每次Viewer发生了SelectionChanged,都会叫这个方法,该方法分析选中类型并决定是否把OpenAction加进去,因此在这里做些小手脚,就可以搞定任务了.

方法思路:

如果当前选中的项不是IFile,而是已知的一种IFile解析之后的内容,如一个类成员,这时候我们得到TreeViewer中的路径,从叶结点向上找,找到第一个IFile文件类型,那么这个一定是要打开的文件,然后改变OpenAciotn的当前值为这个IFile,如此双击的时候这个OpenAction便被执行,就完成了双击内容打开一个Editor的工作.至于打开的Editor是否已经存在,存在的Editor要置顶等工作是Action的Run方法自己的事情了.

*关于在TreeViewer中由已知的选中结节,得到整条Path,可以通过:

((TreeSelection)((TreeViewer)viewSite.getSelectionProvider()).getSelection()).getPathsFor(selection.getFirstElement())[0]

得到.


关于双击打开文件的方法已经不是Linkhelper的内容,他们是相互独立的.这里只是做到了顺便提一下.因为所有为公司制作的程序代码需要保护,所以一生在这里不再粘贴.

现在离下班还有15分钟,虽然走了很多弯路,但是本次任务依然顺利完成.