生成ウィザード

org.eclipse.ui.newWizards

この拡張ポイントは、リソース作成ウィザード拡張の登録に使用します。 作成ウィザードは、「新規」ダイアログの選択項目として表示され、一般にフォルダーおよびファイルの 作成に使用されます。

「新規」ダイアログで、ウィザードは、通常、特定の問題ドメインを反映するカテゴリーに編成されます。 例えば、Java 指向のプラグインは、クラスまたはパッケージ作成ウィザードに適した、"Java" と呼ばれるカテゴリーを定義することができます。 あるプラグインによって定義されているカテゴリーは、category 属性を使用してその他のプラグインによって参照できます。 カテゴリー化されていないウィザード、および無効なカテゴリー・パスを持つウィザードは、 "Other" カテゴリーに含まれることになります。

ウィザードでは、オプションで、ウィザードに関する簡略テキストを本文に含む記述サブエレメントを 指定することができます。

<!ELEMENT extension (category | wizard | primaryWizard)*>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT category EMPTY>

<!ATTLIST category

id             CDATA #REQUIRED

name           CDATA #REQUIRED

parentCategory CDATA #IMPLIED>


<!ELEMENT wizard (description? , selection*)>

<!ATTLIST wizard

id                    CDATA #REQUIRED

name                  CDATA #REQUIRED

icon                  CDATA #IMPLIED

category              CDATA #IMPLIED

class                 CDATA #REQUIRED

project               (true | false)

finalPerspective      CDATA #IMPLIED

preferredPerspectives CDATA #IMPLIED

helpHref              CDATA #IMPLIED

descriptionImage      CDATA #IMPLIED

canFinishEarly        (true | false)

hasPages              (true | false) >


<!ELEMENT description (#PCDATA)>

開始時にウィザードが実行する内容を記述した短いテキストを本文に含むサブエレメント (オプション)。



<!ELEMENT selection EMPTY>

<!ATTLIST selection

class CDATA #REQUIRED

name  CDATA #IMPLIED>


<!ELEMENT primaryWizard EMPTY>

<!ATTLIST primaryWizard

id CDATA #REQUIRED>

ウィザードが UI で「1 次」であることを宣言するための手段。 1 次ウィザードは、新規ウィザード・ダイアログで強調表示されます。 プラグイン開発者はこのエレメントを使用しないでください。 このエレメントは、プロダクト・マネージャーが製品の一連のウィザードを強調する場合に使用します。



生成ウィザード構成の例を以下に示します。

   

<extension point=

"org.eclipse.ui.newWizards"

>

<category id=

"com.xyz.XYZ"

name=

"XYZ Wizards"

>

</category>

<category id=

"com.xyz.XYZ.Web"

name=

"Web Wizards"

parentCategory=

"com.xyz.XYZ"

>

</category>

<wizard id=

"com.xyz.wizard1"

name=

"XYZ artifact"

category=

"com.xyz.XYZ/com.xyz.XYZ.Web"

icon=

"./icons/XYZwizard1.gif"

class=

"com.xyz.XYZWizard1"

>

<description>

Create a simple XYZ artifact and set initial content

</description>

<selection class=

"org.eclipse.core.resources.IResource"

/>

</wizard>

</extension>

class 属性の値は、org.eclipse.ui.INewWizard を実装するクラスを表す必要があります。 ウィザードが「新規ウィザード」内で作成された場合、これは既存のウィザードに挿入されます。 ウィザードがショートカットとして起動された場合 (「ファイル」の「新規」メニューまたはツールバー・ボタンを使用)、 これは個別の独立したダイアログ・ボックスとして表示されます。

ワークベンチには、プロジェクト、フォルダー、 およびファイルの各タイプの空リソースを作成するウィザードが用意されています。 これらのウィザードは、上記のメカニズムと同様のメカニズムにより登録されています。 また、特定のプラットフォームのインストールに伴って、追加ウィザードを表示することもできます。