ファイルの種類統合のチュートリアル

1. 「プロジェクト」ウィンドウで、Abc File Type プロジェクトを右クリックし、「実行」を選択します。

   IDE の新しいインスタンスが起動し、それにモジュールがインストールされます。

2. 「新規プロジェクト」ダイアログ (Ctrl-Shift-N) を使用して、任意の種類のアプリケーションを IDE に作成します。
3. アプリケーションノードを右クリックし、「新規」>「その他」を選択します。「その他」カテゴリで、新しいファイルの種類を操作するためのテンプレートを使用できます。

   

   ウィザードを完了するとテンプレートが作成されます。このテンプレートを使用して、特定のファイルの種類でユーザーの作業を開始できます。

   このテンプレートを使用してデフォルトのコードを提供する場合は、「新規ファイルの種類」ウィザードで作成された AbcTemplate.abc ファイルにそのコードを追加します。

アクションの追加

このサブセクションでは、「新規アクション」ウィザードを使用して、ファイルの種類のアクションを実行する Java クラスを作成します。このウィザードでは、エクスプローラウィンドウにあるファイルの種類のノードの、右クリックのコンテキストメニューから呼び出しできるように、クラスを layer.xml ファイルに登録します。

1. プロジェクトノードを右クリックし、「新規」>「アクション」を選択します。
2. 「アクションの種類」パネルで、「条件付きで有効」をクリックします。次に示すように、前に「新規ファイルの種類」ウィザードで生成したデータオブジェクトの名前 AbcDataObject を入力します。

   

   「次へ」をクリックします。

3. 「GUI 登録」パネルで、「カテゴリ」ドロップダウンリストから「編集」カテゴリを選択します。「カテゴリ」ドロップダウンリストは、IDE のキーボードショートカットエディタでアクションが表示される場所を制御します。

   次に、「大域メニュー項目」を選択解除して「ファイルの種類のメニュー項目」を選択します。「内容の種類」ドロップダウンリストで、次に示すように、「新規ファイルの種類」ウィザードで前に指定した MIME タイプを選択します。

   

   メニュー項目の位置は設定可能で、そのメニュー項目を前後の項目から離すことができます。「次へ」をクリックします。

4. 「名前と場所」パネルで、「クラス名」に「MyAction」と入力し、「表示名」に「MyAction」と入力します。コンテキストメニューにあるメニュー項目には、アイコンが表示されません。したがって、「完了」をクリックすると org.myorg.abcfiletype パッケージに MyAction.java が追加されます。
5. ソースエディタで、アクションの actionPerformed メソッドにいくつかのコードを追加します。

   @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);
   }

   Ctrl-Shift-I キーを押します。IDE によって、インポート文がクラスの先頭に自動で追加されます。

   一部のコードには、まだ赤い下線が付いています。これは、クラスパスに必要なパッケージのすべてがないことを示しています。プロジェクトノードを右クリックして「プロパティー」を選択し、「プロジェクトプロパティー」ダイアログの「ライブラリ」をクリックします。「ライブラリ」区画の上部にある「追加」をクリックし、「ダイアログ API」を追加します。

   MyAction.java クラスで、もう一度 Ctrl-Shift-I キーを押します。 IDE がダイアログ API の必要なパッケージを検出したため、赤い下線が消えます。

6. 「重要なファイル」ノードで、「XML レイヤー」を展開します。「<このレイヤー>」と「<コンテキスト内のこのレイヤー>」の 2 つのノードと、それらのサブノードが、System ファイルシステムブラウザを構成します。「<このレイヤー>」、「Loaders」を順に展開し、前に作成した「Action」が表示されるまでノードを展開します。
7. My Action をドラッグ＆ドロップすると、次に示すように、開くアクションの下に表示されます。

   

   最後の 2 つの手順から分かるとおり、System ファイルシステムブラウザは、System ファイルシステムに登録されている項目の順序をすばやく再編成するのに使用できます。

8. 前の節で実行したように、モジュールを再実行します。
9. 前の節で示したテンプレートを使用して ABC ファイルを作成し、「プロジェクト」ウィンドウや「お気に入り」ウィンドウなど、いずれかのエクスプローラビューでそのファイルのノードを右クリックします。

   Abc ファイルには、モジュールで割り当てたアイコンと、右クリックのコンテキストメニューから使用できる、layer.xml ファイルで定義されているアクションのリストがあります。

   

10. 新規メニュー項目を選択すると、Abc ファイルの名前と場所が次のように表示されます。

    

特定の種類のファイルのコンテキストメニューに表示される新しいアクションを、「プロジェクト」ウィンドウ、「ファイル」ウィンドウ、または「お気に入り」ウィンドウで作成する方法について学習しました。

ファイルをウィンドウで開く

デフォルトでは、このチュートリアルで定義した種類のファイルを開くと、そのファイルが基本のエディタで開きます。ただし、ファイルの視覚表現を作成したい場合があります。ユーザーはウィジェットをドラッグして視覚表現にドロップします。このようなユーザーインタフェースを作成する最初の手順として、ユーザーはファイルをウィンドウで開きます。このサブセクションでその方法を説明します。

1. プロジェクトノードを右クリックし、「新規」>「ウィンドウコンポーネント」を選択します。次に示すように、「ウィンドウの位置」に「editor」と、「アプリケーションの起動時に開く」を設定します。

   

2. 「次へ」をクリックし、「クラス名の接頭辞」に「Abc」と入力します。

   

   「完了」をクリックします。

3. DataObject コンストラクタを次のように変更し、DataEditorSupport の代わりに OpenSupport を使用するように DataObject を変更します。

   public AbcDataObject(FileObject pf, MultiFileLoader loader)
           throws DataObjectExistsException, IOException {
   
       super(pf, loader);
       CookieSet cookies = getCookieSet();
       //cookies.add((Node.Cookie) DataEditorSupport.create(this, getPrimaryEntry(), cookies));
       cookies.add((Node.Cookie) new AbcOpenSupport(getPrimaryEntry()));
                 
   }

4. 次の OpenSupport クラスを作成します。

   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;
       }
    
   }

   TopComponent を変更して、TopComponent の代わりに CloneableTopComponent を拡張します。TopComponent のクラス修飾子を設定し、そのコンストラクタの修飾子を private ではなく public に設定します。

モジュールを再実行すると、次に Abc ファイルを開くときに、OpenSupport クラスがファイルを開く処理を行います。たとえば、DataEditorSupport が提供する基本エディタの代わりに TopComponent でファイルが開かれます。

NetBeans ビジュアルライブラリのチュートリアルに、TopComponent の詳細を開発する方法の例が説明されています。たとえば、このチュートリアルで定義されたファイルの種類に対応するファイルの内容を視覚的に表示します。

マルチビューウィンドウの作成

ファイルをウィンドウで開くことができるようになったので、ウィンドウを少し変えてみます。マルチビューウィンドウを作成します。通常、マルチビューウィンドウの最初のタブでファイルを視覚的に表示し、2 番目のタブでソースビューを表示します。3 つ以上のタブを作成して、それぞれのタブに、開いたファイルの詳細を表示することもできます。

1. プロジェクトノードを右クリックし、「プロパティー」を選択します。「プロジェクトプロパティー」ダイアログで「ライブラリ」を選択し、「追加」をクリックします。「マルチビューウィンドウ」の依存関係を設定します。「了解」をクリックし、再度「了解」をクリックして、「プロジェクトプロパティー」ダイアログを終了します。
2. マルチビューウィンドウに作成する各タブについて、MultiViewDescription および Serializable を実装するクラスを作成します。

   このチュートリアルでは、まず、指定されたクラスを実装する AbcMultiviewDescription1 というクラスを作成します。

   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.");
       }
   
   }

   上の AbcMultiviewDescription1 クラスでは、createElement() メソッドが MultiViewElement を返します。ここで返したいのは TopComponent です。これについては次の手順で実行します。

3. クラスの署名を書き直します。前の手順の description にマルチビュー要素を提供するには、次のように MultiViewElement を実装する必要があります。

   public final class AbcTopComponent extends TopComponent implements MultiViewElement {

   TopComponent で、findInstance()、getPersistenceType()、writeReplace()、および preferredID() の各メソッドを削除 (コメントアウト) する必要があります。

4. ここでは、必要な各メソッドの単純な実装を提供します。まず、新しい JToolbar を TopComponent クラスの最初に定義します。

   private JToolBar toolbar = new JToolBar();

   次に、メソッドを実装します。

       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;
       }

5. これで、次のように AbcMultiviewDescription1 を再定義できます。

   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();
       }
   
   }

6. OpenSupport クラスの createCloneableTopComponent メソッドを変更して、TopComponent を先ほど作成した MultiViewDescription クラスで開くようにします。

   protected CloneableTopComponent createCloneableTopComponent() {
   
       // マルチビュー記述子の配列を作成します:
       AbcMultiviewDescription1 firstTab = new AbcMultiviewDescription1();
       MultiViewDescription[] descriptionArray = { firstTab };
   
       // マルチビューウィンドウを作成します:
       CloneableTopComponent tc = MultiViewFactory.createCloneableMultiView(descriptionArray, firstTab,  null);
       tc.setDisplayName(entry.getDataObject().getName());
       return tc;
   
   }

   MultiViewFactory.createCloneableMultiView の 2 番目の引数は、デフォルトで開くタブを決定します。ここでは、AbcMultiViewDescription1 で定義されるタブ firstTab になります。

7. 再度、ファイルをインストールして開きます。これで、1 つのタブを持つマルチビューウィンドウができました。

   

マルチビューウィンドウには単一のタブがあります。追加するタブごとに、新しい MultiviewDescription クラスを新しい TopComponent とともに作成し、前に表示したとおり、OpenSupport 拡張クラス内の MultiViewDescription クラスをインスタンス化します。

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

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

   

2. たとえば、NetBeans プラグインポータルを通じて、ほかの人がそのファイルを使用できるようにします。受信者は「プラグインマネージャー」(「ツール」>「プラグイン」) を使用して、それをインストールします。