例 - README ツール

概要

README エディターは、他のプラグインで 使用するために、独自の拡張ポイントを定義する方法を示します。 リソース・ポップアップ・メニュー・エントリー、新しいリソース・ウィザード、 拡張子 (.readme) でのファイル・エディター、 カスタム・ビューおよびプロパティー・ページのために拡張子を作成する方法も示します。

例の実行

この例の使用を開始するには、 ファイル作成ウィザードを使用して .readme 拡張子を持つファイルを作成するか、 または例作成ウィザードを使用して例を作成します。 この例で提供する追加のビューは、 「パースペクティブ (Perspectives)」 > 「ビューの表示 (Show View)」> 「その他 (Other)」 と選択し、Readme セクションを展開して表示することができます。 ビュー・アクションは「ナビゲーター (Navigator)」ビューの README アイコンを クリックして表示することができます。

新しい README ファイルの作成

ファイル拡張子 .readme を持つ新しいファイルを作成します。   「ファイル (File)」メニューから、 「新規 (New)」を選択し、サブメニューから「その他... (Other...)」を選択します。   ウィザードで「シンプル (Simple)」をクリックし、それから 左のリストで「ファイル (File)」を選択します。   ファイル名 (拡張子が .readme であることを確認する) と ファイルを入れる予定のフォルダーを提供するために「次 (Next)」をクリックします。

例作成ウィザード

「ファイル (File)」メニューから、 「新規 (New)」を選択し、サブメニューから 「その他... (Other...)」を選択します。  ここで、「例作成ウィザード (Example Creation Wizards)」を選択します。「README ファイル (Readme File)」を選択します。「次へ (Next)」をクリックします。 ファイルを作成する先のフォルダーを選択します。 .readme 拡張子を持つファイルの名前を入力します。「終了 (Finish)」をクリックします。

README ビュー拡張子アクション

「ナビゲーター (Navigator)」ビューで、拡張子 .readme を持つファイルを選択します。そのようなファイルが ない場合は、その拡張子を持つファイルを作成してください。「ナビゲーター (Navigator)」 ビューのローカル・ツールバーで、吹き出しヘルプに 「README ビュー拡張子の実行 (Run Readme View Extension)」と書かれたボタンが表示されます。   このボタンをクリックします。   ダイアログに「ビュー・アクションが実行されました (View Action executed)」 と表示されます。

ポップアップ・メニュー

「ナビゲーター (Navigator)」ビューで、拡張子.readme を持つファイルを選択します。   そのようなファイルがない場合は、その拡張子を持つファイルを作成します。   ファイルを選択して、ポップアップ・メニューを表示します。   ポップアップ・メニューには「README アクションの表示 (Show Readme Action)」と書かれた メニュー項目に注意してください。   このメニュー項目を選択して、「ポップアップ・メニュー項目が実行されました (Popup Menu Action Executed)」と 書かれたダイアログを開きます。

設定ページ

「ウィンドウ (Window)」メニューから、 「設定の変更 (Preferences)」を選択します。   「README 例 (Readme Example)」というページをクリックします。   これは設定ページの例を示します。

プロパティー・ページ

「ナビゲーター (Navigator)」ビューで、拡張子 .readme を持つファイルを選択します。   そのようなファイルがない場合は、その拡張子を持つファイルを作成します。   ファイルを選択して、ポップアップ・メニューを表示し、 「プロパティー (Properties)」メニュー項目を選択します。   「README ツール (Readme Tool)」と呼ばれるページをクリックして、プロパティー・ページの 例を参照してください。

README ファイル・エディター

README ファイル・エディターは *.readme タイプのファイル用のデフォルトのエディターです。 拡張子 .readme を持つファイルを作成し、それをダブルクリックして開くか、 またはポップアップ・メニューを表示して開き、 「アプリケーションから開く (Open With)」を選択し、それから サブメニューの「README ファイル・エディター (Readme File Editor)」を選択します。 鉛筆付きのアイコンとしてエディターが表示されることに注意してください。 これは *.readme タイプのファイルのデフォルトとして、README ツールが使用するエディターです。

README エディターのアクション

次に、特定のエディターにのみ適用できるアクションの例を説明します。   README ファイル・エディターがフォーカスされている場合は、 4 つの追加のツールバー・ボタン、 「README エディター拡張子の実行 (Run Readme Editor Extension)」、 「README エディター・アクション 1 (Readme Editor Action 1)」、 「README エディター・アクション 2 (Readme Editor Action 2)」、 「README エディター・アクション 3 (Readme Editor Action 3)」が表示されます。

README ファイル・エディターがフォーカスされている場合は、 README という名前のプルダウン・メニューが表示されます。   これには、前述のアクション、 「README エディター・アクション 1 (Readme Editor Action 1)」、 「README エディター・アクション 2 (Readme Editor Action 2)」、 「README エディター・アクション 3 (Readme Editor Action 3)」が含まれます。

README セクション・ビュー

この「README セクション (Readme Sections)」ビューを参照するには、 「パースペクティブ (Perspective)」メニューから、 「ビューの表示 (Show View)」を選択し、それからサブメニューの「その他...(Other...)」を選択します。   「README (Readme)」項目を展開し、それから「README セクション (Readme Sections)」を選択します。   これにより、「ナビゲーター (Navigator)」ビューで .readme ファイルを選択すると、 現行の *.readme ファイルのセクションのリストが表示されます。   「アウトライン (Outline)」ビューでも *.readme ファイルの構造を参照できます。

拡張子 .readme を持つファイルは、それぞれのセクションが番号で始まる場合に、 セクションに分けることができます。   たとえば、次のテキストが README ファイル・エディターに入力されると、 README ツールは 2 セクションを検出します。   セクションが README ファイル内で検出される方法を調べるには、 README ファイル・エディターに何かのテキストを入力し、 CTRL-S をタイプするかまたは 「ファイル (File)」->「保管 (Save)」 を選択してファイルを保管します。 「README セクション (Readme Sections)」ビュー を開き、 「ナビゲーター (Navigator)」ビューで .readme ファイルを選択します。

テキスト例:

99.1 第 1 セクション
第 1 セクションのテキストです。

99.1.1 これはサブセクションです
これはサブセクションのテキストです。

ドラッグ・アンド・ドロップ

ドラッグ・アンド・ドロップ機能は、 「アウトライン (Outline)」ビューでセクションを選択し、 選択したものをテキスト・ファイルの上にドラッグすると表示されます。選択の内容は ファイルに付加されています。

ヘルプ

README ツール例は、提供する拡張子、すなわちビュー、さまざまなアクションおよび ウィザード・ページのすべてについての コンテキスト・ヘルプを使用およびインプリメントする方法を説明します。 アクションについてコンテキスト・ヘルプを入手するには、 メニュー項目上に移動し、 しかしそれを選択せず、それから F1 キーをヒットします。 また、コンテキスト依存 (F1) ヘルプを「README セクション (Readme Sections)」ビュー と「例作成ウィザード (Example Creation Wizards)」ページで (新しいウィザードで) 表示できます。
 

詳細

README ツール例は 1 つの拡張ポイントを宣言し、 多くの拡張子を提供します。   提供される拡張子は、ワークベンチによって宣言された多くの興味のある拡張ポイント を活用するので、ワークベンチが機能する方法を理解する際に非常に包括的です。   この例に含まれる提供されている拡張子は、 ビューおよびビュー・アクション、 設定ページ、プロパティー・ページ、ウィザード、エディター、 およびエディター・アクション、ポップアップ・メニュー、 アクション・セット、ヘルプ、ヘルプ・テキストおよびドロップ・アクションです。

この例は、プラグインで宣言された拡張ポイントも提供します。 この例が定義している org.eclipse.ui.examples.readmetool.sectionParser 拡張子を使用する すべてのプラグインで、IReadmeFileParser クラスが必要です。 DefaultSectionParser クラスは IReadmeFileParser のインプリメンテーション例です。

ReadmeEditor クラスは IEditorPart をインプリメントし、 org.eclipse.ui.editors 拡張ポイントを使用する plugin.xml 内で、 拡張子 .readme を持つファイルのエディターとして定義されます。 ReadmeSectionsView クラスは IViewPart をインプリメントし、 org.eclipse.ui.views 拡張ポイントを使用するビューとして定義されます。この 拡張ポイントは、ビュー選択で使用するためにビューのカテゴリーも定義します。

設定の 2 つのタイプ、 ワークベンチ設定とリソース・プロパティーがこの例で定義されます。 ワークベンチ設定は IWorkbenchPreferencePage をインプリメントする ReadmePreferencePage クラスで定義されるので、 それが「ワークベンチ (Workbench)」->「設定 (Preferences)」ダイアログに追加されます。 クラスは、plugin.xml の拡張ポイント org.eclipse.ui.preferencePages に定義されます。 ReadmeFilePropertyPage と ReadmeFilePropertyPage2 の 2 つのリソース・プロパティー・ページはともに、 IWorkbenchPropertyPage をインプリメントします。 それらは、ともに org.eclipse.ui.propertyPages 拡張ポイントの plugin.xml で、objectClass タグによって IFile タイプで呼び出されるように定義されます。

ReadmeCreationWizard クラスは INewWizard をインプリメントし、 plugin.xml 内の org.eclipse.ui.newWizards 拡張ポイントに定義されます。この拡張ポイントは ユーザーが 「ファイル (File)」->「新規 (New)」->「その他....(Other....)」を選択すると ウィザードが表示されるカテゴリーを定義します。

幾つかのアクション・スタブが この例に追加されます。アクション・セットは、 拡張ポイント org.eclipse.ui.actionSets を使用して、 ワークベンチ・ウィンドウ・メニュー・バーに組み込まれる、 「README ファイル・エディター (Readme File Editor)」 というラベルを持つメニューを宣言します。 また、toolbarPath および menubarPath タグを使用して、 ワークベンチ・ツールバーとメニュー・バーのアクションも定義します。 IWorkbenchWindowActionDelegate をインプリメントする、 WindowActionDelegate クラスを使用して、 アクションをインプリメントします。 ポップアップ・メニューのアクションは、   org.eclipse.ui.popupMenus 拡張ポイントに、 PopupMenuActionDelegate クラスによって objectContribution として定義されます 。 PopupMenuActionDelegate は IObjectActionDelegate をインプリメントし、 メッセージ・ダイアログ開くために提供されている IWorkbenchPart を使用します。 ViewActionDelegate ビュー・アクションは org.eclipse.ui.viewActions 拡張ポイントに定義され、 IViewActionDelegate をインプリメントします。表示されたビューは、 targetID タグによって定義されます。この例では org.eclipse.ui.views.ResourceNavigator です。 エディター・アクションは EditorActionDelegate クラスで定義されます。 このクラスは IEditorActionDelegate をインプリメントし、 org.eclipse.ui.editorActions 拡張ポイントを使用して追加されます。 適用されるエディターは targetID タグによって定義されます。 この例では org.eclipse.ui.examples.readmetool.ReadmeEditor に定義されます。

ReadmeDropActionDelegate クラスは IDropDelegate をインプリメントします。IDropDelegates は ワークベンチで実行されたドロップ・アクションがある場合は必ず通知されます。このアクションの 拡張ポイントは org.eclipse.ui.dropActions です。

Copyright IBM Corp. 2000, 2001.  All Rights Reserved.