プロパティー・ページ

org.eclipse.ui.propertyPages

この拡張ポイントは、あるタイプのオブジェクト用プロパティー・ページを追加するために使用します。 定義されると、これらのプロパティー・ページは、そのタイプのオブジェクトのプロパティー・ダイアログ内に表示されます。

プロパティー・ページを使用することによって、ユーザーは分かりやすい形式で、オブジェクトのプロパティーを操作することができます。 オブジェクトのプロパティーの編集に使用可能なスペースが制限される「プロパティー」ビューとは異なり、プロパティー・ページでは、 ラベル、アイコンなどに対し、より広い範囲でかつ複雑なコントロールを定義することが可能になります。 論理的にともに使用されるプロパティーは、プロパティー・シートに分散せず、ページ内でクラスター化されていることがあります。 ただし、ほとんどのアプリケーションでは、オブジェクトのプロパティーをプロパティー・シートと プロパティー・ページの両方を使用して管理することが一般的です。

プロパティー・ページは、オブジェクトのポップアップ・メニューから 「プロパティー」メニュー項目を選択して表示されるダイアログ・ボックス内に表示されます。 オブジェクト・クラスの他に、特定のオブジェクト・タイプについてのみプロパティー・ページを登録する ために、名前フィルターもオプションで提供することができます。

これらのフィルター機構が不適切な場合、プロパティー・ページはフィルター機構を使用することができます。 この場合、ターゲット・オブジェクトの属性は、一連のキー値のペアに記述されます。 選択に対して適用される属性は、選択タイプに固有で、ワークベンチのドメインの範囲外であるため、ワークベンチは、 実際の選択に対し、このレベルにおけるフィルタリングを代行しています。

<!ELEMENT extension (page*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT page (filter* , keywordReference*)>

<!ATTLIST page

id          CDATA #REQUIRED

name        CDATA #REQUIRED

icon        CDATA #IMPLIED

objectClass CDATA #REQUIRED

class       CDATA #REQUIRED

nameFilter  CDATA #IMPLIED

adaptable   (true | false)

category    CDATA #IMPLIED>


<!ELEMENT filter EMPTY>

<!ATTLIST filter

name  CDATA #REQUIRED

value CDATA #REQUIRED>

このエレメントは、現在の選択内の各オブジェクトの属性の状態を評価するために使用されます。 選択内の各オブジェクトに指定の属性状態がある場合のみ一致。 選択内の各オブジェクトが org.eclipse.ui.IActionFilter を実装するか、それに適合している必要があります。



<!ELEMENT keywordReference EMPTY>

<!ATTLIST keywordReference

id CDATA #IMPLIED>

プロパティー・ページによるキーワードへの参照です。キーワード拡張ポイントを参照してください。



プロパティー・ページ定義の例を以下に示します。

   

<extension point=

"org.eclipse.ui.propertyPages"

>

<page id=

"com.xyz.projectPage"

name=

"XYZ Java Properties"

objectClass=

"org.eclipse.core.resources.IFile"

class=

"com.xyz.ppages.JavaPropertyPage"

nameFilter=

"*.java"

>

<filter name=

"readOnly"

value=

"true"

/>

</page>

</extension>

class 属性は、org.eclipse.ui.IWorkbenchPropertyPage を 実装するクラスの完全修飾名を指定する必要があります。

ワークベンチによって提供されているいくつかのオブジェクトには、 プロパティー・ページが登録されている場合があります。 プラグインにより、これらのオブジェクトにさらにプロパティー・ページを追加することができます。 プロパティー・ページはワークベンチ・リソースに限られません。 ワークベンチ内に表示されるすべてのオブジェクト (プラグインにより作成されたドメイン固有の オブジェクトを含む) は、プロパティー・ページを持つことができ、他のプラグインによりこれらに プロパティー・ページを登録することができます。