在本文中，我们将学习一种通过编程定制 eclipse 中的编辑器和视图标签的拖放行为的技术。我们使用了一个示例来展示这种技术，该示例将编辑器与转移类型 org.eclipse.ui.part.editorinputtransfer 进行关联。可以通过实现对这种转移类型的支持来支持编辑器的拖放行为。我们还为视图标签提供了一个类似的展示。本文假设您熟悉 swt 的拖放技术。
定制意味着什么？
eclipse workbench 中的编辑器和视图标签可以支持默认拖放行为，默认拖放行为支持：
- 视图在 workbench 内部的移动和停靠
- 在有标签的记事本内部重新安排视图或编辑器的顺序
- 创建快速视图
- 为了并排查看源代码，在编辑器区域并排显示几个编辑器
尽管这是一个非常令人振奋的功能列表，但在我去年从事的一个项目中，仍然需要更多的功能。用户需要能够对编辑器和视图标签进行拖放，将它们放到一个特殊的视图上。当用户这样做时，我们要做的是截获所拖放编辑器的 editor-id 和 input，以及所拖放视图的 view-id，然后在一个特殊的视图中显示相同的内容。下面的 图 1 和 图 2 将展示这种功能。
图 1 给出了一个标题为 .project 的编辑器，该编辑器被拖放到一个标题为 drop window 的特殊视图中。一旦拖放到如 图 2 所示的位置处，这个特殊的视图就会显示所拖放编辑器的 editor-id 和 input。
图 1. 正被拖放到特殊视图中的编辑器标签
图 2. 被拖放到特殊视图上的编辑器标签
与我们在这个项目中的要求类似，还可能存在其他一些需要对编辑器或视图标签的默认拖放行为进行定制的情况。例如，有人可能会希望允许 eclipse 用户将编辑器标签从工作台窗口中拖出，将它放到相同 eclipse 实例的另外一个窗口中。本文中介绍的技术也可以在这种情况下使用。
下面让我们来学习定制拖放行为所涉及的步骤，具体地说，这些步骤是针对编辑器标签的，但它们同样适用于视图标签。 定制编辑器标签的拖放行为
当 eclipse 用户拖动一个编辑器标签时，要实现如 图 1 和 图 2 所示的定制拖放功能，并内部执行以下两个主要任务或操作：
- 操作 1
- 捕获底层编辑器的 ieditorinput 和 editor-id，前者包含有关正在编辑的文件的信息；后者包含有关编辑正在使用的编辑器的类型信息。
- 操作 2
- 将 editor-input 和 editor-id 放到 editorinputtransfer.editorinputdata 对象中，并将其设置为拖放过程中正在转移的对象。这种操作可以让 swt 负责实现其余的拖放操作，例如将编辑器标签放到使用 editorinputtransfer 作为转移类型的控件上。
清单 1. 为 tab folder 创建拖放源
ctabfolder tabfolder = <"ctabfolder" composite that hosts editor-parts>; int operations = dnd.drop_copy | dnd.drop_default; dragsource dragsource = new dragsource(tabfolder, operations); transfer[] transfertypes = new transfer[] {editorinputtransfer.getinstance()}; dragsource.settransfer(transfertypes); dragsource.adddraglistener(new dragsourcelistener() { public void dragstart(dragsourceevent dsevent) { } public void dragsetdata(dragsourceevent dsevent) { //code to perform operation-1 and operation-2 } public void dragfinished(dragsourceevent dsevent) { } }); |
此处另外一个非常重要的假设是：ctabfolder 容器并没有已经创建好的拖放源。否则，代码 dragsource dragsource = new dragsource(tabfolder, operations); 就会触发一个 swterror 错误，这是因为我们不能为同一个控件创建多个拖放源。
要查看这种假设是否有效（这也是 清单 1 的一个可能用途），让我们来看一下与这个编辑器标签有关的默认拖放行为。默认的行为提示说存放这个编辑器标签的 ctabfolder 容器可能早已为其创建了一个拖放源。然而，快速查看 org.eclipse.swt.custom.ctabfolder.java 的代码可以看到，ctabfolder 的默认拖放操作都不是通过创建一个拖放源来实现的，而是通过为 swt.dragdetect、swt.mousemove 和 swt.mouseup 类型的事件添加监听程序来实现的。ctabfolder 容器还没有创建拖放源的假设仍然有效，正如我们可以看到的一样，这是基于查看非 api 内部类获得的信息而作出的假设。因此，如果这种假设在将来的版本中无效，也不用感到惊奇；不过我认为这种可能性非常小。
下面让我们来看一下如何捕获存放编辑器的 ctabfolder 容器。通过对编辑器平铺行为的观察，我们注意到不管在何时平铺显示编辑器，都会创建一个新的 tab 文件夹。另外，当一个标签组中的所有编辑器全部关闭或被移动到一个不同的 tab 文件夹上时，原来的 tab 文件夹就会被销毁。这意味着 ctabfolder 容器的创建和销毁都是动态的，因此 ctabfolder 容器的拖放源的创建也应该是动态完成的。
要实现这种功能，需要能够对 ctabfolder 容器的创建进行控制。但是 eclipse 并没有提供任何可以在创建 ctabfolder 容器时进行回调的功能。另外一种方法是对 ctabfolders 进行特殊化 (specialize) 处理（继承），继承这些 specialized ctabfolders（继承类，而不是基类 ctabfolder），并在这些 specialized ctabfolders 的 constructors 中创建拖放源。然而，在 eclipse 中实例化这些 specialized ctabfolders 是一项非常繁杂的任务，因此我们需要寻找一种新的解决方案。
一种创建拖放源的新方法
下面让我们为 display 添加一个拖放检测监听器（用来监听 swt.dragdetect 类型的事件），如下所示：
清单 2. 为 display 添加拖放监听器
platformui.getworkbench().getdisplay().addfilter(swt.dragdetect, new listener() { public void handleevent(event event) { } }); |
不论何时发生拖放操作时，都会调用这个监听器的 handleevent() 方法，其中 event.widget 指向产生这个事件的控件。在拖动编辑器标签时，event.widget 指向存放这个拖放编辑器标签的 ctabfolder 容器。这样我们现在就可以为这个 ctabfolder 容器创建一个拖放源，如下所示：
清单 3. 捕获存放编辑器的 tab 文件夹
platformui.getworkbench().getdisplay().addfilter(swt.dragdetect, new listener() { public void handleevent(event event) { //ignore drag of widgets other than tab-folders (which host editor and view tabs) if(!(event.widget instanceof ctabfolder)) return; ctabfolder draggedfolder = (ctabfolder)event.widget; int operations = dnd.drop_copy | dnd.drop_default; final dragsource dragsource = new dragsource(draggedfolder, operations); transfer[] transfertypes = new transfer[] {editorinputtransfer.getinstance()}; dragsource.settransfer(transfertypes); dragsource.adddraglistener(new dragsourcelistener() { public void dragstart(dragsourceevent dsevent) { } public void dragsetdata(dragsourceevent dsevent) { //code to perform operation-1 and operation-2 } public void dragfinished(dragsourceevent dsevent) { dragsource.dispose(); } }); } }); |
现在我们主要关心的是在开始拖放操作之后创建了一个新的拖放源。在开始拖放操作之后创建一个拖放源，这样做是否能够确保这个新的拖放源可以接收现在发生的拖放操作的通知？
为了寻找答案，首先让我们来了解一下 eclipse 的事件分发行为。
当控件上产生某种类型的事件时，首先将是那些为相同事件类型注册的 display 的所有过滤器 收到发生该事件的通知（使用 display.addfilter() 方法添加的监听器），接收顺序是过滤器在 display 上的注册顺序。然后发生该事件的通知会发送给控件中为该事件类型注册的所有监听器，发送顺序是这些监听器在控件上的注册顺序。
例如，假设 listener 1 是在某个控件上为 t1 类型的事件注册的第一个监听器，而 listener 2 是在这个控件上为相同的 t1 类型的事件注册的第二个监听器。另外假设 filter 1 是在 display 上为相同的 t1 类型的事件注册的过滤器。现在，当这个控件上产生一个 t1 类型的事件时，第一个接收到发生该事件的通知的是 filter 1，然后是 listener 1，最后是 listener 2。
在这种新方法中，我们给 display 为 swt.dragdetect 类型的事件添加了一个 filter。默认拖放行为与编辑器标签有关，这意味着要对编辑器重新进行排列和平铺，说明 ctabfolder 存在多个拖放检测监听器。因此，我们有一个 filter 和多个与 ctabfolder 有关的 default-listeners，它们都要监听 swt.dragdetect 事件。
当我们拖动一个编辑器标签时，filter 会第一个接收到这种拖动操作。在 filter 的 handleevent() 方法中，我们正在创建一个 drag source，并为这个 drag-source 添加了一个 dragsourcelistener。然后，它会向父 ctabfolder 容器注册了另外一个拖放检测监听器，我们称之为 drag-listener-x。因此，当程序控制返回 filter 的 handleevent() 方法时，就会有一组 default-listeners 和 drag-listener-x 在等待接收拖动事件的通知。在通知 default set of listeners 之后，新注册的 drag-listener-x 也会接收到拖放事件的通知，这样就可以实现我们的目的了。
下图以图形方式显示了这些操作：
图 3. 拖放编辑器标签的序列图
注意，在 dragfinished() 方法中（参见上面的 清单 3），我们对在 ctabfolder 容器上创建的 drag-source 进行了处理。实际上这是因为为每次拖放操作都创建了一个 drag-source，我们并没有对原来的 drag-source 进行处理，这会使问题变得更加复杂。对 drag-source 的处理还从 ctabfolder 的事件监听器表中删除了 drag-listener-x（它是在创建 drag-source 时添加的），如上面的 图 3 所示。 如何捕获所拖放编辑器的 ieditorinput 和 editor id？
下面让我们来看一下怎样在 dragsetdata() 方法中实现 操作 1 和 操作 2。
由于编辑器与包含它的 ctabfolder 之间的映射并没有公开，因此可以依靠 iworkbenchpage.getactivepart() 来获得正在拖放的工作台部分，从中可以很容易地提取出所需的信息，如下面的代码所示：
清单 4. 捕获所拖放编辑器的 editor-input 和 editor-id
public void dragsetdata(dragsourceevent dsevent) { iworkbenchwindow workbenchwindow = platformui.getworkbench().getactiveworkbenchwindow(); iworkbenchpart workbenchpartbeingdragged = workbenchwindow.getactivepage().getactivepart(); if(workbenchpartbeingdragged instanceof ieditorpart) { string editorid = workbenchpartbeingdragged.getsite().getid(); ieditorinput editorinput = ((ieditorpart)workbenchpartbeingdragged).geteditorinput(); editorinputtransfer.editorinputdata data = editorinputtransfer.createeditorinputdata(editorid, editorinput); dsevent.data = new editorinputtransfer.editorinputdata[] { data }; } } |
限制 tab 文件夹的默认拖放监听器的行为
正如上面介绍的一样，编辑器标签有一种默认的拖放行为，它将进行重新排列和平铺操作，这可以使用拖放检测、鼠标移动 和鼠标释放 类型的事件的监听器实现。这些鼠标移动和鼠标释放的事件监听器的行为可能会与我们正在对编辑器实现的拖放行为冲突。例如，在将编辑器标签拖放到 drop window 上之后，如 图 2 所示，编辑器标签的重新排列和平铺会重新出现，这会导致在执行定制行为中产生意料不到的操作。（我们可以认为这是另外一次操作。）因此，限制默认监听器的行为是非常有必要的。
我们的想法是取消或忽略所发生的其他拖放操作。eclipse 用户可以通过使用 esc 键或右键点击鼠标来轻松实现这种功能。通过编程可以很容易实现这种功能：使用 event.button 值而不是 1 来执行触发鼠标释放事件，如下所示：
清单 5. 取消其他拖放操作
public void dragfinished(dragsourceevent dsevent) { dragsource.dispose(); // inhibit the action of ctabfolder's default drag-drop-listeners draggedfolder.notifylisteners(swt.mouseup, null); } |
对视图标签的拖放行为进行定制
由于视图通常都存放在 ctabfolder 容器中，因此上面用来定制编辑器的拖放行为的方法也可以用来定制视图的拖放行为。要像上面的 图 1 和 图 2 中所显示的那样对视图的拖放行为进行定制，则需要执行以下操作：当用户拖动一个视图标签时，捕获底层视图的 view-id，并将其设置为拖放过程中正在转移的对象。下面黑色字体表示的代码是应该在上面 清单 3 和 清单 4 的基础上添加的代码。
清单 6. 定制编辑器和视图标签的拖放行为
platformui.getworkbench().getdisplay().addfilter(swt.dragdetect, new listener() { public void handleevent(event event) { //ignore drag of widgets other than tab-folders (which host //editor and view tabs) if(!(event.widget instanceof ctabfolder)) return; final ctabfolder draggedfolder = (ctabfolder)event.widget; //handle special case where no editors are open but editor area //(and hence containing tab-folder) are still visible. now try //dragging the tab-folder. this drag should be ignored. if( draggedfolder.getitemcount() < 1 ) return; int operations = dnd.drop_copy | dnd.drop_default; final dragsource dragsource = new dragsource(draggedfolder, operations); //get a reference to the workbench-part that is being dragged iworkbenchwindow workbenchwindow = platformui.getworkbench().getactiveworkbenchwindow(); final iworkbenchpart workbenchpartbeingdragged = workbenchwindow.getactivepage().getactivepart(); transfer[] transfertypes = null; if(workbenchpartbeingdragged instanceof ieditorpart) transfertypes = new transfer[] {editorinputtransfer.getinstance()}; else transfertypes = new transfer[] {texttransfer.getinstance()}; dragsource.settransfer(transfertypes); dragsource.adddraglistener(new dragsourcelistener() { public void dragstart(dragsourceevent dsevent) { } public void dragsetdata(dragsourceevent dsevent) { if(workbenchpartbeingdragged instanceof ieditorpart) { string editorid = workbenchpartbeingdragged.getsite().getid(); ieditorinput editorinput = ((ieditorpart)workbenchpartbeingdragged).geteditorinput(); editorinputtransfer.editorinputdata data = editorinputtransfer.createeditorinputdata(editorid, editorinput); dsevent.data = new editorinputtransfer.editorinputdata[] { data }; } else if(workbenchpartbeingdragged instanceof iviewpart) { string viewid = workbenchpartbeingdragged.getsite().getid(); dsevent.data = viewid; } } public void dragfinished(dragsourceevent dsevent) { dragsource.dispose(); // inhibit the action of ctabfolder's default drag-detect-listeners draggedfolder.notifylisteners(swt.mouseup, null); } }); } }); |
运行这个示例
这个 dragdropworkbenchparts 插件在 window 菜单中增加了一个菜单项 enable drag-n-drop of editor/view parts。它在工具条中添加了一个相应的触发按钮。当用户选择这个菜单项或触发按钮时，就会有一个如 清单 6 所示的过滤器 被添加到 display 中，从而启用编辑器和视图标签的拖放操作。当没有选择这个操作时，就会从 display 中删除这个过滤器，恢复编辑器和视图标签的默认拖放行为（这意味着又可以进行重新排列和平铺操作了）。
该插件还定义了一个标题为 drop window 的视图，它有一个支持 editorinputtransfer 和 texttransfer 的拖放目标，允许将编辑器和视图标签拖放到此窗口中。
闽公网安备 35060202000074号