作成日:2008/12/05
Mac OS X 10.5.4 Eclipse SDK 3.3.2 Pleiades 1.2.3p10


Eclipse プロジェクトの新規作成  掲載記事一覧
1 新規プロジェクト作成ウィザードの作成 Eclipseへの新規プロジェクト追加方法と、対応する新規プロジェクト作成ウィザードの実装方法
2 新規プロジェクトをカテゴリ分けする 新規プロジェクトをカテゴリ分けして追加する方法
3 新規プロジェクトファイル作成 新規プロジェクト作成ウィザードの内容に従い、実際にプロジェクトファイルを生成する方法
4 プロジェクトの特徴付け(Natureの付与)を行う ネーチャーでプロジェクトを区別できるようにする方法
5 プロジェクトに任意のアイコンを重ねて表示 ラベル装飾を利用してプロジェクトに任意のアイコンを重ねる方法

新規プロジェクト作成ウィザード

実装イメージ例えば、 Eclipse を使って Java の開発をするためにはまず Javaプロジェクト を作成しなければなりません。 また、PHP の開発をするには PHPプロジェクト といったように、開発者(Eclipse利用者)は目的に応じたプロジェクトを作成し、その中で開発を行っていくことになります。

プラグインを作ることで Eclipse に新たなプロジェクトを追加することができるわけですが、新しいプロジェクトを作成する場合には新規プロジェクト作成ウィザードを提供して、利用者が Java開発 などと同様にプロジェクトを作れるようにしておく必要があります。

ここでは、新しいプロジェクト新規プロジェクト作成ウィザードを作成し、 Eclipse からメニューをたどってウィザードを起動できるようにする手順を紹介します。 最終的には図のように 「Other(その他)」 グループから "SampleProject" という名前のプロジェクトが選択できるようになります。

手順作成にあたって、 Mac OS X 10.5.4 上にインストールした Eclipse 3.3.2 を使用しています。 Eclipse は Pleiades 1.2.3p10 をつかって日本語化しています。環境が異なると表示や手順が異なってくる場合もありますのでご注意ください。

また、 Eclipse 上に プラグイン・プロジェクトで作業を行いますので、プラグイン・プロジェクトを作成していない場合は 「 プラグインプロジェクト作成 」 に記事を掲載していますので参考になるかもしれません。

1.新規プロジェクトの定義

1-1.拡張の追加方法

拡張の追加プラグイン・プロジェクトの "META-INF/MANIFEST.MF" ファイルを開きます。下側にタブのついたウインドウが開くので、「拡張」タブを選択します。

拡張に関するページが開くので、 「すべての拡張」 にある 「追加...」 ボタンを押します。

1-2.新規作成ウィザード拡張を追加

新規ウィザード拡張ポイント拡張ポイントを選択するダイアログが表示されるので、 「org.eclipse.ui.newWizards」 を選択して 「完了」 ボタンを押します。

これにより、新たにプロジェクトやクラスなどを作成するときに利用する Eclipse の新規作成ウィザード機能を拡張できるようになります。

1-3.新規作成ウィザード拡張でウィザードを追加

ウィザード追加「すべての拡張」 に 「org.eclipse.ui.newWizards」 が追加されるので、それを右クリック(Control+クリック)し 「新規」 から 「wizard」 を選択します。

これで、Eclipse に新たな新規作成ウィザードが追加されます。

1-4.作成するウィザードの情報を入力

ウィザード設定追加した wizard の情報が、 「拡張要素詳細」 に表示されるので、作成したいウィザードの情報を入力します。

"id:" にはウィザードを一意に特定できるIDを入力します。
デフォルトで値が入っているのでそのままにしましたが、wizard1とかなっているのでもう少ししっかりした名前を検討した方がいいと思います。

"name:" は新規プロジェクトとして表示したい名前(プロジェクト名)を入力します。
今回は "SampleProject" としました。

"class:" はプロジェクトに対応する新規作成ウィザードクラスの名前を入力します。
デフォルトで値が入っていますが、クラス名としてあまりふさわしくないので変えたほうがいいと思います。今回は "wizardsample.NewProjectWizard" としました。

"icon:" はプロジェクトの目印となるアイコンを指定します。
なくても問題ないのですが sample.gif というアイコン(16×16)で用意して指定してみました。アイコンのパスはプロジェクトのルートディレクトリからの相対パスで指定します。

"プロジェクト:" は追加したウィザードがプロジェクト作成のためのウィザードであるかを指定します。
ここを true に設定することで、このウィザードクラスを 「新規」 → 「プロジェクト...」 と選んだ時の候補に加えることができます。今回は、新規プロジェクト作成ウィザードを作りたいので true に設定しました。

これらを入力して保存します。以上でウィザードの定義は完了です。

2.新規プロジェクト作成ウィザードの実装クラス作成

2-1.定義からクラスを作成

ウィザードクラス作成第1項までの段階では、『ウィザードクラスの名前は定義したけれど実際のクラスは作っていない』 という状態です。 先ほどの「拡張要素詳細」でクラス名を入力した "class:" をクリックするとクラスの作成が行えます。

2-2.新規作成ウィザードクラスを作成

新規 Java クラス のダイアログが開きます。 プラグインプロジェクト作成完了

"class:" に入力しておいた情報 (今回は "wizardsample.NewProjectWizard" ) からパッケージ名とクラス名が判断され入力されています。 また、新規作成ウィザードには org.eclipse.jface.wizard.Wizard クラスの継承org.eclipse.ui.INewWizard インタフェースの実装が必要ですが、それも取り込まれた状態になっています。

「完了」 ボタンを押して新規作成ウィザードのクラスを作成します。

これでEclipse のメニューから、作成した "SampleProject" が選択できるようになり、対応する新規プロジェクト作成ウィザードクラスが作成できました。

3.ウィザードにサンプルコードを実装

第2項までで、"SampleProject" という名前のプロジェクトと、対応する新規プロジェクト作成ウィザードクラスの作成が完了しました。ウィザードの中身は追加したプロジェクトがどんなプロジェクトかによりますが、ウィザードを試しに表示させてみたいのでサンプルを実装することにしました。ウィザードは本体となるウィザードクラスと利用者に値を入力してもらうウィザードページから構成されます。今回、ウィザードページは Eclipse に用意されている "新規プロジェクト作成ページ" を使って実装してみました。

3-1.新規プロジェクト作成ページを使えるようにする

依存関係を追加新規プロジェクト作成ページは org.eclipse.ui.dialogs.WizardNewProjectCreationPageクラス で提供されています。このクラスを使用するには org.eclipse.ui.ideプラグイン を依存関係に登録しておく必要があります。

プラグイン・プロジェクトの "META-INF/MANIFEST.MF" ファイルを開き、 「依存関係」 タブを選択します。 「追加...」 ボタンを押して "org.eclipse.ui.ide" を選択します。

3-2.新規作成プロジェクトウィザードにサンプルコードを実装

3-2-1.新規プロジェクト作成ページをインポート

パッケージをインポートする部分に次の一文を加えます。これは、今回サンプルとして既存の WizardNewProjectCreationPageクラス を使用するためです。

import org.eclipse.ui.dialogs.WizardNewProjectCreationPage;

3-2-2.ページを参照するインスタンス変数を実装

クラスの先頭に次の一文を加えます。今回のサンプルではウィザードからページへアクセスすることはありませんが、形式的にインスタンス変数としました。

private WizardNewProjectCreationPage page;

3-2-3.performFinish() メソッドを実装

return false; となっている部分を return true; に書き換えます。これは true を返さないとウィザードが閉じられないためです。

3-2-4.addPages() メソッド を実装

addPages() メソッドをオーバーライドして、新規プロジェクト作成ページをウィザードに追加する処理を記述します。

public void addPages() {
  page = new WizardNewProjectCreationPage("サンプルページ");
  addPage(page);
}

WizardNewProjectCreationPageのコンストラクタに渡しているのはページの名前です。

以上で、サンプルとなるウィザードクラス NewProjectWizard.java の実装は終了です。

4.動作確認

4-1.テスト実行

テスト実行作成したウィザードを表示してみます。まず、プラグイン・プロジェクトの "META-INF/MANIFEST.MF" ファイルを開き、 「概要」 タブを選択します。

「テスト」 から 「Eclipse アプリケーションの起動」 をクリックすると、 今実装したプラグインが取り込まれた状態の Eclipse が新たに起動します。

4-2.新規プロジェクトの作成

新規プロジェクトEclipse が起動したら、 「Package」 上で右クリック(Control+クリック)して 「New」 から 「Project...」 を選択します。

4-3.新規プロジェクトの作成

新規プロジェクト表示されるプロジェクトの一覧の 「Other」 から作成した 「SampleProject」 が選択できることを確認します。

4-4.新規プロジェクト作成ウィザード起動

新規プロジェクト作成ウィザードサンプルSampleProject を選択して 「次へ」 ボタンを押します。サンプルで実装した新規プロジェクト作成ウィザードが起動できることを確認します。

以上で、 Eclipse への新たなプロジェクトの追加と、新規プロジェクト作成ウィザードの作成は完了です。

参考文献