ビュー
識別子:
org.eclipse.ui.views
説明:
この拡張ポイントを使用して、ワークベンチの追加ビューを定義できます。 ビューは、ワークベンチ・ページ内のビジュアル・コンポーネントです。 一般にビューは、情報の階層 (ワークスペースなど) をナビゲートし、エディターを開いたり、アクティブなエディターのプロパティーを表示するために使用されます。 ユーザーは、「ウィンドウ」>「ビューの表示」メニューからビューを可視にしたり、ビューのローカル・タイトル・バーからビューを閉じたりすることができます。
「ビューの表示」ダイアログにおけるビジュアル・クラッターを減らすため、ビューはカテゴリーを用いてグループ化するとよいでしょう。
構成マークアップ:
<!ELEMENT extension (category | view | stickyView)*>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - ターゲット拡張ポイントの完全修飾 ID。
- id - 拡張インスタンスの ID (オプション)。
- name - 拡張インスタンスの名前 (オプション)。
<!ELEMENT category EMPTY>
<!ATTLIST category
id CDATA #REQUIRED
name CDATA #REQUIRED
parentCategory CDATA #IMPLIED>
- id - このカテゴリーの識別に使用する固有名。
- name - このカテゴリーの UI に使用される変換可能な名前。
- parentCategory - '/' で区切られたカテゴリー ID から構成されるパス (オプション)。 これにより、カテゴリーの階層を作成できます。
< !ELEMENT view (description?)>
<!ATTLIST view
id CDATA #REQUIRED
name CDATA #REQUIRED
category CDATA #IMPLIED
class CDATA #REQUIRED
icon CDATA #IMPLIED
fastViewWidthRatio CDATA #IMPLIED
allowMultiple (true | false) >
- id - このビューの識別に使用する固有名。
- name - このビューの UI に使用される変換可能な名前。
- category - '/' で区切られたカテゴリー ID から構成される属性 (オプション)。 参照されている各カテゴリーは、対応する category 要素で宣言する必要があります。
- class - org.eclipse.ui.IViewPart を実装するクラスの完全修飾名。 デフォルトの機能を継承するには、org.eclipse.ui.part.ViewPart
をサブクラス化することが一般的な方法です。
- icon - このビューに関連付けられたアイコンの相対名
- fastViewWidthRatio - ビューがアクティブ高速ビューとして使用するワークベンチの幅のパーセンテージ。これは、0.05 から 0.95 の値を持つ浮動小数点値として定義されなければなりません。値が指定されない場合、デフォルトの比率が使用されます。
- allowMultiple - このビューで IWorkbenchPage.showView(String id, String secondaryId) を使用して、複数インスタンスを作成できるかどうかを示すフラグ。 デフォルトは false です。
<!ELEMENT description (#PCDATA)>
ビューの簡略説明テキストを本文に含むサブ要素 (オプション)。
<!ELEMENT stickyView EMPTY>
<!ATTLIST stickyView
id CDATA #REQUIRED
location (RIGHT|LEFT|TOP|BOTTOM)
closeable (true | false)
moveable (true | false) >
スティッキー・ビューとは、ウィンドウが開くと、ウィンドウ内のすべてのパースペクティブにデフォルトで表示されるビューのことです。 このビューの初期の配置は、ロケーション属性によって決定されますが、ユーザーは、ビューを移動したり、閉じることができます。 この要素を使用すると、ビューのプレースホルダーが作成されます。このプレースホルダーにビューは表示されません。 この要素を使用する場合は、注意が必要です。この要素は、パースペクティブ間で有効にする必要がある場合にのみビューに適用する必要があります。
3.0 以降
- id - スティッキーにするビューの ID。
- location - エディター・エリアに対して相対的なスティッキー・ビューのロケーションを指定する属性 (オプション)。 欠落している場合、ビューはエディター・エリアの右にドッキングされます。
- closeable - ビューを閉じることができるようにするかどうかを指定する属性 (オプション)。 欠落している場合は、ビューを閉じることができます。
- moveable - ビューを移動可能にするかどうかを指定する属性 (オプション)。 欠落している場合は、ビューを移動できます。
例:
この拡張ポイントの例を以下に示します。
<extension point=
"org.eclipse.ui.views"
>
<category
id=
"com.xyz.views.XYZviews"
name=
"XYZ"
/>
<view
id=
"com.xyz.views.XYZView"
name=
"XYZ View"
category=
"com.xyz.views.XYZviews"
class=
"com.xyz.views.XYZView"
icon=
"icons/XYZ.gif"
/>
</extension>
スティッキー・ビュー宣言の例を以下に示します。
<extension point=
"org.eclipse.ui.views"
>
<stickyView
id=
"com.xyz.views.XYZView"
/>
</extension>
API 情報:
class 属性の値は、
org.eclipse.ui.IViewPart を実装するクラスの完全修飾名でなければなりません。 新規ビューを開発する場合は、org.eclipse.ui.part.ViewPart をサブクラス化する方法が一般的です。
提供される実装:
Eclipse プラットフォームは、「ナビゲーター」、「プロパティー」、「アウトライン」、および「タスク」を含む多くの標準ビューを備えています。ユーザーの視点からは、これらのビューは、プラグインが提供するその他のビューと同じです。 すべてのビューは、「ウィンドウ」メニューの「ビューの表示」サブメニューで表示できます。 ビューの位置は永続的であり、ビューを閉じる際に保存され、単一セッションで再度開くと復元されます。 位置は、ワークベンチ・セッションが代わっても維持することができます。
Copyright (c) 2002, 2005 IBM Corporation and others.
All rights reserved.
This program and the accompanying materials are made
available under the terms of the Eclipse Public License v1.0 which accompanies
this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html