NetBeans コンポーネントパレットモジュールのチュートリアル

サンプルのインストール

次の手順でサンプルをインストールします:

1. サン プルファイル を展開 (unzip) します。
2. IDE の「ファイル」>「プロジェクトを開く」を選択し、解凍したファイルがあるフォルダまで移動します。モジュールプロジェクトを開きます。プロジェク トを開くと次のようになります:

   

3. プロジェクトノードを右クリックし「ターゲットプラットフォームでのインストール/再読み込み」を選びます。ターゲットプラットフォームが開 きモジュールがインストールされます。
4. 「ファイル」ウィンドウ(Ctrl-2)から test-jboss-web.xml ファイルをダブルクリップすることでモジュールが正しくインストールされているかどうか確認できます:

   

   ファイルがソースエディタに読み込まれるとコンポーネントパレットが開きます。するとこのチュートリアルの冒頭部分のスクリーンショットの ように３つのコードスニペットが表示されます。コンポーネントパレットが自動的に表示されない場合は Ctrl-Shift-8 を押して手動で開いてください。

5. メニューバーから「ツール」 > 「パレットマネージャー」を選択すると次のようになります:

   

   「パレットマネージャー」が表示されコードスニペットが含まれています:

   

最終的な結果がどのようになるかわかったので、スクラッチからモジュールを作り作成の過程でそれぞれの部分を勉強してみましょう。

モジュールの依存性の指定

NetBeans API に属するいくつかのクラスのサブクラスが必要です。それぞれモジュールの依存関係に定義する必要があります。これは「プロジェクト」プロパティーを使って 設定できます。

1. 「プロジェクト」ウィンドウで jbosswebxml プロジェクトを右クリックし、「プロパティー」を選択します。プロジェクトプロパティーのダイアログボックスで、「ライブラリ」をクリックします。
2. 次のそれぞれの API は「追加...」ボタンをクリックし「モジュールリスト」から名前を選択して「了解」ボタンを押すことで追加できます:

   

3. 「了解」をクリックしてプロジェクトの「プロパティー」ダイアログを閉じます。
4. 「プロジェクト」ウィンドウで「重要なファイル」ノードを展開、「プロジェクトメタデータ」をダブルクリックしてモジュールの依存性が正しく 宣言されているか確認できます。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://www.netbeans.org/ns/project/1">
    <type>org.netbeans.modules.apisupport.project</type>
    <configuration>
        <data xmlns="http://www.netbeans.org/ns/nb-module-project/2">
            <code-name-base>org.netbeans.modules.jbosswebxml</code-name-base>
            <standalone/>
            <module-dependencies>
                <dependency>
                    <code-name-base>org.netbeans.modules.editor.lib</code-name-base>
                    <build-prerequisite/>
                    <compile-dependency/>
                    <run-dependency>
                        <release-version>1</release-version>
                        <specification-version>1.9.0.1</specification-version>
                    </run-dependency>
                </dependency>
                <dependency>
                    <code-name-base>org.netbeans.modules.projectapi</code-name-base>
                    <build-prerequisite/>
                    <compile-dependency/>
                    <run-dependency>
                        <release-version>1</release-version>
                        <specification-version>1.9</specification-version>
                    </run-dependency>
                </dependency>
                <dependency>
                    <code-name-base>org.netbeans.spi.palette</code-name-base>
                    <build-prerequisite/>
                    <compile-dependency/>
                    <run-dependency>
                        <release-version>0</release-version>
                        <specification-version>1.5</specification-version>
                    </run-dependency>
                </dependency>
                <dependency>
                    <code-name-base>org.openide.dialogs</code-name-base>
                    <build-prerequisite/>
                    <compile-dependency/>
                    <run-dependency>
                        <specification-version>6.4</specification-version>
                    </run-dependency>
                </dependency>
                <dependency>
                    <code-name-base>org.openide.filesystems</code-name-base>
                    <build-prerequisite/>
                    <compile-dependency/>
                    <run-dependency>
                        <specification-version>6.4</specification-version>
                    </run-dependency>
                </dependency>
                <dependency>
                    <code-name-base>org.openide.loaders</code-name-base>
                    <build-prerequisite/>
                    <compile-dependency/>
                    <run-dependency>
                        <specification-version>5.9</specification-version>
                    </run-dependency>
                </dependency>
                <dependency>
                    <code-name-base>org.openide.nodes</code-name-base>
                    <build-prerequisite/>
                    <compile-dependency/>
                    <run-dependency>
                        <specification-version>6.7</specification-version>
                    </run-dependency>
                </dependency>
                <dependency>
                    <code-name-base>org.openide.text</code-name-base>
                    <build-prerequisite/>
                    <compile-dependency/>
                    <run-dependency>
                        <specification-version>6.9</specification-version>
                    </run-dependency>
                </dependency>
                <dependency>
                    <code-name-base>org.openide.util</code-name-base>
                    <build-prerequisite/>
                    <compile-dependency/>
                    <run-dependency>
                        <specification-version>6.8</specification-version>
                    </run-dependency>
                </dependency>
                <dependency>
                    <code-name-base>org.openide.windows</code-name-base>
                    <build-prerequisite/>
                    <compile-dependency/>
                    <run-dependency>
                        <specification-version>6.5</specification-version>
                    </run-dependency>
                </dependency>
            </module-dependencies>
            <public-packages/>
        </data>
    </configuration>
</project>

コンポーネントパレットの作成

コンポーネントパレットは NetBeans パレット API を使って定義されています。このチュートリアルで NetBeans パレット API を実装することは次の NetBeans Palette API クラスを実装することです:

これにくわえて次のサポートクラスを作成する必要があります:

NetBeans パレット API を実装するには次のステップにしたがってください:

1. org.netbeans.modules.jbosswebxml プロジェクトノードで右クリックして「新規」>「Java クラス」を選択します。次のファイルの最初のファイルを作り、パッケージのドロップダウンリストには org.netbeans.modules.jbosswebxml.palette と入力し、「完了」ボタンを押します。他のファイルも同様に作成ます。
   • jbossddPaletteActions
   • jbossddPaletteCustomizerAction
   • jbossddPaletteDropDefault
   • jbossddPaletteFactory
   • jbossddPaletteUtilities

   次のファイルが作成されます。(スクリーンショットで選択されています):

   

2. 以下のリンクをダブルクリックし以下の内容でファイルの内容を置き換えます:
   • jbossddPaletteActions
   • jbossddPaletteCustomizerAction
   • jbossddPaletteDropDefault
   • jbossddPaletteFactory
   • jbossddPaletteUtilities
3. jbossddPaletteFactory.java ファイルのデフォルトの内容を次で置き換えます:

   package org.netbeans.modules.jbosswebxml.palette;
   
   import java.io.IOException;
   import org.netbeans.spi.palette.PaletteController;
   import org.netbeans.spi.palette.PaletteFactory;
   
   public class jbossddPaletteFactory {
       
       public static final String JBOSS_PALETTE_FOLDER = "JBOSSPalette";
       
       private static PaletteController palette = null;
       
       public static PaletteController getPalette() throws IOException {
           if (palette == null)
               palette = PaletteFactory.createPalette(JBOSS_PALETTE_FOLDER, new jbossddPaletteActions()); 
           return palette;
       }
   }

4. jbossddPaletteActions.java ファイルのデフォルトの内容を次で置き換えます:

   package org.netbeans.modules.jbosswebxml.palette;
   
   import java.awt.event.ActionEvent;
   import java.io.IOException;
   import javax.swing.AbstractAction;
   import javax.swing.Action;
   import javax.swing.text.JTextComponent;
   import org.netbeans.editor.Utilities;
   import org.netbeans.spi.palette.PaletteActions;
   import org.netbeans.spi.palette.PaletteController;
   import org.openide.DialogDisplayer;
   import org.openide.NotifyDescriptor;
   import org.openide.text.ActiveEditorDrop;
   import org.openide.util.Lookup;
   import org.openide.util.NbBundle;
   
   public class jbossddPaletteActions extends PaletteActions {
       
       /** Creates a new instance of jbossddPaletteActions */
       public jbossddPaletteActions() {
       }
   
       public Action[] getImportActions() {
           return new Action[0]; //TODO implement this
       }
   
       public Action[] getCustomCategoryActions(Lookup category) {
           return new Action[0]; //TODO implement this
       }
   
       public Action[] getCustomItemActions(Lookup item) {
           return new Action[0]; //TODO implement this
       }
   
       public Action[] getCustomPaletteActions() {
           return new Action[0]; //TODO implement this
       }
   
       public Action getPreferredAction( Lookup item ) {
           return new MFPaletteInsertAction(item);
       }
       
       private static class MFPaletteInsertAction extends AbstractAction {
           
           private Lookup item;
           
           MFPaletteInsertAction(Lookup item) {
               this.item = item;
           }
                   
           public void actionPerformed(ActionEvent e) {
         
               ActiveEditorDrop drop = (ActiveEditorDrop) item.lookup(ActiveEditorDrop.class);
               
               JTextComponent target = Utilities.getFocusedComponent();
               if (target == null) {
                   String msg = NbBundle.getMessage(jbossddPaletteActions.class, "MSG_ErrorNoFocusedDocument");
                   DialogDisplayer.getDefault().notify(new NotifyDescriptor.Message(msg, NotifyDescriptor.ERROR_MESSAGE));
                   return;
               }
               
               try {
                   drop.handleTransfer(target);
               }
               finally {
                   Utilities.requestFocus(target);
               }
               
               try {
                   PaletteController pc = jbossddPaletteFactory.getPalette();
                   pc.clearSelection();
               }
               catch (IOException ioe) {
               } //should not occur
   
           }
       }
       
   }

5. jbossddPaletteUtilities.java ファイルのデフォルトの内容を次で置き換えます:

   package org.netbeans.modules.jbosswebxml.palette;
   
   import java.awt.Component;
   import java.awt.Container;
   import java.util.StringTokenizer;
   import javax.swing.JTree;
   import javax.swing.text.BadLocationException;
   import javax.swing.text.Caret;
   import javax.swing.text.Document;
   import javax.swing.text.JTextComponent;
   import org.netbeans.api.project.FileOwnerQuery;
   import org.netbeans.api.project.Project;
   import org.netbeans.api.project.ProjectUtils;
   import org.netbeans.api.project.SourceGroup;
   import org.netbeans.api.project.Sources;
   import org.netbeans.editor.BaseDocument;
   import org.netbeans.editor.Formatter;
   import org.openide.filesystems.FileObject;
   
   public class jbossddPaletteUtilities {
       
       /** Creates a new instance of jbossddPaletteUtilities */
       public jbossddPaletteUtilities() {
       }
       
       public static void insert(String s, JTextComponent target)
       throws BadLocationException {
           insert(s, target, true);
       }
       
       public static void insert(String s, JTextComponent target, boolean reformat)
       throws BadLocationException {
           
           if (s == null)
               s = "";
           
           Document doc = target.getDocument();
           if (doc == null)
               return;
           
           if (doc instanceof BaseDocument)
               ((BaseDocument)doc).atomicLock();
           
           int start = insert(s, target, doc);
           
           if (reformat && start >= 0 && doc instanceof BaseDocument) {  // format the inserted text
               int end = start + s.length();
               Formatter f = ((BaseDocument)doc).getFormatter();
               f.reformat((BaseDocument)doc, start, end);
           }
           
           if (doc instanceof BaseDocument)
               ((BaseDocument)doc).atomicUnlock();
           
       }
       
       private static int insert(String s, JTextComponent target, Document doc)
       throws BadLocationException {
           
           int start = -1;
           try {
               //at first, find selected text range
               Caret caret = target.getCaret();
               int p0 = Math.min(caret.getDot(), caret.getMark());
               int p1 = Math.max(caret.getDot(), caret.getMark());
               doc.remove(p0, p1 - p0);
               
               //replace selected text by the inserted one
               start = caret.getDot();
               doc.insertString(start, s, null);
           } catch (BadLocationException ble) {}
           
           return start;
       }
   }

6. jbossddPaletteCustomizerAction.java ファイルのデフォルトの内容を次で置き換えます:

   package org.netbeans.modules.jbosswebxml.palette;
   
   import java.io.IOException;
   import org.openide.ErrorManager;
   import org.openide.util.HelpCtx;
   import org.openide.util.NbBundle;
   import org.openide.util.actions.CallableSystemAction;
   
   public class jbossddPaletteCustomizerAction extends CallableSystemAction {
   
       private static String name;
       
       public jbossddPaletteCustomizerAction () {
           putValue("noIconInMenu", Boolean.TRUE); // NOI18N
       }
   
       protected boolean asynchronous() {
           return false;
       }
   
       /** Human presentable name of the action. This should be
        * presented as an item in a menu.
        * @return the name of the action
        */
       public String getName() {
           if (name == null)
               name = NbBundle.getBundle(jbossddPaletteCustomizerAction.class).getString("ACT_OpenjbossddCustomizer"); // NOI18N
           
           return name;
       }
   
       /** Help context where to find more about the action.
        * @return the help context for this action
        */
       public HelpCtx getHelpCtx() {
           return null;
       }
   
       /** This method is called by one of the "invokers" as a result of
        * some user's action that should lead to actual "performing" of the action.
        */
       public void performAction() {
           try {
               jbossddPaletteFactory.getPalette().showCustomizer();
           }
           catch (IOException ioe) {
               ErrorManager.getDefault().notify(ErrorManager.EXCEPTION, ioe);
           }
       }
   
   }

7. jbossddPaletteDropDefault.java ファイルのデフォルトの内容を次で置き換えます:

   package org.netbeans.modules.jbosswebxml.palette;
   
   import javax.swing.text.BadLocationException;
   import javax.swing.text.JTextComponent;
   import org.openide.text.ActiveEditorDrop;
   
   public class jbossddPaletteDropDefault implements ActiveEditorDrop {
       
       String body;
   
       public jbossddPaletteDropDefault(String body) {
           this.body = body;
       }
   
       public boolean handleTransfer(JTextComponent targetComponent) {
   
           if (targetComponent == null)
               return false;
   
           try {
               jbossddPaletteUtilities.insert(body, (JTextComponent)targetComponent);
           }
           catch (BadLocationException ble) {
               return false;
           }
           
           return true;
       }
   
   }

8. org.netbeans.modules.jbosswebxml.palette ノードで右クリックし、「新規」、「ファイル/フォルダ」を選び、「その他」のカテゴリから「プロパティー」ファイルを選択します。「次へ」をクリックし ます。「名前」に「Bundle」と入力し「完了」ボタンを押します。この新しい Bundle.properties ファイルに次のキーを追加します:

   MSG_ErrorNoFocusedDocument=No document selected. Please select a document to insert the item into.
   ACT_OpenJbossddCustomizer=&JBoss Code Clips

コードスニペットの作成

それぞれのコードスニペットには次のファイルが必要です:

• ソースエディタへドラッグされるコードの一部を定義した Java クラス。この Java クラスはどのようにコードが挿入されるべきかを定義した jbossddPaletteUtilities.java を参照する必要があります。たとえば、インデント設定とフォーマットはここで定義されます。
• プロパティーファイルはラベルとツールチップを定義します。
• 16x16 ピクセルイメージは小さいアイコンでの表示用です。
• 32x32 ピクセルイメージは大きいアイコンでの表示用です。

NetBeans モジュールに上のファイルを作成し、追加したあとにこれらをリソース宣言 XML ファイルで宣言します。layer.xml を使って NetBeans システムファイルシステムに登録します。

この詳細は NetBeans コードスニペットモジュールのチュートリアル を参照してください。

例として３つのコードスニペットを ContextRoot.java、ResourceReference.java、 SecurityDomain.java として作成したとすると、結果は次のようになります。以下の選択されたパッケージにコードスニペットとサポートリソースが含まれています:

モジュールのインストールと使用

1. 「プロジェクト」ウィンドウで「jbosswebxml」プロジェクトを右クリックし「ターゲットプラットフォームでのイ ンストール/再読み込み」を選びます。

   モジュールが構築されターゲットプラットフォームにインストールされます。ターゲットプラットフォームが起動し新規モジュールを試すことが できます。デフォルトのターゲットプラットフォームとは IDE の現在のインスタンスで使用しているインストールです。

2. 使い方は サンプルのインストール セクションで説明していますのでモジュールが正しくインストールできているかどうか確認してください。

共有可能なモジュールバイナリの作成

1. 「プロジェクト」ウィンドウで newhtmlsnippet プロジェクトを右クリックし、「NBM を作成」を選択します。

   NBM ファイルが作成されます。「ファイル」ウィンドウ (Ctrl-2) で確認できます:

   

2. メールなどで送付することにより他の人に配布、共有できます。
3. アップデートセンターを使ってモジュールをインストールできます。メインメニューの「ツール」>「アップデートセンター」 を選択してください。