| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
| <html xmlns="http://www.w3.org/1999/xhtml">
|
| <head>
|
| <!-- -*- xhtml -*- -->
|
| <title>针对 NetBeans 平台 6.5 的文件类型集成教程</title>
|
| <link rel="stylesheet" type="text/css" href="https://netbeans.org/netbeans.css"/> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
| <meta name="AUDIENCE" content="NBUSER"/>
|
| <meta name="TYPE" content="ARTICLE"/>
|
| <meta name="EXPIRES" content="N"/>
|
| <meta name="developer" content="gwielenga@netbeans.org"/>
|
| <meta name="indexed" content="y"/>
|
| <meta name="description"
|
| content="A short guide to using the DataLoader API, as well as other APIs
|
| relating to file support."/>
|
| <!-- Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved. -->
|
| <!-- Use is subject to license terms.-->
|
| </head>
|
| <body>
|
| <h1>文件类型集成教程</h1>
|
|
|
| <p>本教程将向您演示如何编写一个模块，以便使 IDE 或构建于 NetBeans 平台之上的任何其他应用程序能够识别新的文件类型。</p>
|
|
|
| <p><b class="notes">注意：</b>本文档针对的是 NetBeans IDE 6.5 发行版。如果使用的是 NetBeans IDE 6.x，请参见<a href="60/nbm-filetype_zh_CN.html">本文档的 6.1 版</a>。</p>
|
|
|
| <p><b>目录</b></p>
|
|
|
| <p><img src="../images/articles/69/netbeans-stamp7-8-9.png" class="stamp" width="114" height="114" alt="本页上的内容适用于 NetBeans IDE 6.5、6.7、6.8" title="本页上的内容适用于 NetBeans IDE 6.5、6.7、6.8" /></p>
|
| <ul class="toc">
|
| <li><a href="#intro">文件类型集成简介</a></li>
|
| <li><a href="#creating">创建模块项目</a></li>
|
| <li><a href="#recognizing">识别 Abc 文件</a></li>
|
| <li><a href="#install">安装和试用功能</a></li>
|
| <li><a href="#adding">为 Abc 文件创建功能</a>
|
| <ul>
|
| <li><a href="#action">添加操作</a></li>
|
| <li><a href="#topcomponent">在窗口中打开文件</a></li>
|
| <li><a href="#multiview">创建多视图窗口</a></li>
|
| </ul></li>
|
| <li><a href="#share">创建可共享的二进制文件</a></li>
|
| </ul>
|
|
|
| <p><b>要学习本教程，您需要具备下表中列出的软件和资源。</b></p>
|
|
|
| <table>
|
| <tbody>
|
| <tr>
|
| <th class="tblheader" scope="col">软件或资源</th>
|
| <th class="tblheader" scope="col">要求的版本</th>
|
| </tr>
|
| <tr>
|
| <td class="tbltd1"><a href="https://netbeans.org/downloads/index.html">NetBeans IDE</a></td>
|
| <td class="tbltd1">6.7 或更高版本</td>
|
| </tr>
|
| <tr>
|
| <td class="tbltd1"><a href="http://java.sun.com/javase/downloads/index.jsp">Java Developer Kit (JDK)</a></td>
|
| <td class="tbltd1">版本 6 或<br/>版本 5</td>
|
| </tr>
|
| </tbody>
|
| </table>
|
|
|
|
|
|
|
|
|
| <h2 class="tutorial"><a name="intro"></a>文件类型集成简介</h2>
|
|
|
| <p>在 IDE 中可识别的文件类型有它们自己的图标、菜单项以及行为。所显示的“文件”是 <tt>FileObject</tt>，即 <tt>java.io.File</tt> 的包装器；对于配置文件，则为以某种其他方式存储（例如存储在模块的 XML 文件内）的数据的包装器。您实际<i>看到</i>的是 <tt>Node</tt>，它们向诸如文件之类的对象提供操作和本地化名称等功能。位于 <tt>Node</tt> 和 <tt>FileObject</tt> 之间的是 <tt>DataObject</tt>。<tt>DataObject</tt> 与 <tt>FileObject</tt> 类似，不同之处在于它了解显示的是哪种类型的文件，并且对于具有不同扩展名的文件以及具有不同名称空间的 XML 文件，通常存在不同类型的 <tt>DataObject</tt>。每个 <tt>DataObject</tt> 都是由一个不同的模块提供的，每个模块支持一种或多种文件类型，例如，通过图像模块可以识别和打开 <tt>.gif</tt> 和 <tt>.png</tt> 文件。</p>
|
|
|
| <p>用于识别文件类型的模块会安装一个 <tt>DataLoader</tt>，这是特定于文件类型的 <tt>DataObject</tt> 工厂。当展开某个文件夹时，IDE 会询问每个已知的 <tt>DataLoader</tt> 是否了解此文件夹的内容。第一个回答“是”的 DataLoader 将为其中的文件创建 <tt>DataObject</tt>。为了实际显示每个文件的某些内容，系统会对每个 <tt>DataObject</tt> 调用 <tt>DataObject.getNodeDelegate()</tt>，而 <tt>Node</tt> 便是您在 IDE 中实际看到的内容。</p>
|
|
|
| <p>下图（居左）显示了上面提到的每一项所提供的内容：</p>
|
|
|
| <p><img src="../images/tutorials/filetype/diagram-dataobject2.png" alt="图。" /></p>
|
|
|
| <p>在本教程中，您将创建一个模块，用于为假定的 "Abc" 文件（扩展名为 <tt>.abc</tt>）安装 <tt>DataLoader</tt>。缺省情况下，扩展名为 "abc" 的文件会被视为 IDE 无法识别的任何其他文件；在本教程中，我们将其视为文本文件，因此，IDE 应为 Abc 文件提供与文本文件相同的功能。创建此模块后，我们将向您演示如何用仅供 Abc 文件使用的功能来增强此模块。开发周期完成后，您可以通过以下方法轻松地让其他人使用您的模块：在 IDE 中创建一个二进制文件并将此文件发送给其他人，后者可以通过更新中心来安装此文件。</p>
|
|
|
| <!-- ===================================================================================== -->
|
|
|
| <h2 class="tutorial"><a name="creating"></a>创建模块项目</h2>
|
|
|
| <p>在此部分，我们将利用向导创建每个 NetBeans 模块所需的源代码结构。源代码结构包含位于特定位置的某些文件夹以及一组始终需要的文件。例如，每个 NetBeans 模块都需要一个 <tt>nbproject</tt> 文件夹和一个 <tt>layer.xml</tt> 文件，前者用于存放项目的 meta 数据，后者用于工具栏按钮和窗口等项的声明性注册。</p>
|
|
|
| <ol>
|
|
|
| <li>选择“文件”>“新建项目”(Ctrl-Shift-N)。在“类别”下选择“NetBeans 模块”。在“项目”下选择“模块”，然后单击“下一步”。</li>
|
| <li>在“名称和位置”面板的“项目名称”中键入 <tt>AbcFileType</tt>。将项目位置更改为计算机上的任意目录，例如 <tt>c:\mymodules</tt>。将“独立模块”单选按钮保留为选中状态。此面板现在应如下所示：
|
|
|
| <p><img style="border: 1px solid #0e1b55" src="../images/tutorials/filetype/65-projectwizard1.png" alt="“新建项目”向导的第 1 步。" /></p>
|
| <p>单击“下一步”。</p></li>
|
|
|
| <li>在“基本模块配置”面板的“代码名称基”中键入 <tt>org.myorg.abcfiletype</tt>。在建议的模块显示名称中添加空格，以将其更改为 <tt>Abc File Type</tt>。选中“生成 XML 层”复选框并保留本地化包和 XML 层的位置，以将其存储在名为 <tt>org/myorg/abcfiletype</tt> 的包中。此面板现在应如下所示：
|
|
|
| <p><img src="../images/tutorials/filetype/65-projectwizard2.png" alt="“新建项目”向导的第 2 步。" /></p></li>
|
|
|
| <li>单击“完成”。</li></ol>
|
|
|
| <p> IDE 将创建 <tt>Abc File Type</tt> 项目。此项目包含所有源代码和项目 meta 数据，例如项目的 Ant 生成脚本。此项目在 IDE 中打开。您可以在“项目”窗口 (Ctrl-1) 中查看其逻辑结构，在“文件”窗口 (Ctrl-2) 中查看其文件结构。例如，“项目”窗口现在应如下所示：</p>
|
|
|
| <p><img src="../images/tutorials/filetype/65-projectswindow1.png" alt="最初的“项目”窗口。" /></p>
|
|
|
| <!-- ===================================================================================== -->
|
| <h2><a name="recognizing"></a>识别 Abc 文件</h2>
|
|
|
| <p>在此部分，我们将利用向导创建区分 Abc 文件和所有其他文件所需的类。在本教程的开头已提到，要实现此目的，我们需要一个数据对象、一个数据加载器、一个 MIME 类型解析器以及 <tt>layer.xml</tt> 文件中的注册条目。“新建文件类型”向导将自动为我们创建所有这些内容。</p>
|
|
|
|
|
| <ol>
|
|
|
| <li>右键单击项目节点，然后选择“新建”>“文件类型”。</li>
|
| <li>在“文件识别”面板中，执行以下操作：
|
| <ul>
|
| <li>在“MIME 类型”编辑框中键入 <tt>text/x-abc</tt>。</li>
|
| <li>在“按文件扩展名”编辑框中键入 <tt>.abc .ABC</tt>。</li>
|
| </ul>
|
| <p>“文件识别”面板现在应如下所示：</p>
|
|
|
| <p><img style="border: 1px solid #0e1b55" src="../images/tutorials/filetype/60-filewizard1.png" alt="“新建文件”向导的第 1 步。" /></p>
|
|
|
| <p>请注意下面提供的有关“文件识别”面板中的字段的说明：</p>
|
| <ul>
|
| <li><b>MIME 类型。</b>指定数据对象的唯一 MIME 类型。</li>
|
| <li>按
|
| <ul><li><b>文件扩展名。</b>指定一个或多个文件扩展名，IDE 将这些扩展名识别为属于指定的 MIME 类型。可以选择在文件扩展名前面加一个圆点。分隔符为逗号和/或空格。因此，所有以下内容都是有效的：
|
| <ul><li><tt>.abc,.def</tt></li>
|
| <li><tt>.abc .def</tt></li>
|
| <li><tt>abc def</tt></li>
|
| <li><tt>abc,.def ghi, .wow</tt></li></ul>
|
| <p>我们假定 Abc 文件区分大小写。为此，在本教程中指定了<i>两种</i> MIME 类型：<tt>.abc</tt> 和 <tt>.ABC</tt>。</p></li>
|
| <li><b>XML 根元素。</b>指定唯一的名称空间，以将该 XML 文件类型与所有其他 XML 文件类型区分开。由于许多 XML 文件具有相同的扩展名 (<tt>xml</tt>)，因此 IDE 通过 XML 根元素来区分各个 XML 文件。更确切地说，就是 IDE 可以区分名称空间以及 XML 文件中的第一个 XML 元素。例如，您可以利用这一点来区分 JBoss 部署描述符和 WebLogic 部署描述符。区分开这两种部署描述符后，便可以确保添加到 JBoss 部署描述符上下文菜单中的菜单项对于 WebLogic 部署描述符不可用。有关示例，请参见 <a href="nbm-palette-api2.html">NetBeans 组件面板模块教程</a>。</li></ul></li>
|
| </ul>
|
|
|
| <p>单击“下一步”。</p></li>
|
|
|
| <li>在“名称和位置”面板的“类名前缀”中键入 <tt>Abc</tt>，然后浏览到任意 16x16 像素的图像文件作为新文件类型的图标，如下所示。
|
|
|
| <p><img style="border: 1px solid #0e1b55" src="../images/tutorials/filetype/65-filewizard2.png" alt="“新建文件”向导的第 2 步。" /></p>
|
|
|
|
|
| <p><b>注意：</b>您可以使用尺寸为 16x16 像素的任意图标。如果愿意，可以单击以下图标并将其保存在本地，然后在上面的向导步骤中指定该图标：<img style="border: 1px solid #0e1b55" src="../images/tutorials/filetype/Datasource.gif" alt="Datasource.gif" /></p></li>
|
|
|
| <li>单击“完成”。</li></ol>
|
|
|
| <p>“项目”窗口现在应如下所示：</p>
|
|
|
| <p><img src="../images/tutorials/filetype/65-projectswindow2.png" alt="最终的“项目”窗口。" /></p>
|
|
|
| <p>下面简要介绍了每个新生成的文件：</p>
|
| <ul>
|
| <li><b>AbcDataObject.java。</b>包装 <tt>FileObject</tt>。DataObject 是由 DataLoader 生成的。有关详细信息，请参见 <a href="http://wiki.netbeans.org/wiki/view/DevFaqDataObject">What is a DataObject?</a>（什么是 DataObject？）。</li>
|
| <li><b>AbcResolver.xml。</b>将 <tt>.abc</tt> 和 <tt>.ABC</tt> 扩展名映射到 MIME 类型。<tt>AbcDataLoader</tt> 仅识别 MIME 类型，而不了解有关文件扩展名的信息。</li>
|
| <li><b>AbcTemplate.abc。</b>为 <tt>layer.xml</tt> 中注册的文件模板提供了基础，以便将其作为新模板安装在“新建文件”对话框中。</li>
|
| <li><b>AbcDataObjectTest.java。</b><tt>DataObject</tt> 的 JUnit 测试类。</li>
|
| </ul>
|
|
|
| <p>在 <tt>layer.xml</tt> 文件中，将会看到以下内容：</p>
|
|
|
| <pre><folder name="Loaders"> |
| <folder name="text"> |
| <folder name="x-abc"> |
| <folder name="Actions"> |
| <file name="org-myorg-abcfiletype-MyAction.shadow"> |
| <attr name="originalFile" stringvalue="Actions/Edit/org-myorg-abcfiletype-MyAction.instance"/> |
| <attr name="position" intvalue="600"/> |
| </file> |
| <file name="org-openide-actions-CopyAction.instance"> |
| <attr name="position" intvalue="100"/> |
| </file> |
| <file name="org-openide-actions-CutAction.instance"> |
| <attr name="position" intvalue="200"/> |
| </file> |
| <file name="org-openide-actions-DeleteAction.instance"> |
| <attr name="position" intvalue="300"/> |
| </file> |
| <file name="org-openide-actions-FileSystemAction.instance"> |
| <attr name="position" intvalue="400"/> |
| </file> |
| <file name="org-openide-actions-OpenAction.instance"> |
| <attr name="position" intvalue="500"/> |
| </file> |
| <file name="org-openide-actions-PropertiesAction.instance"> |
| <attr name="position" intvalue="700"/> |
| </file> |
| <file name="org-openide-actions-RenameAction.instance"> |
| <attr name="position" intvalue="800"/> |
| </file> |
| <file name="org-openide-actions-SaveAsTemplateAction.instance"> |
| <attr name="position" intvalue="900"/> |
| </file> |
| <file name="org-openide-actions-ToolsAction.instance"> |
| <attr name="position" intvalue="1000"/> |
| </file> |
| <file name="sep-1.instance"> |
| <attr name="instanceClass" stringvalue="javax.swing.JSeparator"/> |
| <attr name="position" intvalue="1100"/> |
| </file> |
| <file name="sep-2.instance"> |
| <attr name="instanceClass" stringvalue="javax.swing.JSeparator"/> |
| <attr name="position" intvalue="1200"/> |
| </file> |
| <file name="sep-3.instance"> |
| <attr name="instanceClass" stringvalue="javax.swing.JSeparator"/> |
| <attr name="position" intvalue="1300"/> |
| </file> |
| <file name="sep-4.instance"> |
| <attr name="instanceClass" stringvalue="javax.swing.JSeparator"/> |
| <attr name="position" intvalue="1400"/> |
| </file> |
| </folder> |
| <folder name="Factories"> |
| <file name="AbcDataLoader.instance"> |
| <attr name="SystemFileSystem.icon" urlvalue="nbresloc:/org/myorg/abcfiletype/Datasource.gif"/> |
| <attr name="dataObjectClass" stringvalue="org.myorg.abcfiletype.AbcDataObject"/> |
| <attr name="instanceCreate" methodvalue="org.openide.loaders.DataLoaderPool.factory"/> |
| <attr name="mimeType" stringvalue="text/x-abc"/> |
| </file> |
| </folder> |
| </folder> |
| </folder> |
| </folder></pre>
|
|
|
|
|
|
|
| <!-- ======================================================================================= -->
|
|
|
| <h2><a name="install"></a>安装和试用功能</h2>
|
| <p>现在，让我们安装该模块，然后使用此前创建的基本功能。IDE 使用 Ant 生成脚本来生成和安装模块。此生成脚本是在创建项目时创建的。</p>
|
| <div class="indent">
|
|
|
|
|
| <ol>
|
| <li>在“项目”窗口中，右键单击 "Abc File Type"<tt></tt> 项目，然后选择“运行”。
|
| <p>将启动一个新的 IDE 实例，同时该实例将向其自身安装您的模块。</p></li>
|
| <li>使用“新建项目”对话框 (Ctrl-Shift-N) 在 IDE 中创建任意类型的应用程序。</li>
|
| <li>右键单击该应用程序节点，然后选择“新建”>“其他”。在“其他”类别中，有一个用于创建新文件类型的模板：
|
| <p><img src="../images/tutorials/filetype/60-action4.png" alt="虚拟模板。" /></p>
|
| <p>完成向导后，您便创建了一个可用于帮助用户创建给定文件类型的模板。</p>
|
| <p class="tips">如果要通过该模板提供缺省代码，请将这些代码添加到“新建文件类型”向导所创建的 <tt>AbcTemplate.abc</tt> 文件中。</p></li>
|
| </ol>
|
| </div>
|
|
|
| <!-- ===================================================================================== -->
|
| <h2><a name="adding"></a>为 Abc 文件创建功能</h2>
|
| <p>现在 NetBeans 平台能够将 Abc 文件与所有其他类型的文件区分开，接下来应添加特定于该文件类型的功能。在此部分，我们将在从资源管理器窗口（例如，“项目”窗口）右键单击该文件节点所显示的上下文菜单中添加一个菜单项，并使该文件能够在一个窗口中打开，而不是在编辑器中打开。</p>
|
|
|
| <div class="indent">
|
|
|
| <h3 class="tutorial"><a name="action"></a>添加操作</h3>
|
|
|
| <p>在本小节中，我们将使用“新建操作”向导创建一个 Java 类，用于为我们的文件类型执行操作。此向导还将在 <tt>layer.xml</tt> 文件中注册该类，以使用户能够在从资源管理器窗口右键单击该文件类型节点所显示的上下文菜单中调用此操作。</p>
|
|
|
| <ol>
|
|
|
| <li>右键单击项目节点，然后选择“新建”>“操作”。</li>
|
| <li>在“操作类型”面板中，单击“有条件地启用”。键入 <tt>AbcDataObject</tt>，这是之前由“新建文件类型”向导生成的数据对象的名称，如下所示：
|
|
|
| <p><img src="../images/tutorials/filetype/60-action1.png" alt="“新建操作”向导的第 1 步。" /></p>
|
|
|
|
|
|
|
| <p>单击“下一步”。</p></li>
|
|
|
| <li>在“GUI 注册”面板中，从“类别”下拉列表中选择“编辑”类别。“类别”下拉列表用于控制操作在 IDE 的快捷键编辑器中的显示位置。
|
| <p>接下来，取消选中“全局菜单项”，然后选中“文件类型上下文菜单项”。在“内容类型”下拉列表中，选择您之前在“新建文件类型”向导中指定的 MIME 类型，如下所示：</p>
|
|
|
| <p><img src="../images/tutorials/filetype/60-action2.png" alt="“新建操作”向导的第 2 步。" /></p>
|
|
|
| <p>请注意，您可以设置菜单项的位置，并将此菜单项与其前面和后面的菜单项隔开。单击“下一步”。</p></li>
|
|
|
| <li>在“名称和位置”面板的“类名”中键入 <tt>MyAction</tt>，在“显示名称”中键入 <tt>My Action</tt>。上下文菜单提供的菜单项不显示图标。因此，请单击“完成”，此时 <tt>MyAction.java</tt> 将被添加到 <tt>org.myorg.abcfiletype</tt> 包中。</li>
|
|
|
| <li>在源代码编辑器中，将下面的代码添加到此操作的 <tt>actionPerformed</tt> 方法中：
|
|
|
| <pre class="examplecode">@Override
|
| public void actionPerformed(ActionEvent ev) {
|
| FileObject f = context.getPrimaryFile();
|
| String displayName = FileUtil.getFileDisplayName(f);
|
| String msg = "I am " + displayName + ". Hear me roar!"; |
| NotifyDescriptor nd = new NotifyDescriptor.Message(msg); |
| DialogDisplayer.getDefault().notify(nd); |
| }</pre>
|
| <p>按 Ctrl-Shift-I 组合键。IDE 会自动将 import 语句添加到该类的顶部。</p>
|
|
|
| <p class="tips">某些代码仍带有红色下划线，这表示类路径中并未包括所有需要的包。右键单击项目节点，选择“属性”，然后单击“项目属性”对话框中的“库”。单击“库”窗格顶部的“添加”来添加“对话框 API”。</p>
|
|
|
| <p>在 <tt>MyAction.java</tt> 类中再次按 Ctrl-Shift-I 组合键。红色下划线将会消失，因为 IDE 在对话框 API 中找到了所需的包。</p></li>
|
|
|
| <li>在“重要文件”节点中，展开“XML 层”。"<此层>"<tt></tt> 和 "<上下文中的此层>"<tt></tt> 这两个节点以及它们的子节点共同组成了<a href="https://platform.netbeans.org/tutorials/nbm-glossary.html">系统 Filesystem</a> 浏览器。展开 "<此层>"<tt></tt>，再展开 "Loaders"<tt></tt>，继续展开节点，直到显示您之前所创建的操作<tt></tt>。</li>
|
|
|
| <li>将 <tt>My Action</tt> 拖放到“打开”<tt></tt>操作下方，如下所示：
|
| <p><img src="../images/tutorials/filetype/60-action3.png" alt="系统 Filesystem 浏览器。" /></p>
|
|
|
| <p>从最后两步可以看出，系统 Filesystem 浏览器可用于快速重组在系统 Filesystem 中注册的各项的顺序。</p></li>
|
|
|
| <li>再次运行该模块，操作方法与上一节相同。</li>
|
| <li>使用上一节中所示的模板创建一个 ABC 文件，然后在某个资源管理器视图（如“项目”窗口或“收藏夹”窗口）中右键单击该文件的节点。
|
| <p>请注意，Abc 文件具有您在其模块中所指定的图标，并且可以从右键单击操作所显示的上下文菜单中使用在其 <tt>layer.xml</tt> 文件中定义的一系列操作：</p>
|
| <p><img src="../images/tutorials/filetype/60-dummytemplate.png" alt="最终的“项目”窗口。" /></p></li>
|
| <li>选择新菜单项，将显示 Abc 文件的名称和位置：
|
| <p><img style="border: 1px solid #0e1b55" src="../images/tutorials/filetype/60-information.png" alt="信息。" /></p></li>
|
|
|
|
|
| </ol>
|
|
|
| <p>现在，您已了解如何创建在“项目”窗口、“文件”窗口或“收藏夹”窗口内给定类型文件的上下文菜单中显示的新操作。</p>
|
|
|
| <h3 class="tutorial"><a name="topcomponent"></a>在窗口中打开文件</h3>
|
| <p>缺省情况下，当用户打开在本教程中定义的类型的文件时，该文件将在基本编辑器中打开。但是，有时您可能需要创建文件的可视表示，以使用户能够将小部件拖放到该可视表示上。创建此类用户界面的第一步是，使用户可以在窗口中打开文件。本小节将向您演示如何执行此操作。</p>
|
| <ol>
|
| <li>右键单击项目节点，然后选择“新建”>“窗口组件”。将“窗口位置”设置为 "editor" 并选中“在应用程序启动时打开”，如下所示：
|
|
|
| <p><img src="../images/tutorials/filetype/65-topc-1.png" alt="“新建操作”向导的第 1 步。" /></p></li>
|
| <li>单击“下一步”，然后在“类名前缀”中键入 "Abc"：
|
| <p><img src="../images/tutorials/filetype/65-topc-2.png" alt="“新建操作”向导的第 1 步。" /></p>
|
| <p>单击“完成”。</p>
|
| </li>
|
| <li>按如下所示更改 <tt>DataObject</tt> 的构造函数，将 <tt>DataObject</tt> 更改为使用 <tt><a href="http://bits.netbeans.org/dev/javadoc/org-openide-loaders/org/openide/loaders/OpenSupport.html">OpenSupport</a></tt> 而不是 DataEditorSupport：
|
|
|
| <pre>public AbcDataObject(FileObject pf, MultiFileLoader loader) |
| throws DataObjectExistsException, IOException { |
| |
| super(pf, loader); |
| CookieSet cookies = getCookieSet(); |
| <b>//cookies.add((Node.Cookie) DataEditorSupport.create(this, getPrimaryEntry(), cookies)); |
| cookies.add((Node.Cookie) new AbcOpenSupport(getPrimaryEntry()));</b> |
| |
| }</pre>
|
| </li>
|
|
|
| <li>创建 <tt><a href="http://bits.netbeans.org/dev/javadoc/org-openide-loaders/org/openide/loaders/OpenSupport.html">OpenSupport</a></tt> 类：
|
|
|
| <pre>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; |
| } |
| |
| }</pre>
|
|
|
| <p class="tips">调整 TopComponent 以扩展 CloneableTopComponent，而不是 TopComponent。将 TopComponent 的类修饰符及其构造函数的修饰符设置为 public 而不是 private。</p></li>
|
| </ol>
|
| <p>再次运行该模块，当打开 Abc 文件时，<tt>OpenSupport</tt> 类便会处理此打开操作，以便在 <tt>TopComponent</tt> 中打开该文件，而不是在 <tt>DataEditorSupport</tt> 所提供的基本编辑器中打开：</p>
|
|
|
| <p><img style="border: 1px solid #0e1b55" src="../images/tutorials/filetype/65-topc-3.png" alt="“新建操作”向导的第 1 步。" /></p>
|
|
|
| <p class="tips"><a href="https://platform.netbeans.org/tutorials/nbm-visual_library.html">NetBeans 可视库教程</a>提供了一个进一步开发 TopComponent 的示例，以便以可视方式显示文件内容（与本教程中定义的文件类型对应）。</p>
|
|
|
| <br />
|
|
|
| <!-- ======================================================================================= -->
|
|
|
| <h3><a name="multiview"></a>创建多视图窗口</h3>
|
|
|
| <p>现在，我们已经能够在窗口中打开文件，接下来我们将使该窗口更加有趣。我们将创建一个多视图窗口。多视图窗口的第一个标签通常用于显示文件的可视表示，第二个标签则通常显示源视图。此外，该窗口也可包含两个以上的标签，每个标签提供有关已打开文件的更为详细的信息。</p>
|
|
|
| <ol>
|
| <li>右键单击项目节点，然后选择“属性”。在“项目属性”对话框中，选择“库”，然后单击“添加”。设置对“<a href="http://bits.netbeans.org/dev/javadoc/org-netbeans-core-multiview/overview-summary.html">多视图窗口</a>”的依赖关系。单击“确定”，然后再次单击“确定”以退出“项目属性”对话框。</li>
|
| <li>对于要在多视图窗口中创建的每个标签，创建一个用于实现 <tt><a href="http://bits.netbeans.org/dev/javadoc/org-netbeans-core-multiview/org/netbeans/core/spi/multiview/MultiViewDescription.html">MultiViewDescription</a></tt> 和 <tt>Serializable</tt> 的类。<p>就本教程而言，首先将创建一个名为 <tt>AbcMultiviewDescription1</tt> 的类以实现指定类：</p>
|
| <pre>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.");
|
| }
|
|
|
| }</pre>
|
|
|
| <p class="tips">在上述 <tt>AbcMultiviewDescription1</tt> 类中，方法 <tt>createElement()</tt> 返回 MultiViewElement。但是，此处需要返回的是 <tt>TopComponent</tt>，这将在下一步中完成。</p></li>
|
|
|
| <li>重写类签名。要为上一步中的描述提供一个多视图元素，我们需要实现 <tt><a href="http://bits.netbeans.org/dev/javadoc/org-netbeans-core-multiview/org/netbeans/core/spi/multiview/MultiViewElement.html">MultiViewElement</a></tt>：
|
|
|
| <pre>public final class AbcTopComponent extends TopComponent implements MultiViewElement {</pre>
|
|
|
| <p>现在，您需要在 <tt>TopComponent</tt> 中删除（或注释掉）方法 <tt>findInstance()</tt>、<tt>getPersistenceType()</tt>、<tt>writeReplace()</tt> 和 <tt>preferredID()</tt>。</p></li>
|
|
|
| <li>暂时为每个所需的方法提供非常简单的实现。首先，在 <tt>TopComponent</tt> 类的顶部定义一个新的 <tt>JToolbar</tt>：
|
|
|
| <pre>private JToolBar toolbar = new JToolBar();</pre>
|
|
|
| <p>接下来，按如下所示实现方法：</p>
|
|
|
| <pre> 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;
|
| }</pre></li>
|
|
|
| <li>现在，您可以重新定义 <tt>AbcMultiviewDescription1</tt>，如下所示：
|
|
|
| <pre>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();
|
| }
|
|
|
| }</pre></li>
|
|
|
| <li>更改 <tt>OpenSupport</tt> 类中的 <tt>createCloneableTopComponent</tt> 方法，以通过在上面部分创建的 <tt>MultiViewDescription</tt> 类打开 <tt>TopComponent</tt>：
|
|
|
| <pre>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;
|
|
|
| }</pre>
|
|
|
|
|
| <p class="tips"><tt>MultiViewFactory.createCloneableMultiView</tt> 中的第二个参数决定缺省情况下所打开的标签。在本示例中为 <tt>AbcMultiViewDescription1</tt> 定义的标签 <tt>firstTab</tt>。</p></li>
|
|
|
| <li>再次安装并打开文件。现在，您已创建包含一个标签的多视图窗口：
|
|
|
| <p><img style="border: 1px solid #0e1b55" src="../images/tutorials/filetype/65-mvdeployed.png" alt="已部署的多视图" /></p></li>
|
|
|
| </ol>
|
|
|
| <p>现在，多视图窗口中只有一个标签。对于其他每个标签，创建一个新的 <tt>MultiviewDescription</tt> 类和一个新的 <tt>TopComponent</tt>，然后实例化 <tt>OpenSupport</tt> 扩展类中的 <tt>MultiViewDescription</tt> 类，如上所示。</p>
|
|
|
| </div>
|
|
|
|
|
| <!-- ======================================================================================= -->
|
|
|
| <h2><a name="share"></a>创建可共享的模块二进制文件</h2>
|
|
|
| <p>该模块现已完成，您可以将其交给其他用户使用了。为此，您需要创建并分发一个二进制 "NBM"（NetBeans 模块）文件。</p>
|
|
|
| <div class="indent">
|
|
|
| <ol>
|
| <li>在“项目”窗口中，右键单击 "Abc File Type"<tt></tt> 项目，然后选择“创建 NBM”。
|
|
|
| <p>将创建 NBM 文件，您可以在“文件”窗口 (Ctrl-2) 中查看它：</p>
|
| <p><img style="border: 1px solid #0e1b55" src="../images/tutorials/filetype/60-shareable-nbm.png" alt="可共享的 NBM。" /></p></li>
|
| <li>例如，通过 <a href="http://plugins.netbeans.org/PluginPortal/">NetBeans 插件门户</a>向其他人提供该文件。接收者应使用插件管理器（“工具”>“插件”）来安装它。</li>
|
| </ol>
|
|
|
| </div>
|
|
|
|
|
| <!-- ======================================================================================== -->
|
|
|
|
|
| <br>
|
| <div class="feedback-box"><a href="https://netbeans.org/about/contact_form.html?to=3&subject=Feedback:%20File%20Type%20Module%20Tutorial">请将您的意见和建议发送给我们</a></div>
|
| <br style="clear:both;" />
|
|
|
|
|
| <!-- ======================================================================================== -->
|
|
|
| <h2><a name="nextsteps"></a>后续步骤</h2>
|
|
|
| <p>有关创建和开发 NetBeans 模块的详细信息，请参见以下资源：
|
| <ul>
|
| <li><a href="https://platform.netbeans.org/index.html">NetBeans 平台主页</a></li>
|
| <li><a href="https://netbeans.org/download/dev/javadoc/">NetBeans API 列表（当前开发版本）</a></li>
|
| <li><a href="https://netbeans.org/kb/trails/platform_zh_CN.html">其他相关教程</a></li></ul>
|
| </p>
|
|
|
| <!-- ======================================================================================== -->
|
| <!--
|
| <h2><a name="version"></a>Versioning </h2>
|
|
|
| <p>
|
|
|
| <table width="76%" >
|
| <tbody>
|
| <tr>
|
| <td>
|
| <div align="left"><b>Version</b></div>
|
| </td>
|
| <td>
|
| <div align="left"><b>Date</b></div>
|
| </td>
|
| <td>
|
| <div align="left"><b>Changes</b></div>
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 1
|
| </td>
|
| <td>
|
| 25 August 2005
|
| </td>
|
| <td>
|
| <ul><li>Initial version.
|
| <li>To do:
|
| <ul><li>Add post-creation customizations (i.e., the "Extending Support for the New File Type" section).
|
| <li>Explain what the generated files are for (placeholders currently).
|
| <li>Explain the layer file's entries.
|
| <li>Explain the first File Type panel (placeholders currently).
|
| <li>Maybe create a separate tutorial for recognizing XML files.</ul></ul>
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 2
|
| </td>
|
| <td>
|
| 23 September 2005
|
| </td>
|
| <td>
|
| <ul><li>A lot of info added from the FAQ and added the Action wizard and System Filesystem Browser.
|
| <li>To do:
|
| <ul><li>Explain <tt>LoaderBeanInfo.java</tt> and <tt>Resolver.xml</tt> (one line each)
|
| <li>Maybe create a separate tutorial for recognizing XML files.
|
| <li>Using Tomcat GIF maybe not good idea.
|
| <li>Maybe the action should do something useful.
|
| <li>Maybe direct links to FAQ not good idea.
|
| <li>Probably more needed on <tt>layer.xml</tt> file.
|
| <li>Maybe other useful apisupport functionality could be added to this scenario.
|
| <li>More info needed on MIME types.
|
| <li>The introductory paragraphs should be illustrated with a graphic. A diagram to
|
| show relationship between node, dataobject, fileobject, dataloader, etc.</ul></ul>
|
| </td>
|
| </tr>
|
|
|
| <tr>
|
| <td>
|
| 3
|
| </td>
|
| <td>
|
| 28 September 2005
|
| </td>
|
| <td>
|
| <ul><li>Integrated comments from Jesse Glick.
|
| <li>To do:
|
| <ul> <li>More info needed on MIME types.
|
| <li>The introductory paragraphs should be illustrated with a graphic. A diagram to
|
| show relationship between node, dataobject, fileobject, dataloader, etc.
|
| <li>Many Javadoc links to be added (also for <tt>performAction</tt>.
|
| <li>Info on cookies, cookie actions, cookie classes needed.
|
| <li>Action ended up in text-html even though I chose my own mime type.
|
| <li>Need to explain or link to explanation for instance, shadow, etc.
|
| <li>Platform Manager needs to be mentioned in the context of installing
|
| in target platform.
|
| <li>Show how to add properties to the property sheet.</ul></ul>
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 4
|
| </td>
|
| <td>
|
| 4 October 2005
|
| </td>
|
| <td>
|
| <ul><li>Added two diagrams in the introductory paragraphs, from Tim Boudreau's JavaOne presentation.
|
| <li>To do:
|
| <ul> <li>More info needed on MIME types.
|
| <li>Many Javadoc links to be added (also for <tt>performAction</tt>).
|
| <li>Need to create section near the start: "Related FAQs":
|
| <ul><li>Info on cookies, cookie actions, cookie classes needed.
|
| <li>Need to explain or link to explanation for instance, shadow, etc.
|
| <li>DataLoader, DataObject, etc.</ul>
|
| <li>Platform Manager needs to be mentioned in the context of installing
|
| in target platform.
|
| <li>Show how to add properties to the property sheet.
|
| <li>Mention the dummy template that you get, how to modify it,
|
| and how to set the description in the New File wizard.</ul></ul>
|
|
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 4
|
| </td>
|
| <td>
|
| 4 November 2005
|
| </td>
|
| <td>
|
| <ul><li>Added downloadable source code, new 'Installing the Sample' section, and link to
|
| Syntax Highlighting tutorial at the end.
|
| <li>To do:
|
| <ul> <li>Same items as on 4 October still to be done.</ul>
|
|
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 5
|
| </td>
|
| <td>
|
| 29 November 2005
|
| </td>
|
| <td>
|
| <ul><li>Added links to brand new Component Palette tutorial.
|
| <li>To do:
|
| <ul> <li>Same items as on 4 October still to be done.</ul>
|
|
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 6
|
| </td>
|
| <td>
|
| 21 April 2006
|
| </td>
|
| <td>
|
| <ul><li>Changed the title from "DataLoader Module Tutorial" to "Recognizing a File Type Tutorial".
|
| <li>To do:
|
| <ul> <li>Same items as on 4 October still to be done.</ul>
|
|
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 7
|
| </td>
|
| <td>
|
| 17 November 2007
|
| </td>
|
| <td>
|
| <ul><li>Updated the whole tutorial to 6.0, replaced all screenshots, and
|
| now [because the 6.0 IDE already provides support for manifest files], the
|
| tutorial focuses on imaginary Abc files.
|
| <li>To do:
|
| <ul> <li>Need to replace the download, which is the same as before, dealing with manifest files.
|
| <li>Same items as on 4 October still to be done.
|
| <li>Added OpenSupport into TopComponent, with a reference to Visual Library.</ul>
|
| <li>Changed title to File Type Integration Tutorial
|
| <li>Tweaked several places throughout tutorial, for 6.0
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 8
|
| </td>
|
| <td>
|
| 15 April 2008
|
| </td>
|
| <td>
|
| Updated the styles (badge, table of contents, required software table)
|
| to the new format.
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 9
|
| </td>
|
| <td>
|
| 16 July 2008
|
| </td>
|
| <td>
|
| Created new version for 6.5, because of changes to the
|
| way file type recognition is done in that release. To do:
|
| <ul>
|
| <li>6.5-specific badge
|
| <li>Required software table
|
| <li>Search for DataNode, BeanInfo, DataLoader and reword
|
| <li>Check screenshots
|
| <li>Make sure all the sections work as before
|
| </ul>
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 10
|
| </td>
|
| <td>
|
| 4 April 2009
|
| </td>
|
| <td>
|
| Worked through everything and added the multiview section.
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 11
|
| </td>
|
| <td>
|
| 9 Feb 2010
|
| </td>
|
| <td>
|
| Changed JPanel to TopComponent in multiview section.
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 12
|
| </td>
|
| <td>
|
| 10 Feb 2010
|
| </td>
|
| <td>
|
| Added links to javadoc for the MultiView classes.
|
| </td>
|
| </tr>
|
| <tr>
|
| <td>
|
| 13
|
| </td>
|
| <td>
|
| 18 Feb 2010
|
| </td>
|
| <td>
|
| Added style for borders and fixed action instructions.
|
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| -->
|
| </body>
|
| </html>
|
