深入 Common Navigator Framework 之概述

1.1 概述

CNF，全称Common Navigator Framework，是Eclipse用了方便用户扩展其资源导航功能而提供的一个框架，关于这个框架的介绍见《Common Navigator Framework初探》一文，下面这篇文章将对CNF进行一个详细的分析。分析的内容主要包括以下方面的内容：

1.    Navigator，导航视图显示
2.    Navigator Content Extensions，navigatorContent扩展点
3.    Common Filters，过滤器
4.    Common Wizards，向导（右键）
5.    Action Providers，右键菜单
6.    Drag and Drop Support，拖拽操作
7.    Link with Editor Support，与编辑器关联

 

 

1.2 Eclipse CNF

1.2.1 文件处理结构

Eclipse中文件的处理包括以下几个部分：
1.    操作系统的本地文件系统：就是硬盘上实际存在的文件；
2.    Eclipse的虚拟文件系统：Eclipse有自己的文件系统，它们建立在本地文件系统之上，详细见 org.eclipse.core.filesystem、org.eclipse.core.resource等插件；
3.    Eclipse CNF：将Eclipse的文件系统模型进行处理，然后显示在Navigator中；
4.    Eclipse Navigator视图：文件的最终显示界面。
具体见下图。

1.2.2 Project Explorer 分解

Eclipse中Project Explorer就是一个基于CNF实现的导航视图，下面我们分解一下这个视图。

 

1.2.2.1 基础结构

下图是Project Explorer中一个Java工程的显示，包括了工程、文件夹、和文件，树形结构以JFace的TreeViewer的形式显示，图中的说明文字描述了这个Viewer的content provider和label provider。
具体的扩展点实现见插件org.eclipse.ui.navigator.resources下的org.eclipse.ui.navigator.resourceContent定义。

1.2.2.2 右键菜单

下面看看它的右键菜单，它们分别是由什么提供的。下图是一个完整的右键菜单显示。

 

它们是由CNF中的action provider指定的，常用的action provider有：

写道

1. "org.eclipse.ui.navigator.resources.actions.EditActions"，编辑菜单，包括复制、剪贴、粘贴等
2. "org.eclipse.ui.navigator.resources.actions.RefactorActions"，重构菜单
3. "org.eclipse.ui.navigator.resources.OpenActions"，打开菜单
4. "org.eclipse.ui.navigator.resources.GotoActions"，转到菜单
5. "org.eclipse.ui.navigator.resources.GoIntoActions"转到菜单（Go Into）
6. "org.eclipse.ui.navigator.resources.PortingActions"导入导出菜单
7. "org.eclipse.ui.navigator.resources.NewActions"新建菜单
8. "org.eclipse.ui.navigator.resources.PropertiesActionProvider"属性菜单
9. "org.eclipse.ui.navigator.resources.WorkManagementActionProvider"
10. "org.eclipse.ui.navigator.resources.ResourceMgmtActions"资源管理菜单
11. "org.eclipse.ui.navigator.resources.UndoRedoActionProvider"撤销重做菜单

当然还有很多没有列出来的，比如Run As菜单，有兴趣的朋友可以自己查阅Eclipse的帮助文档。

1.2.2.3 过滤器

过滤器也是CNF中一个非常重要的功能，它是由扩展点，org.eclipse.ui.navigator.navigatorContent/commonFilter指定的，通过一系列的配置，由NCF统一管理。它的配置界面为：

这里列举一下常见的Filters定义，用户可以在自己的CNF实现中引用它们：

 

<commonFilter
            id="org.eclipse.ui.navigator.resources.filters.startsWithDot"
            name="%filters.startsWithDot.name"
            description="%filters.startsWithDot.description"
            activeByDefault="true"
            >
         <filterExpression>
             <and>
                <adapt type="org.eclipse.core.resources.IResource">
                    <test property="org.eclipse.core.resources.name" value=".*"/>
                </adapt>               
            </and>
         </filterExpression>
</commonFilter>

 

这个过滤器在插件org.eclipse.ui.navigator.resources中定义，作用为过滤掉以.开头的文件，用途极广。

 

1.2.2.4 向导

这里的导向指的是，在右键菜单“新建”下面出现的菜单，它们由CNF控制。
导向通过扩展点org.eclipse.ui.navigator.navigatorContent/commonWizard指定，然后被org.eclipse.ui.navigator.viewer/viewerContentBinding引用。

1.2.2.5 拖拽

这个就很明显了，Project Exporer提供了文件的拖拽操作，这个由CNF的扩展点org.eclipse.ui.navigator.navigatorContent/dragAssistent指定。

 

1.2.2.6 与编辑器关联

这个由扩展点org.eclipse.ui.navigator.linkHelper实现。