文件类型集成教程

1. 在“项目”窗口中，右键单击 "Abc File Type" 项目，然后选择“运行”。

将启动一个新的 IDE 实例，同时该实例将向其自身安装您的模块。

2. 使用“新建项目”对话框 (Ctrl-Shift-N) 在 IDE 中创建任意类型的应用程序。
3. 右键单击该应用程序节点，然后选择“新建”>“其他”。在“其他”类别中，有一个用于创建新文件类型的模板：



完成向导后，您便创建了一个可用于帮助用户创建给定文件类型的模板。

如果要通过该模板提供缺省代码，请将这些代码添加到“新建文件类型”向导所创建的 AbcTemplate.abc 文件中。

添加操作

在本小节中，我们将使用“新建操作”向导创建一个 Java 类，用于为我们的文件类型执行操作。此向导还将在 layer.xml 文件中注册该类，以使用户能够在从资源管理器窗口右键单击该文件类型节点所显示的上下文菜单中调用此操作。

1. 右键单击项目节点，然后选择“新建”>“操作”。
2. 在“操作类型”面板中，单击“有条件地启用”。键入 AbcDataObject，这是之前由“新建文件类型”向导生成的数据对象的名称，如下所示：



单击“下一步”。

3. 在“GUI 注册”面板中，从“类别”下拉列表中选择“编辑”类别。“类别”下拉列表用于控制操作在 IDE 的快捷键编辑器中的显示位置。

接下来，取消选中“全局菜单项”，然后选中“文件类型上下文菜单项”。在“内容类型”下拉列表中，选择您之前在“新建文件类型”向导中指定的 MIME 类型，如下所示：



请注意，您可以设置菜单项的位置，并将此菜单项与其前面和后面的菜单项隔开。单击“下一步”。

4. 在“名称和位置”面板的“类名”中键入 MyAction，在“显示名称”中键入 My Action。上下文菜单提供的菜单项不显示图标。因此，请单击“完成”，此时 MyAction.java 将被添加到 org.myorg.abcfiletype 包中。
5. 在源代码编辑器中，将下面的代码添加到此操作的 performAction 方法中：

   protected void performAction(Node[] activatedNodes) {
   	AbcDataObject abcDataObject = activatedNodes[0].getLookup().lookup(AbcDataObject.class);
   	FileObject f = abcDataObject.getPrimaryFile();
   	String displayName = FileUtil.getFileDisplayName(f);
   	String msg = "I am " + displayName + ". Hear me roar!"; 
           NotifyDescriptor nd = new NotifyDescriptor.Message(msg);
           DialogDisplayer.getDefault().notify(nd);
   }

   按 Ctrl-Shift-I 组合键。IDE 会自动将 import 语句添加到该类的顶部。

   某些代码仍带有红色下划线，这表示类路径中并未包括所有需要的包。右键单击项目节点，选择“属性”，然后单击“项目属性”对话框中的“库”。单击“库”窗格顶部的“添加”来添加“对话框 API”。

   在 MyAction.java 类中再次按 Ctrl-Shift-I 组合键。红色下划线将会消失，因为 IDE 在对话框 API 中找到了所需的包。

6. 在“重要文件”节点中，展开“XML 层”。"<此层>" 和 "<上下文中的此层>" 这两个节点以及它们的子节点共同组成了系统 Filesystem 浏览器。展开 "<此层>"，再展开 "Loaders"，继续展开节点，直到显示您之前所创建的操作。
7. 将 My Action 拖放到“打开”操作下方，如下所示：



从最后两步可以看出，系统 Filesystem 浏览器可用于快速重组在系统 Filesystem 中注册的各项的顺序。

8. 再次运行该模块，操作方法与上一节相同。
9. 使用上一节中所示的模板创建一个 ABC 文件，然后在某个资源管理器视图（如“项目”窗口或“收藏夹”窗口）中右键单击该文件的节点。

请注意，Abc 文件具有您在其模块中所指定的图标，并且可以从右键单击操作所显示的上下文菜单中使用在其 layer.xml 文件中定义的一系列操作：



10. 选择新菜单项，将显示 Abc 文件的名称和位置：

现在，您已了解如何创建在“项目”窗口、“文件”窗口或“收藏夹”窗口内给定类型文件的上下文菜单中显示的新操作。

在窗口中打开文件

缺省情况下，当用户打开在本教程中定义的类型的文件时，该文件将在基本编辑器中打开。但是，有时您可能需要创建文件的可视表示，以使用户能够将小部件拖放到该可视表示上。创建此类用户界面的第一步是，使用户可以在窗口中打开文件。本小节将向您演示如何执行此操作。

1. 右键单击项目节点，然后选择“新建”>“窗口组件”。将“窗口位置”设置为 "editor" 并选中“在应用程序启动时打开”，如下所示：



2. 单击“下一步”，然后在“类名前缀”中键入 "Abc"：

   

   单击“完成”。

3. 按如下所示更改 DataObject 的构造函数，将 DataObject 更改为使用 OpenSupport 而不是 DataEditorSupport：

public AbcDataObject(FileObject pf, MultiFileLoader loader)
        throws DataObjectExistsException, IOException {

    super(pf, loader);
    CookieSet cookies = getCookieSet();
    //cookies.add((Node.Cookie) DataEditorSupport.create(this, getPrimaryEntry(), cookies));
    cookies.add((Node.Cookie) new AbcOpenSupport(getPrimaryEntry()));
              
}

4. 创建 OpenSupport 类：

class AbcOpenSupport extends OpenSupport implements OpenCookie, CloseCookie {

    public AbcOpenSupport(AbcDataObject.Entry entry) {
        super(entry);
    }

    protected CloneableTopComponent createCloneableTopComponent() {
        AbcDataObject dobj = (AbcDataObject) entry.getDataObject();
        AbcTopComponent tc = new AbcTopComponent();
        tc.setDisplayName(dobj.getName());
        return tc;
    }
 
}

调整 TopComponent 以扩展 CloneableTopComponent，而不是 TopComponent。将 TopComponent 的类修饰符及其构造函数的修饰符设置为 public 而不是 private。

再次运行该模块，当打开 Abc 文件时，OpenSupport 类便会处理此打开操作，以便在 TopComponent 中打开该文件，而不是在 DataEditorSupport 所提供的基本编辑器中打开：

NetBeans 可视库教程提供了一个进一步开发 TopComponent 的示例，以便以可视方式显示文件内容（与本教程中定义的文件类型对应）。

创建多视图窗口

现在，我们已经能够在窗口中打开文件，接下来我们将使该窗口更加有趣。我们将创建一个多视图窗口。多视图窗口的第一个标签通常用于显示文件的可视表示，第二个标签则通常显示源视图。此外，该窗口也可包含两个以上的标签，每个标签提供有关已打开文件的更为详细的信息。

1. 右键单击项目节点，然后选择“属性”。在“项目属性”对话框中，选择“库”，然后单击“添加”。设置对“多视图窗口”的依赖关系。单击“确定”，然后再次单击“确定”以退出“项目属性”对话框。

2. 对于要在多视图窗口中创建的每个标签，创建一个用于实现 MultiViewDescription 和 Serializable 的类。

   就本教程而言，首先将创建一个名为 AbcMultiviewDescription1 的类以实现指定类：

   public class AbcMultiviewDescription1 implements MultiViewDescription, Serializable {
   
       public int getPersistenceType() {
           throw new UnsupportedOperationException("Not supported yet.");
       }
   
       public String getDisplayName() {
           throw new UnsupportedOperationException("Not supported yet.");
       }
   
       public Image getIcon() {
           throw new UnsupportedOperationException("Not supported yet.");
       }
   
       public HelpCtx getHelpCtx() {
           throw new UnsupportedOperationException("Not supported yet.");
       }
   
       public String preferredID() {
           throw new UnsupportedOperationException("Not supported yet.");
       }
   
       public MultiViewElement createElement() {
           throw new UnsupportedOperationException("Not supported yet.");
       }
   
   }

   在上述 AbcMultiviewDescription1 类中，方法 createElement() 返回 MultiViewElement。但是，此处需要返回的是 TopComponent，这将在下一步中完成。

3. 重写类签名。要为上一步中的描述提供多视图元素，我们需要扩展 JPanel（而不是 TopComponent），而且还需要实现 MultiViewElement：

   public final class AbcTopComponent extends JPanel implements MultiViewElement {

现在，您需要在 TopComponent 中删除（或注释掉）方法 findInstance()、getPersistenceType()、writeReplace() 和 preferredID()。

4. 暂时为每个所需的方法提供非常简单的实现。首先，在 TopComponent 类的顶部定义一个新的 JToolbar：

   private JToolBar toolbar = new JToolBar();

接下来，按如下所示实现方法：

    public JComponent getVisualRepresentation() {
        return this;
    }

    public JComponent getToolbarRepresentation() {
        return toolbar;
    }

    public void setMultiViewCallback(MultiViewElementCallback arg0) {
    }

    public CloseOperationState canCloseElement() {
        return null;
    }

    public Action[] getActions() {
        return new Action[]{};
    }

    public Lookup getLookup() {
        return Lookups.singleton(this);
    }

    public void componentShowing() {
    }

    public void componentHidden() {
    }

    public void componentActivated() {
    }

    public void componentDeactivated() {
    }

    public UndoRedo getUndoRedo() {
        return UndoRedo.NONE;
    }

5. 现在，您可以重新定义 AbcMultiviewDescription1，如下所示：

   public class AbcMultiviewDescription1 implements MultiViewDescription, Serializable {
   
       public int getPersistenceType() {
           return TopComponent.PERSISTENCE_ALWAYS;
       }
   
       public String getDisplayName() {
           return "Tab 1";
       }
   
       public Image getIcon() {
           return ImageUtilities.loadImage("/org/myorg/abcfiletype/Datasource.gif");
       }
   
       public HelpCtx getHelpCtx() {
           return null;
       }
   
       public String preferredID() {
          return "AbcMultiviewDescription1";
       }
   
       public MultiViewElement createElement() {
           return new AbcTopComponent();
       }
   
   }

6. 更改 OpenSupport 类中的 createCloneableTopComponent 方法，以通过在上面部分创建的 MultiViewDescription 类打开 TopComponent：

   protected CloneableTopComponent createCloneableTopComponent() {
   
       // Create an array of multiview descriptors:
       AbcMultiviewDescription1 firstTab = new AbcMultiviewDescription1();
       MultiViewDescription[] descriptionArray = { firstTab };
   
       // Create the multiview window:
       CloneableTopComponent tc = MultiViewFactory.createCloneableMultiView(descriptionArray, firstTab,  null);
       tc.setDisplayName(entry.getDataObject().getName());
       return tc;
   
   }

   MultiViewFactory.createCloneableMultiView 中的第二个参数决定缺省情况下所打开的标签。在本示例中为 AbcMultiViewDescription1 定义的标签 firstTab。

7. 再次安装并打开文件。现在，您已创建包含一个标签的多视图窗口：

现在，多视图窗口中只有一个标签。对于每个其他标签，创建一个新的 MultiviewDescription 类和一个新的 JPanel，然后实例化 OpenSupport 扩展类中的 MultiViewDescription 类，如上所示。

1. 在“项目”窗口中，右键单击 "Abc File Type" 项目，然后选择“创建 NBM”。

将创建 NBM 文件，您可以在“文件”窗口 (Ctrl-2) 中查看它：



2. 例如，通过 NetBeans 插件门户向其他人提供该文件。接收者应使用插件管理器（“工具”>“插件”）来安装它。