NetBeans プラットフォームペイントアプリケーションのチュートリアル

アプリケーションスケルトンの作成

「NetBeans プラットフォームアプリケーション」テンプレートでアプリケーションのスケルトンを作成します。スケルトンは、アプリケーションの基礎を形成するために一緒になって機能する一連のモジュールで構成されます。「プロジェクトプロパティー」ダイアログを使用し、アプリケーションのスプラッシュ画面、アプリケーション名、および使用する NetBeans モジュールの種類と数の割り当てを行います。配布用 ZIP の作成や Java WebStart (JNLP) アプリケーションの構築などのアクションを利用することもできます。これらのアクションは、アプリケーションをほかのユーザーが利用できるようにするための重要なツールです。

1. 「ファイル」>「新規プロジェクト」を選択します。「カテゴリ」で「NetBeans モジュール」を選択します。プロジェクトで「NetBeans プラットフォームアプリケーション」を選択します。

   

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

2. 「名前と場所」パネルで、「プロジェクト名」に「PaintApp」と入力します。「プロジェクトの場所」を使用コンピュータ上の任意のフォルダに変更します。「主プロジェクトとして設定」チェックボックスがすでに選択されていることを確認します。「完了」をクリックします。

新規アプリケーションスケルトンが IDE で開きます。「プロジェクト」ウィンドウには、2 つのノードが含まれています。1 つ目の「モジュール」ノードは、アプリケーションに、モジュールおよびライブラリラッパーモジュールを手動で追加するためのものです。また、「モジュール」ウィザードまたは「ライブラリラッパーモジュール」ウィザードを使用すると、作成するモジュールを自動的にアプリケーションに追加できます。

ライブラリラッパーモジュールの作成

ライブラリラッパーモジュールは、JAR ファイルにコードが含まれないモジュールで、ライブラリへの単なるポインタです。これによってライブラリが NetBeans モジュールに変換されると、元の JAR ファイルを変更しなくても、NetBeans クラスローダーシステムのすべての保護が適用されます。その結果、アプリケーションは別の NetBeans モジュールに依存する場合と同じように、そのライブラリに依存することができます。また、このライブラリの新しいバージョンが利用できるようになった場合、ラッパーライブラリ用の NetBeans モジュール (NBM) ファイルを 1 つ配布するだけで、新しいバージョンの配布が可能になります。

注: NetBeans プラットフォーム上で構築を行う利点の 1 つは、ユーザーインタフェースが、Java の標準ユーザーインタフェースツールキットである Swing に基づいていることです。Swing は長い間使用されてきたので、アプリケーションに再利用できる Swing コンポーネントが数多くあります。このチュートリアルでは、既存のカラーチューザ (ソースは contrib/coloreditor の下の NetBeans CVS 内にある) を再利用します。JAR ファイルは ColorChooser.jar という名前です。ライブラリはここからダウンロードできます。それをファイルシステム内の任意の場所に保存します。

次の手順に従って、ColorChooser.jar ファイルのためのライブラリラッパーモジュールを作成します。

1. 「ファイル」>「新規プロジェクト」を選択します。「カテゴリ」で「NetBeans モジュール」を選択します。プロジェクトで、「ライブラリラッパーモジュール」を選択し、「次へ」をクリックします。
2. 「ライブラリを選択」パネルで、「ライブラリ」テキストボックスに ColorChooser.jar のパスを入力するか、その場所を参照します。
3. 「ライセンス」テキストフィールドは空のままにしておきます。最終成果物の配布を予定している場合は、外部ライブラリのライセンスファイルを含めるようにします。「次へ」をクリックします。
4. 「名前と場所」パネルで「プロジェクト名」を入力し、「プロジェクトの場所」を設定します。次に、「モジュールスイートに追加」ドロップダウンに、モジュールがアプリケーションに追加されることが示されていることを確認します。「次へ」をクリックします。
5. 「基本モジュール構成」パネルで、次のように「コード名ベース」に一意の名前を入力し、モジュール表示名とモジュールのローカライズ版バンドルの場所を指定します。

   

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

選択した colorchooser.jar をラップするモジュールが IDE で作成されます。新しいモジュールの構造は、「プロジェクト」ウィンドウに表示されます。アプリケーションの構造にある「モジュール」ノードは、モジュールがアプリケーションの一部であることを示します。

モジュールの作成

ここでは、作成する実際のコードを含めるモジュールが必要になります。

1. 「ファイル」>「新規プロジェクト」を選択します。「カテゴリ」で「NetBeans モジュール」を選択します。「プロジェクト」で「モジュール」を選択し、「次へ」をクリックします。
2. 「名前と場所」パネルで、「プロジェクト名」に「Paint」と入力します。「プロジェクトの場所」を使用コンピュータ上の任意のフォルダに変更します。「モジュールスイートに追加」ラジオボタンが選択され、「モジュールスイート」ドロップダウンリストで PaintApp アプリケーションが選択されていることを確認します。「主プロジェクトとして設定」チェックボックスを選択します。「次へ」をクリックします。
3. 「基本モジュール構成」パネルで、「org.netbeans.paint」と入力します。「モジュール表示名」は Paint のままにしておきます。「ローカライズ版バンドル」の場所はそのままにします。「XML レイヤーを生成」を選択し、提案された場所を変更しないと、ローカライズ版バンドルと XML レイヤーファイルは org.netbeans.paint という名前のパッケージに格納されます。

   これらのファイルには、次の役割があります。

   • ローカライズ版バンドル。国際化のための言語固有の文字列を指定します。
   • XML レイヤー。NeｔBeans プラットフォームアプリケーションにメニューやツールバーボタンなどの項目を登録します。

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

IDE によって Paint プロジェクトが作成されます。このプロジェクトには、ソースや、プロジェクトの Ant 構築スクリプトなどのプロジェクトメタデータがすべて含まれます。IDE でプロジェクトが開きます。「プロジェクト」ウィンドウ (Ctrl-1) で、プロジェクトの論理構造を表示できます。また、「ファイル」ウィンドウ (Ctrl-2) で、プロジェクトのファイル構造を表示できます。たとえば、「プロジェクト」ウィンドウは次のように表示されます。

プロジェクトには、ローカライズ版バンドルおよび XML レイヤーのほかに、次の重要なファイルも含まれます。

• モジュールのマニフェスト。プロジェクトがモジュールであることを宣言します。また、XML レイヤーの場所、ローカライズ版バンドルの場所、モジュールのバージョンなどの、モジュール固有の設定も行います。
• 構築スクリプト。nbproject/build-impl.xml 内の指定よりも優先される、独自の Ant ターゲットをここに作成できます。
• プロジェクトメタデータ。プロジェクトの種類、内容、プラットフォーム、クラスパス、依存関係、プロジェクトのコマンドと Ant スクリプト内のターゲットのマッピングなどの情報が含まれます。

このチュートリアルでは、これらの情報を変更する必要はありません。

モジュールの依存関係の指定

NetBeans API に属するいくつかのクラスをサブクラス化する必要があります。また、そのプロジェクトは ColorChooser.jar ファイルに依存します。すべての NetBeans API はモジュールによって実装されます。そのため、これらの作業の両方を完成することは、モジュールの実行に必要なモジュールの一覧にいくつかのモジュールを追加することを意味します。

1. 「プロジェクト」ウィンドウで、Paint プロジェクトノードを右クリックし、「プロパティー」を選択します。「プロジェクトプロパティー」ダイアログが開きます。「カテゴリ」で「ライブラリ」をクリックします。
2. 次の表に表示されている API のそれぞれについて、「依存関係を追加...」をクリックし、「フィルタ」テキストボックスにサブクラス化するクラスの名前の入力を開始します。

   クラス	API	目的
   ColorChooser	ColorChooser	作成したカラーチューザコンポーネントのライブラリラッパーモジュール
   DataObject	データシステム API	DataObject クラスを含む NetBeans モジュール
   DialogDisplayer	ダイアログ API	ユーザー通知の作成、ダイアログの説明、およびその表示を可能にします
   AbstractFile	ファイルシステム API	一定の方法でファイルにアクセスする共通の API を提供します
   AbstractNode	ノード API	NetBeans 内のオブジェクトを視覚化する主機構として機能します
   StatusDisplayer	UI ユーティリティー API	メインウィンドウのステータスバーの作成に使用される StatusDisplayer クラス
   WeakListeners	ユーティリティー API	WeakListeners クラスを含みます
   TopComponent	ウィンドウシステム API	TopComponent JPanel クラスを含みます

   上記の表の最初の列には、このチュートリアルでサブクラス化するすべてのクラスが一覧表示されています。それぞれについて、「フィルタ」にクラス名を入力し始めると、「モジュール」リストの表示が絞り込まれます。表の 2 番目の列を使用して、絞り込まれた「モジュール」リストから適切な API (または ColorChooser の場合はライブラリ) を選択し、「了解」をクリックして選択を確認します。

   

3. 「了解」をクリックして、「プロジェクトプロパティー」ダイアログを終了します。
4. 「プロジェクト」ウィンドウで、Paint モジュールのプロジェクトノードが展開されていない場合は展開します。次に「重要なファイル」ノードを展開し、「プロジェクトメタデータ」ノードをダブルクリックします。選択した API はモジュールの依存関係として宣言されています。

キャンバスの作成

次の手順では、ユーザーがペイントする実際のコンポーネントを作成します。ここでは、純粋な Swing コンポーネントを使用するため、その実装の詳細は省略し、最終バージョンのみを提供します。ライブラリラッパーモジュールを作成したカラーチューザ Bean が、このパネルのソースコードに使用されます。完成したアプリケーションを実行すると、画像編集用パネルのツールバーでこのカラーチューザ Bean を確認できます。

1. 「プロジェクト」ウィンドウで、「Paint」ノード、「ソースパッケージ」ノードを順に展開し、「org.netbeans.paint」ノードを右クリックします。「新規」>「Java クラス」を選択します。
2. クラス名として「PaintCanvas」と入力します。パッケージの一覧に org.netbeans.paint があることを確認します。「完了」をクリックします。ソースエディタに PaintCanvas.java が表示されます。
3. このファイルのデフォルトの内容をここに示す内容で置き換えます。パッケージに org.netbeans.paint 以外の名前を付けた場合は、ソースエディタでパッケージ名を修正します。

TopComponent クラスの準備

ここでは、NetBeans API を利用する最初のクラスを作成します。それは TopComponent クラスです。TopComponent クラスは、NetBeans のウィンドウシステムで操作可能な JPanel クラスであり、メインウィンドウのタブ付きコンテナ内に配置できます。

1. 「プロジェクト」ウィンドウで、「Paint」ノード、「ソースパッケージ」ノードを順に展開し、「org.netbeans.paint」ノードを右クリックします。「新規」>「Java クラス」を選択します。クラス名として「PaintTopComponent」と入力します。パッケージの一覧に org.netbeans.paint があることを確認します。「完了」をクリックします。ソースエディタに PaintTopComponent.java が表示されます。
2. ファイルの最上部近くにあるクラス宣言を次のように変更します。

   public class PaintTopComponent extends TopComponent implements ActionListener, ChangeListener {

3. Ctrl-Shift-I キーを押してインポートを修正し、ダイアログで「了解」をクリックします。このファイルの最上部にある、必要なインポートパッケージの宣言は IDE によって行われます。

   入力したクラス宣言の下に赤い線が表示されます。その行にカーソルを置くと、左側の余白に電球が表示されます。次に示すように、電球をクリックするか、Alt-Enter キーを押します。

   

   「すべての抽象メソッドの実装」を選択します。IDE によって、2 つのメソッド actionPerformed() と stateChanged() のスケルトンが生成されます。このチュートリアルでは、あとでこれらの記述を行います。
4. 次の 3 つの変数の宣言を PaintTopComponent クラスの最上部に追加し、インポート文を修正します (Ctrl-Shift-I)。

       private PaintCanvas canvas = new PaintCanvas(); //ユーザーが描画するコンポーネント
       private JComponent preview; //ペイントブラシサイズを示すツールバーのコンポーネント
       private static int ct = 0; //新しい画像の名前を用意するために使用するカウンタ

5. 今度は、2 つのボイラープレートメソッドを実装する必要があります。1 つはアプリケーションの停止時に、開いているウィンドウを無視するようにウィンドウシステムに指示するものです。もう 1 つは、コンポーネントの一意の文字列 ID 用のベース文字列を提供するものです。各 TopComponent には、TopComponent を保存するときに使用される一意の文字列 ID があります。次の 2 つのメソッドを PaintTopComponent クラスに挿入します。

       @Override
       public int getPersistenceType() {
           return PERSISTENCE_NEVER;
       }
   
       @Override
       public String preferredID() {
           return "Image";
       }

クラスは次のようになります。

public class PaintTopComponent extends TopComponent implements ActionListener, ChangeListener {
    
    private PaintCanvas canvas = new PaintCanvas(); //ユーザーが描画するコンポーネント
    private JComponent preview; //ペイントブラシサイズを示すツールバーのコンポーネント
    private static int ct = 0; //新しい画像の名前を用意するために使用するカウンタ
    
    public PaintTopComponent() {
    }
    
    @Override
    public void actionPerformed(ActionEvent arg0) {
        throw new UnsupportedOperationException("Not supported yet.");
    }
    
    @Override
    public void stateChanged(ChangeEvent arg0) {
        throw new UnsupportedOperationException("Not supported yet.");
    }
    
    @Override
    public int getPersistenceType() {
        return PERSISTENCE_NEVER;
    }
    
    @Override
    public String preferredID() {
        return "Image";
    }
    
}

TopComponent クラスの初期化

この節では、ユーザーインタフェースを初期化するコードを追加します。

1. コンストラクタを定義し、次のインポート文を修正します (Ctrl-Shift-I)。

       public PaintTopComponent() {
   
           initComponents();
   
           String displayName = NbBundle.getMessage(
                   PaintTopComponent.class,
                   "UnsavedImageNameFormat",
                   new Object[] { new Integer(ct++) }
           );
   
           setDisplayName(displayName);
   
       }

   このコードは非常に簡潔です。最初の呼び出しは、まだ作成されていない initComponents() メソッドに対するものです。このメソッドは、ツールバーおよび PaintCanvas を TopComponent に追加します。このメソッドはまだ作成されていないので、その下に赤い線が表示されています。前と同じように電球をクリックするか Alt-Enter キーを押して、提案を受け入れます。

   

   initComponents() メソッドのスケルトンが生成されます。

2. 「プロジェクト」ウィンドウで org.netbeans.paint パッケージを展開します。Bundle.properties ファイルをダブルクリックして、ソースエディタで開きます。最後の部分に、次の行を追加します。

       UnsavedImageNameFormat=Image {0}

   これは、アプリケーションの新しい画像ファイルを、ユーザーが保存する前に識別するために使用されるテキストを指定します。たとえば、完成したアプリケーションではじめて「New Canvas」をクリックすると、ソースエディタ上に「Image 0」というラベルのタブが表示されます。次に進む前に、このファイルを必ず保存します。

スケルトンメソッドの記入

この節では、アプリケーションのユーザーインタフェースをコーディングします。レイアウトを視覚的にデザインするために、IDE の GUI ビルダーを使用することもできます。

1. initComponents() メソッドでコンポーネントをパネルにインストールすると、ユーザーが対話できます。PaintTopComponent.java クラスの前の節で、そのスケルトンメソッドを作成しました。そこに、次のように記述します。

       private void initComponents() {
   
           setLayout(new BorderLayout());
           JToolBar bar = new JToolBar();
   
           ColorChooser fg = new ColorChooser();
           preview = canvas.createBrushSizeView();
   
           //ツールバーを構築
   
           //コンポーネントがつぶれないようにする
           Dimension min = new Dimension(32, 32);
           preview.setMaximumSize(min);
           fg.setPreferredSize(new Dimension(16, 16));
           fg.setMinimumSize(min);
           fg.setMaximumSize(min);
   
           JButton clear = new JButton(
             	    NbBundle.getMessage(PaintTopComponent.class, "LBL_Clear"));
   
           JLabel fore = new JLabel(
            	    NbBundle.getMessage(PaintTopComponent.class, "LBL_Foreground"));
   
           fg.addActionListener(this);
           clear.addActionListener(this);
   
           JSlider js = new JSlider();
           js.setMinimum(1);
           js.setMaximum(24);
           js.setValue(canvas.getDiam());
           js.addChangeListener(this);
   
           fg.setColor(canvas.getColor());
   
           bar.add(clear);
           bar.add(fore);
           bar.add(fg);
           JLabel bsize = new JLabel(
        	    NbBundle.getMessage(PaintTopComponent.class, "LBL_BrushSize"));
   
           bar.add(bsize);
           bar.add(js);
           bar.add(preview);
   
           JLabel spacer = new JLabel("   "); //ブラシプレビューが
           //ツールバーの端まで広がらない
           //ようにするスペーサ
   
           spacer.setPreferredSize(new Dimension(400, 24));
           bar.add(spacer);
   
           //ツールバーおよび描画処理コンポーネントを配置
           add(bar, BorderLayout.NORTH);
           add(canvas, BorderLayout.CENTER);
           
       }

   Ctrl-Shift-I キーを押して、必要なインポート文を生成します。

2. 生成したほかの 2 つのメソッドにも記述します。これらのメソッドは、PaintTopComponent クラスの監視に使用されます。

       public void actionPerformed(ActionEvent e) {
   
           if (e.getSource() instanceof JButton) {
              canvas.clear();
           } else if (e.getSource() instanceof ColorChooser) {
              ColorChooser cc = (ColorChooser) e.getSource();
              canvas.setPaint (cc.getColor());
           }
           
           preview.paintImmediately(0, 0, preview.getWidth(), preview.getHeight());
           
       }

       public void stateChanged(ChangeEvent e) {
   
           JSlider js = (JSlider) e.getSource();
           canvas.setDiam (js.getValue());
           preview.paintImmediately(0, 0, preview.getWidth(), preview.getHeight());
           
       }

3. Bundle.properties ファイルの最後に、次のキーと値のペアを追加します。

       LBL_Clear = Clear
       LBL_Foreground = Foreground 
       LBL_BrushSize = Brush Size
   

   次に進む前に、このファイルを必ず保存します。

ディスクへの画像の保存

新しいアプリケーションで、作成した画像を保存できるようにします。次のコードを PaintTopComponent クラスに含めると、この機能が有効になります。

1. 次のコードを PaintTopComponent クラスに挿入します。

       public void save() throws IOException {
   
           if (getDisplayName().endsWith(".png")) {
   	    doSave(new File(getDisplayName()));
           } else {
   	    saveAs();
           }
           
       }
   
       public void saveAs() throws IOException {
   
           JFileChooser ch = new JFileChooser();
           if (ch.showSaveDialog(this) == JFileChooser.APPROVE_OPTION && ch.getSelectedFile() != null) {
   
   	    File f = ch.getSelectedFile();
               
   	    if (!f.getPath().endsWith(".png")) {
   	        f = new File(f.getPath() + ".png");
   	    }
               
   	    if (!f.exists()) {
               
   	        if (!f.createNewFile()) {
   		    String failMsg = NbBundle.getMessage(
   		             PaintTopComponent.class,
   			    "MSG_SaveFailed", new Object[] { f.getPath() }
   	            );
   		    JOptionPane.showMessageDialog(this, failMsg);
   		    return;
   	        }
                   
   	    } else {
   	        String overwriteMsg = NbBundle.getMessage(
   		    PaintTopComponent.class,
                       "MSG_Overwrite", new Object[] { f.getPath() }
   	        );
                   
   	        if (JOptionPane.showConfirmDialog(this, overwriteMsg)
   	        != JOptionPane.OK_OPTION) {
   		    return;
   	        }
                   
   	    }
               
   	    doSave(f);
               
           }
           
       }
   
       private void doSave(File f) throws IOException {
   
           BufferedImage img = canvas.getImage();
           ImageIO.write(img, "png", f);
           String statusMsg = NbBundle.getMessage(PaintTopComponent.class,
               "MSG_Saved", new Object[] { f.getPath() });
           StatusDisplayer.getDefault().setStatusText(statusMsg);
           setDisplayName(f.getName());
           
       }

2. Bundle.properties ファイルに次の行を追加します。

       MSG_SaveFailed = Could not write to file {0}
       MSG_Overwrite = {0} exists.  Overwrite?
       MSG_Saved = Saved image to {0}

   次に進む前に、このファイルを必ず保存します。

3. Ctrl-Shift-I キーを押して、インポート文を修正します。File クラスに 2 つの完全修飾名があることがわかります。java.io.File オプションを選択します。