当前页面: 开发资料首页 → Netbeans 专题 → NetBeans File Template 模块教程

NetBeans File Template 模块教程

摘要: NetBeans File Template 模块教程 反馈 本教程演示如何创建包含文件模板的模块。将该模块安装到 IDE 中之后，在 New File 向导中便可以使用该文件模板。拥有包含文件模板的...

反馈

本教程演示如何创建包含文件模板的模块。将该模块安装到 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 文件中注册该模板。

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

注册文件模板

创建文件模板之后，您必须在 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 Files
   Templates/BrandFiles/BrandedJavaClass.java=Branded Java Class

   下面解释以上字符串：

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