サンプル - README ツール
概要
README エディターでは、
他のプラグインによる使用のために独自の拡張ポイントを定義する方法が示されます。また、リソース・ポップアップ・メニュー入力、
新規リソース・ウィザード、拡張 (.readme) のファイル・エディター、
カスタム・ビューおよびプロパティー・ページ用に拡張を作成する方法も示されます。
サンプルの実行
このサンプルの使用を開始するには、ファイル作成ウィザードまたはサンプル作成ウィザードを使用して、
拡張子が .readme のファイルを作成します。
このサンプルにより提供される追加のビューは、
「ウィンドウ」>「ビューの表示」>「その他」を選択して README セクションを展開することにより表示できます。
ビュー・アクションは、「ナビゲーター」ビューの README アイコンをクリックすることにより表示できます。
新規 README ファイルの作成
ファイル拡張子が .readme の新規ファイルを作成します。 ファイル・メニューから「新規」を選択し、
次に、サブメニューから「その他...」を選択します。 ウィザードで「シンプル」をクリックし、
左側のリストで「ファイル」を選択します。 「次へ」をクリックして、
ファイル名 (拡張子を必ず .readme にする) およびファイルが含まれるフォルダーを指定します。
サンプル作成ウィザード
ファイル・メニューから「新規」を選択し、サブメニューから「サンプル...」を選択します。
ここで、サンプル作成ウィザードを選択します。README ファイルを選択します。「次へ」をクリックします。
ファイルが作成されるフォルダーを選択します。拡張子が .readme のファイル名を入力します。「終了」をクリックします。
README ビュー拡張アクション
「ナビゲーター」ビューで、拡張子が .readme のファイルを選択します。存在しない場合は、
その拡張子のファイルを作成します。「ナビゲーター」ビューのローカル・ツールバーに、
「README ビュー拡張の実行 (Run Readme View Extension)」という吹き出しヘルプが表示されるボタンがあります。
このボタンをクリックします。 ビュー・アクションが実行されたことを示すダイアログがポップアップします。
ポップアップ・メニュー
「ナビゲーター」ビューで、拡張子が .readme のファイルを選択します。 存在しない場合は、
その拡張子のファイルを作成します。 ファイルを選択して、
ポップアップ・メニューを表示させます。 ポップアップ・メニューに、
メニュー項目「README アクションの表示 (Show Readme Action)」があります。 このメニュー項目を選択すると、
ダイアログが開き、「ポップアップ・メニュー・アクションが実行されました (Popup Menu Action Executed)」と表示されます。
設定ページ
「ウィンドウ」メニューから、「設定」を選択します。 「README サンプル (Readme Example)」
ページをクリックします。 これにより、設定ページのサンプルが表示されます。
プロパティー・ページ
「ナビゲーター」ビューで、拡張子が .readme のファイルを選択します。 存在しない場合は、
その拡張子のファイルを作成します。 ファイルを選択して、
ポップアップ・メニューを表示させ、メニュー項目「プロパティー」を選択します。 「README ツール (Readme Tool)」
ページをクリックして、プロパティー・ページのサンプルを表示します。
README ファイル・エディター
README ファイル・エディターは、タイプが *.readme であるファイルのデフォルト・エディターです。
拡張子が .readme のファイルを作成し、そのファイルをダブルクリックするか、
ポップアップ・メニューを表示して 「アプリケーションから開く」を選択し、
サブメニューから README ファイル・エディターを選択して、そのファイルを開きます。 エディターには、
鉛筆のアイコンがあります。 これは、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 Sections)」ビュー
「README セクション (Readme Sections)」ビューを表示するには、
「ウィンドウ」メニューから「ビューの表示」を選択し、次にサブメニューから「その他...」を選択します。 README 項目を展開し、
「README セクション (Readme Sections)」を選択します。 これにより、
「ナビゲーター」ビューで .readme ファイルを選択すると、
現行の *.readme ファイルのセクションのリストが表示されます。 「アウトライン」ビューで
*.readme ファイルの構造を表示することもできます。
拡張子が .readme のファイルは、各セクションが番号で開始されている場合は、
セクションに分割することができます。 例えば、
次のテキストが README ファイル・エディターに入力された場合、README ツールにより
2 セクションが検出されます。 README ツールでのセクション検出方法を参照するため、README ファイル・エディターに
いくつかのテキストを入力し、CTRL-S を入力するか、 「ファイル」>「保管」を選択して、
ファイルを保管します。「README セクション (Readme Sections)」ビューを開き、
「ナビゲーター」ビューで、.readme ファイルを選択します。
サンプル・テキスト:
99.1 これは最初のセクションです
これは最初のセクションのテキストです。
99.1.1 これはサブセクションです
これはサブセクションのテキストです。
ドラッグ・アンド・ドロップ
ドラッグ・アンド・ドロップ機能は、「アウトライン」ビューでセクションを選択し、
選択したセクションをテキスト・ファイルの上部にドラッグすることにより実行されます。選択したセクションの内容がファイルに追加されます。
ヘルプ・コントリビューション
README ツール・サンプルでは、提供されるすべての拡張におけるコンテキスト・ヘルプの使用方法および実装方法も示されます (ビュー、さまざまなアクションおよびウィザード・ページ)。 アクションについてのコンテキスト・ヘルプを表示するには、
メニュー項目上に吹き出しを表示し、それを選択せずに F1 キーを押します。 「README セクション (Readme Sections)」ビューおよび
「サンプル作成ウィザード (Example Creation Wizards)」ページ (新規ウィザードの) においても、
コンテキスト依存 (F1) ヘルプを表示することができます。
詳細
README ツール・サンプルでは、1 つの拡張ポイントを宣言し、
多くの拡張を提供します。 提供される拡張は、
ワークベンチが宣言する、より興味深い拡張ポイントを多数使用します。
したがって、これらの拡張はワークベンチ機能の理解という点で非常に包括的なものです。 このサンプルに含まれる拡張は、
ビューとビュー・アクション、設定ページ、プロパティー・ページ、
ウィザード、エディターとエディター・アクション、ポップアップ・メニュー、
アクション・セット、ヘルプ・コントリビューション、ヘルプ・コンテキスト、およびドロップ・アクションです。
このサンプルでは、プラグインで宣言される拡張ポイントも提供します。
クラス IReadmeFileParser は、
このサンプルで定義する org.eclipse.ui.examples.readmetool.sectionParser 拡張を使用するプラグインには必須です。クラス 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 で定義されます。2 つのリソース・プロパティー・ページは、IWorkbenchPropertyPage を実装する
ReadmeFilePropertyPage および ReadmeFilePropertyPage2 です。
両方とも、org.eclipse.ui.propertyPages 拡張ポイントの plugin.xml の objectClass タグによって IFile タイプで呼び出されるように定義されます。
クラス ReadmeCreationWizard は、INewWizard を実装し、plugin.xml の
org.eclipse.ui.newWizards 拡張ポイントで定義されます。この拡張ポイントでは、
ユーザーが「ファイル」->「新規」->「サンプル...」を選択したときに表示されるウィザードのカテゴリーも定義されます。
幾つかのアクション・スタブがこのサンプルに追加されます。アクション・セットは、
「README ファイル・エディター」というラベルのメニューを宣言し、拡張ポイント org.eclipse.ui.actionSets を使用して、
ワークベンチ・ウィンドウ・メニュー・バーに組み込まれます。
また、タグ 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) によって定義されます。
エディター・アクションは、IEditorActionDelegate を実装するクラス EditorActionDelegate によって定義され、org.eclipse.ui.editorActions 拡張ポイントを使用して
追加されます。適用されるエディターは、
タグ targetID (このサンプルでは org.eclipse.ui.examples.readmetool.ReadmeEditor で定義されている) によって定義されます。
クラス ReadmeDropActionDelegate は IDropDelegate を実装します。IDropDelegates は、
ワークベンチでドロップ・アクションが実行されるごとに通知されます。
このアクションの拡張ポイントは org.eclipse.ui.dropActions です。