拖放 Eclipse Workbench 标签

核心提示：在本文中，我们将学习一种通过编程定制 Eclipse 中的编辑器和视图标签的拖放行为的技术，拖放 Eclipse Workbench 标签，我们使用了一个示例来展示这种技术，该示例将编辑器与转移类型 org.eclipse.ui.part.EditorInputTransfer 进行关联，在 Eclipse 中实例化这

　　在本文中，我们将学习一种通过编程定制 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 作为转移类型的控件上。

　　由于编辑器标签通常放在 CTabFolder 容器中，因此我们需要为存放编辑器的 CTabFolder 容器创建一个 DragSource，并在这个 DragSource 的 dragSetData() 方法中执行 操作 1 和 操作 2。假设我们可以捕捉存放编辑器的 CTabFolder 容器，那么创建所需拖放源的任务就非常简单，如下所示：

清单 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 添加拖放监听器