NetBeans ファイルテンプレートモジュールのチュートリアル
翻訳 :
片貝正紀 , 2006/7/10,
レビュー/保守:
NetBeans 日本語サイト
フィードバック
このチュートリアルではファイルテンプレートを含むモジュールを作成する手順を説明します。IDE にそのモジュールをインストールすれば、新規ファイルウィザードでファイルテンプレートが利用可能になります。ファイルテンプレートの共有はそれらを含むモジュールをインストールすれば簡単です。NetBeans IDE 5.0 では他の人と共有できるバイナリを作成することができます。アップデートセンター経由でインストールできます。
ファイルテンプレートはテンプレートファイル、HTML の説明、アイコンで構成されています。HTML の説明ファイルはテンプレートに関する情報を新規ファイルウィザードで表示します。アイコンはテンプレートを識別するもので、新規ファイルウィザードで他のテンプレートと区別します。このチュートリアルでは、既存のファイルテンプレートを空のファイルにコピーすることで新しいファイルテンプレートを作成します。新規ファイルウィザード用の説明ファイルと識別アイコンを設定すると、テンプレートを登録できます。 HTML 説明ファイル、アイコンを NetBeans 構成ファイル layer.xml ファイルに登録します。
注意: 「新規 ファイルの種類」ウィザードを使うとファイルテンプレートは自動的に作成されます。「新規 ファイルの種類」ウィザードを使った場合にはこのチュートリアルで述べられる手動のステップは必要ありません。「新規 ファイルの種類」ウィザードではアイコンを選択することができ、HTML 説明ファイルを作成することができます。「新規 ファイルの種類」ウィザードは自動的インファイルテンプレート、HTML の説明、アイコンを layer.xml に登録します。したがって新しいファイルの種類に関係したファイルテンプレートを作成したい場合には「新規 ファイルの種類」ウィザードを使ったほうがよいでしょう。詳細は NetBeans DataLoader モジュールチュートリアル を参照してください。
このチュートリアルでは以下のことを説明します:
このチュートリアルはソフトウェアがインストールできれば 20 分程度で完了します。
モジュール開発に関する詳細は NetBeans サイトの NetBeans 開発プロジェクトホーム を参照してください。わからないところがあれば NetBeans 開発者 FAQ を参照してください。またこのページの「フィードバック」リンクを使ってください。
ソフトウェアのインストール
まずはじめにコンピュータにソフトウェアをインストールします:
- NetBeans IDE 5.0 (ダウンロード)
- Java Standard Development Kit (JDK) バージョン 1.4.2 (ダウンロード) または 5.0 (ダウンロード)
モジュールプロジェクトの作成
- 「ファイル」>「新規プロジェクト」(Ctrl-Shift-N) を選択してください。「カテゴリ」で「NetBeans プラグインモジュール」を選択します。「プロジェクト」では「モジュールプロジェクト」を選択し「次へ」ボタンをクリックします。
- 「名前と場所」パネルでは「プロジェクト名」に「AdditionalFileTemplates」と入力します。「プロジェクトの場所」は適当なコンピューター上のディレクトリを指定します。たとえば c:\mymodules などです。「スタンドアロンモジュール」のラジオボタンはそのままにし「主プロジェクトとして設定」チェックボックスを選択します。「次へ」をクリックします。
- 「基本モジュール構成」パネルでは「コード名ベース」で yourorghere を myorg に置き換え、org.myorg.additionalfiletemplates にします。デフォルトの「モジュール表示名」に空白を挿入し Additional File Templates にします。「地域対応のバンドル」と「XML レイヤー」はそのままにし org/myorg/additionalfiletemplates にこれらのファイルが保存されるようにします。「完了」ボタンをクリックします。
IDE は Additional File Templates プロジェクトを作成します。プロジェクトは必要なすべてのソースやメタデータ、たとえばプロジェクトの構築スクリプトなどを含んでいます。プロジェクトは IDE 上で開かれます。「プロジェクト」ウィンドウ(Ctrl-1) で理論的な構成を表示できます。また「ファイル」ウィンドウ(Ctrl-2)ではファイル構造を表示できます。たとえば「プロジェクト」ウィンドウではこのようになります:
これらのファイルの基本的な説明は プラグインモジュールクイックスタートガイド を参照してください。
ファイルテンプレートの作成
ファイルテンプレートはテンプレートファイル、HTML の説明、アイコンで構成されています。新しいファイルテンプレートを作成する簡単な方法は既存のファイルテンプレートを空のファイルにコピーすることです。新規ファイルウィザード用の説明ファイルと識別アイコンを設定すると、テンプレートをlayer.xml ファイルに登録できるようになります。
テンプレートファイルの作成
- 「ツール」、「テンプレートマネージャー」を選択します。「Java クラス」を展開します。次のようになります:
- 「Java クラス」テンプレートを選択し、「エディタで開く」をクリックします。
ソースエディタで「Java クラス」のテンプレートが開かれます:
/*
* __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 クラステンプレートには新規ファイルウィザードでファイルを作成したときに入力される プレースフォルダを含んでいます。プレースフォルダは次のとおりです:
- __NAME__.新規ファイルウィザードで入力されたファイル名に置き換えられます。
- Class.新規ファイルウィザードで入力されたクラス名に置き換えられます。
- __USER__.現在のユーザーに置き換えられます。
- __DATE__.現在の日付に置き換えられます。
- __TIME__.現在のユーザーに置き換えられます。
- Additional File Templates ノードで右クリックして「新規」>「ファイル/フォルダ」を選択します。「新規 ファイルウィザード」で「その他」のカテゴリを選択し、「ファイルの種類」では「空のファイル」を選びます。「次へ」をクリックします。
- 「ファイル名」にBrandedJavaClass.template と入力します。「ブラウズ」をクリックし src/org/myorg/additionalfiletemplates を参照します。「フォルダを選択」をクリックします。「完了」ボタンをクリックします。
空の BrandedJavaClass.template ファイルがソースエディタで開き、プロジェクトウィンドウにノードが表示されます。
- Java クラスのテンプレートの内容を BrandedJavaClass.template ファイルにコピーします。
- 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.
*/
- Ctrl-S を押してファイルを保存します。
説明ファイルの作成
- org.myorg.additionalfiletemplates で右クリックして「新規」>「ファイル/フォルダ」を選択します。「カテゴリ」で「その他」を選択します。「ファイルの種類」で「HTML ファイル」を選択します。「次へ」をクリックします。「ファイル名」にDesc_BrandedJavaClass と入力します。「ブラウズ」をクリックし src/org/myorg/additionalfiletemplates を参照します。「フォルダを選択」をクリックします。「完了」ボタンをクリックします。
空の HTML ファイルがソースエディタで開き、プロジェクトウィンドウにノードが表示されます。
- <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>
- Ctrl-S を押してファイルを保存します。
アイコンの取得
新規ファイルウィザードではアイコンはファイルテンプレートと共に表示されます。テンプレートを識別するもので、新規ファイルウィザードで他のテンプレートと区別します。16x16 ピクセルの寸法のアイコンが必要です。適当なものがない場合には 16x16 のアイコンを NetBeans IDE 5.0 のインストールディレクトリから見つけることができます。
enterprise2\jakarta-tomcat-5.5.9\server\webapps\admin\images
アイコンを Icon_BrandedJavaClass として org.myorg.additionalfiletemplates パッケージに追加します。
これで「プロジェクト」ウィンドウはこのようになります:
ファイルテンプレートの登録
ファイルテンプレートを作成したら NetBeans システムファイルシステムに登録する必要があります。layer.xml ファイルはこの登録用です。
- 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". 新規ファイルウィザードでのカテゴリのプレーンテキストです。Bundle.properties でローカライズされます。
- attr name="SystemFileSystem.localizingBundle". ローカライズバンドルの名前を場所です。
- file name="BrandedJavaClass.java". 新規ファイルウィザードでファイルの種類のプレーンテキストです。Bundle.properties でローカライズされます。
- url="BrandedJavaClass.template". ソース上のテンプレートの場所と名前です。
- ファイル属性:
- template.テンプレートの場合に指定します。
- SystemFileSystem.localizingBundle. ローカライズバンドルの名前を場所です。
- SystemFileSystem.icon.アイコンの名前と場所です。
- instantiatingIterator.
- instantiatingWizardURL. HTML 説明ファイルの名前と場所です。
- Bundle.properties ファイルに表示名を追加します:
Templates/BrandFiles=Branded Files
Templates/BrandFiles/BrandedJavaClass.java=Branded Java Class
上記の文字列の説明は以下のとおりです:
- Templates/BrandFiles. "BrandFiles" フォルダの表示名です。
- Templates/BrandFiles/BrandedJavaClass.java. "BrandedJavaClass.java" ファイルの表示名です。
