NetBeans File Template 模块教程

本教程演示如何创建包含文件模板的模块。将该模块安装到 IDE 中之后，在 New File 向导中便可以使用该文件模板。拥有包含文件模板的模块之后，共享文件模板便很容易，NetBeans IDE 5.0 允许您创建一个其他人可以使用的二进制文件，然后其他人通过 Update Center 安装它。

文件模板由模板文件、HTML 描述文件和图标组成。HTML 描述文件显示 New File 向导中有关该模板的信息。图标标识该模板并使其与 New File 向导中的其他模板区分开来。在本教程中，通过将现有文件模板的内容复制到空文件中来创建新的文件模板。然后，为 New File 向导设置描述文件和区别图标，在 NetBeans 配置文件即 layer.xml 文件中注册该模板、HTML 描述文件和图标。

注意： 如果您使用 New File Type 向导，则将自动为您创建文件模板。当使用 New File Type 向导时，本教程中介绍的手动步骤是不必要的。New File Type 向导还允许您选择图标，它还创建一个 HTML 描述文件。New File Type 向导自动在 layer.xml 文件中注册文件模板、HTML 描述文件和图标。因此，如果您要创建的文件模板与新的文件类型有关，则最好使用 New File Type 向导。有关详细信息，请参阅 NetBeans DataLoader 模块教程。

本教程将介绍以下主题：

• 安装软件
• 创建模块项目
• 创建文件模板
  • 创建模板文件
  • 创建描述文件
  • 获得图标
• 注册文件模板
• 构建和安装模块

安装完软件之后，本教程可以在 20 分钟之内完成。

有关使用 NetBeans 模块的详细信息，请参阅 NetBeans 网站上的 NetBeans Development Project 主页。如果有问题，请访问 NetBeans Developer FAQ 或使用本页顶部的反馈链接。

安装软件

开始之前，需要在您的计算机上安装以下软件：

• NetBeans IDE 5.0（下载）
• Java Standard Development Kit (JDK™) version 1.4.2（下载）或 5.0（下载）

创建模块项目

 

1. 选择 File > New Project (Ctrl-Shift-N)。在 Categories 下，选择 NetBeans Plug-in Modules。在 Projects 下，选择 Module Project 并单击 Next。

    

2. 在 Name and Location 面板中，在 Project Name 中键入 AdditionalFileTemplates。将 Project Location 更改为您计算机上的任何目录，如 c:/mymodules。选择 Standalone Module 单选按钮和 Set as Main Project 复选框。单击 Next。

    

3. 在 Basic Module Configuration 面板中，用 myorg 替换 Code Name Base 中的 yourorghere，从而整个 code name base 为 org.myorg.additionalfiletemplates。向默认的 Module Display Name 中添加空格，将它更改为 Additional File Templates。留下本地化包和 XML 层的位置，以便它们存储在名为 org/myorg/additionalfiletemplates 的包中。单击 Finish。

IDE 创建 Additional File Templates 项目。该项目包含所有资源和项目元数据，如该项目的 Ant 构建脚本。该项目在 IDE 中打开。您可以在 Projects 窗口 (Ctrl-1) 中查看其逻辑结构，在 Files 窗口 (Ctrl-2) 中查看其文件结构。例如，现在 Projects 窗口应该如下所示：

有关以上每个文件的基本信息，请参阅 NetBeans 插件模块的快速入门指南。

创建文件模板

文件模板由模板文件、HTML 描述文件和图标组成。创建新文件模板的简便方法是将现有文件模板的内容复制到空文件中。然后，为 New File 向导设置描述文件和区分图标之后，您准备在 layer.xml 文件中注册该模板。

创建模板文件

 

1. 转到 Tools > Template Manager。展开 Java Classes，如下所示：

   

    

2. 选择 Java Class 模板并单击 Open in Editor。

   Java Class 模板将在 Source Editor 中打开：

   /* * __NAME__.java * * Created on __DATE__, __TIME__ * * To change this template, choose Tools | Options and locate the template under * the Source Creation and Management node. Right-click the template and choose * Open. You can then make changes to the template in the Source Editor. */package Templates.Classes;/** * * @author __USER__ */public class Class {    /** Creates a new instance of __NAME__ */    public Class() {    }}

   注意到 Java Class 模板包含使用 New File 向导创建文件时填写的占位符。占位符如下所示：

   • __NAME__。替换为在 New File 向导中输入的文件名称。
   • Class。替换为在 New File 向导中输入的类名称。
   • __USER__。替换为当前用户。
   • __DATE__。替换为当前日期。
   • __TIME__。替换为当前时间。

    

3. 右键单击 Additional File Templates 节点并选择 New > File/Folder。在 New File 向导中，在 Categories 下选择 Other，在 File Types 下选择 Empty File。单击 Next。

    

4. 在 File Name 中键入 BrandedJavaClass.template。单击 Browse 并浏览到 src/org/myorg/additionalfiletemplates。单击 Select Folder。单击 Finish。

   一个名为 BrandedJavaClass.template 的空文件在 Source Editor 中打开，它的节点显示在 Projects 窗口中。

    

5. 将 Java Class 模板的内容复制到 BrandedJavaClass.template 文件中。

    

6. 向 BrandedJavaClass.template 文件的顶部添加标记信息。例如，向该文件的顶部添加 Sun Microsystems 版权信息。

   /* * Copyright (c) 2005 Sun Microsystems, Inc.  All rights reserved.  U.S. * Government Rights - Commercial software.  Government users are subject * to the Sun Microsystems, Inc. standard license agreement and * applicable provisions of the FAR and its supplements.  Use is subject * to license terms. * * This distribution may include materials developed by third parties. * Sun, Sun Microsystems, the Sun logo, Java and J2EE are trademarks * or registered trademarks of Sun Microsystems, Inc. in the U.S. and * other countries. * * Copyright (c) 2005 Sun Microsystems, Inc. Tous droits reserves. * * Droits du gouvernement americain, utilisateurs gouvernementaux - logiciel * commercial. Les utilisateurs gouvernementaux sont soumis au contrat de * licence standard de Sun Microsystems, Inc., ainsi qu'aux dispositions * en vigueur de la FAR (Federal Acquisition Regulations) et des * supplements a celles-ci.  Distribue par des licences qui en * restreignent l'utilisation. * * Cette distribution peut comprendre des composants developpes par des * tierces parties. Sun, Sun Microsystems, le logo Sun, Java et J2EE * sont des marques de fabrique ou des marques deposees de Sun * Microsystems, Inc. aux Etats-Unis et dans d'autres pays. */

    

7. 按 Ctrl-S 保存文件。

创建描述文件

 

1. 右键单击 org.myorg.additionalfiletemplates 节点，然后选择 New > File/Folder。在 Categories 下，选择 Other。在 File Types 下，选择 HTML File。单击 Next。在 File Name 中键入 Desc_BrandedJavaClass。单击 Browse 并浏览到 src/org/myorg/additionalfiletemplates。单击 Select Folder。单击 Finish。

   一个空的 HTML 文件在 Source Editor 中打开，它的节点显示在 Projects 窗口中。

    

2. 在 <body> 标记之间键入“Creates Java Class branded with <b>Sun Microsystems</b> copyright text.”（无引号），以便文件外观如下所示：

   <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html>    <head>        <title></title>    </head>    <body>Creates Java Class branded with <b>Sun Microsystems</b> copyright text.    </body></html>

    

3. 按 Ctrl-S 保存文件。

获取图标

图标伴随 New File 向导中的文件模板。它标识自己并使自己区别于其他文件模板。图标的尺寸必须为 16x16 像素。如果您没有自己的图标，则可以在 NetBeans IDE 5.0 安装目录中的以下位置找到一些 16x16 的图标：

enterprise2/jakarta-tomcat-5.5.7/server/webapps/admin/images

将该图标命名为 Icon_BrandedJavaClass 并将其添加到 org.myorg.additionalfiletemplates 包中。

现在 Projects 窗口应该显示如下：

注册文件模板

创建文件模板之后，您必须在 NetBeans System Filesystem 中注册它。layer.xml 文件就是用于这个目的。

1. 在 layer.xml 文件中的 <filesystem> 标签之间添加以下条目：

    

   <folder name="Templates">   <attr name="Classes/BrandFiles" boolvalue="true" />   <attr name="BrandFiles/GUIForms" boolvalue="true" />   <folder name="BrandFiles">   <attr name="SystemFileSystem.localizingBundle" stringvalue="org.myorg.additionalfiletemplates.Bundle"/>       <file name="BrandedJavaClass.java" url="BrandedJavaClass.template">          <attr name="template" boolvalue="true"/>          <attr name="SystemFileSystem.localizingBundle" stringvalue="org.myorg.additionalfiletemplates.Bundle"/>          <attr name="SystemFileSystem.icon" urlvalue="nbresloc:/org/myorg/additionalfiletemplates/Icon_BrandedJavaClass.gif"/>          <attr name="instantiatingIterator" methodvalue="org.netbeans.modules.java.ui.wizard.JavaWizardIterator.singleton" />          <attr name="instantiatingWizardURL" urlvalue="nbresloc:/org/myorg/additionalfiletemplates/Desc_BrandedJavaClass.html"/>       </file>  </folder></folder>

   下面解释以上标记：

   • attr name="Classes/BrandFiles"。将 BrandFiles 类别放置在 Classes 类别下。
   • attr name="BrandFiles/GUIForms"。将 BrandFiles 类别放置在 GUIForms 类别上。
   • folder name="BrandFiles"。New File 向导中 Category 的普通名称，已在 Bundle.properties 中本地化。
   • attr name="SystemFileSystem.localizingBundle"。本地化包的名称和位置。

      

   • file name="BrandedJavaClass.java"。New File 向导中 File Type 的普通名称，已在 Bundle.properties 中本地化。
   • url="BrandedJavaClass.template"。源结构中模板的位置和名称。
   • 文件属性：
     • template。指定这是一个模板。
     • SystemFileSystem.localizingBundle。本地化包的名称和位置。
     • SystemFileSystem.icon。图标的名称和位置。
     • instantiatingIterator。（即将到来）
     • instantiatingWizardURL。HTML 描述文件的名称和位置。

    

2. 将显示名称添加到 Bundle.properties 文件：

    

   Templates/BrandFiles=Branded FilesTemplates/BrandFiles/BrandedJavaClass.java=Branded Java Class

   下面解释以上字符串：

   • Templates/BrandFiles。名为“BrandFiles”的文件夹的显示名称。
   • Templates/BrandFiles/BrandedJavaClass.java。名为“BrandedJavaClass.java”的文件的显示名称。

构建和安装模块

IDE 使用 Ant 构建脚本来构建和安装您的模块。构建脚本是创建模块项目时为您创建的。

安装 NetBeans 模块

• 在 Projects 窗口，右键单击 Additional File Templates 项目并在 Target Platform 中选择 Install/Reload。

  模块即在目标 IDE 或平台中构建和安装。目标 IDE 或平台打开，您可以试用新的模块。默认目标 IDE 或平台是由开发 IDE 的当前实例使用的安装平台。注意到当您运行模块时，您将使用临时测试用户目录，而不是开发 IDE 的用户目录。

使用 NetBeans 模块

1. 选择 File > New Project (Ctrl-Shift-N) 创建一个新项目。
2. 右键单击该项目并选择 New > File/Folder。将打开 New File 向导，并显示新类别及其新文件类型。它的外观类似于以下内容，但是您的图标可能不同：

   

3. 选择该新文件类型，单击 Next，并创建一个新文件。单击 Finish 之后，Source Editor 应该显示新创建的模板。

创建可共享的模块二进制文件

1. 在 Projects 窗口中，右键单击 Additional File Templates 项目，并选择 Create NBM。

   将创建 NBM 文件并且可以在 Files 窗口中查看它 (Ctrl-2)：

   

2. 通过电子邮件使其他人也可以使用。

下一步

有关创建和开发 NetBeans 模块的更多信息，请参见以下资源：

 

• 插件开发者资源

   

• NetBeans API 列表（当前开发版本）

   

• 新的 API 支持建议