サンプル - README ツール

概要

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

サンプルの実行

このサンプルの使用を開始するには、 ファイル作成ウィザードを使用して .readme 拡張子を持つファイルを作成するか、 またはサンプル作成ウィザードを使用してサンプルを作成します。 このサンプルによって提供される追加の ビューは、「ウィンドウ」>「ビューの表示」>「その他」を選択し、 Readme セクションを展開すると表示することができます。 ビュー・アクションは、「ナビゲーター」ビューの README アイコンをクリックして表示することができます。

新しい README ファイルの作成

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

サンプル作成ウィザード

「ファイル」メニューから「新規」を選択し、サブメニューから「サンプル... 」を選択します。 ここで「サンプル作成ウィザード」を選択します。 「README ファイル」を選択します。 「次へ」をクリックします。ファイルを作成する先のフォルダーを選択します。 .readme 拡張子を持つファイルの名前を入力します。 「終了」をクリックします。

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

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

ポップアップ・メニュー

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

設定ページ

「ウィンドウ」メニューから「設定」を選択します。 「README サンプル」というページをクリックします。 これは設定ページのサンプルを示します。

プロパティー・ページ

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

README ファイル・エディター

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

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

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

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

README セクション・ビュー

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

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

テキスト・サンプル:

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

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

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

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

ヘルプ

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

詳細

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 クラスで定義されるので、 「ウィンドウ」->「設定」ダイアログに追加されます。 クラスは、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 拡張ポイントに定義されます。 この拡張ポイントは、ユーザーが「ファイル」->「新規」->「サンプル...」を選択した際にウィザードが表示されるカテゴリーも定義します。

幾つかのアクション・スタブがこのサンプルに追加されます。 アクション・セットは、拡張ポイント org.eclipse.ui.actionSets を使用して、 ワークベンチ・ウィンドウ・メニュー・バーに組み込まれる、 「README ファイル・エディター」 というラベルを持つメニューを宣言します。 また、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.