コマンド

org.eclipse.ui.commands

2.1

org.eclipse.ui.commands 拡張ポイントは、command および category エレメントを使用して コマンド、およびコマンド・カテゴリーを宣言するために使用されます。 また、この拡張ポイントを使用すると、keyBinding エレメントを使用してコマンドにキー・シーケンスを割り当てることもできます。 キー・シーケンスは、ここで同様に宣言されるキー構成およびコンテキストに基づいてコマンドにバインドされます。 宣言には、keyConfiguration および context エレメントを使用します。

<!ELEMENT extension (activeKeyConfiguration , category , command , keyBinding , keyConfiguration , context)>

<!ATTLIST extension

id    CDATA #IMPLIED

name  CDATA #IMPLIED

point CDATA #REQUIRED>


<!ELEMENT activeKeyConfiguration EMPTY>

<!ATTLIST activeKeyConfiguration

value              CDATA #IMPLIED

keyConfigurationId CDATA #IMPLIED>

このエレメントは、Eclipse の初期アクティブ・キー構成を定義するために使用されます。 これらのエレメントが複数存在する場合、(プラグイン・レジストリーの読み取り順序で) 最後に宣言されたエレメントのみが有効であると考えられます。



<!ELEMENT category EMPTY>

<!ATTLIST category

description CDATA #IMPLIED

id          CDATA #REQUIRED

name        CDATA #REQUIRED>

UI ではコマンドをより管理しやすくするため、コマンドをカテゴリー別に編成する場合がよくあります。 このエレメントはこのようなカテゴリーを定義するために使用されます。 複数のコマンドは多くとも 1 つのカテゴリーに追加することができます。 同じ id 属性を持つエレメントが複数存在する場合、(プラグイン・レジストリーの読み取り順序で) 最後に宣言されたエレメントのみが有効であると考えられます。



<!ELEMENT command EMPTY>

<!ATTLIST command

category    CDATA #IMPLIED

description CDATA #IMPLIED

id          CDATA #REQUIRED

name        CDATA #REQUIRED

categoryId  CDATA #IMPLIED>

このエレメントは、コマンドを定義する場合に使用します。 コマンドは、アクションによって扱うことができるユーザーからの要求を表します。 また、コマンドは他のコマンドの中で内容的に固有でなければなりません。 同じ意味を持つコマンドが既に定義されている場合は、コマンドを定義しないでください。 同じ id 属性を持つエレメントが複数存在する場合、(プラグイン・レジストリーの読み取り順序で) 最後に宣言されたエレメントのみが有効であると考えられます。 アクションがコマンドに接続される方法については、拡張ポイント org.eclipse.ui.actionSets and org.eclipse.ui.editorActions を参照してください。



<!ELEMENT keyBinding EMPTY>

<!ATTLIST keyBinding

configuration      CDATA #IMPLIED

command            CDATA #IMPLIED

locale             CDATA #IMPLIED

platform           CDATA #IMPLIED

contextId          CDATA #IMPLIED

string             CDATA #IMPLIED

scope              CDATA #IMPLIED

keyConfigurationId CDATA #IMPLIED

commandId          CDATA #IMPLIED

keySequence        CDATA #IMPLIED>

このエレメントにより、キー・シーケンスをコマンドに割り当てることができます。



<!ELEMENT keyConfiguration EMPTY>

<!ATTLIST keyConfiguration

description CDATA #IMPLIED

id          CDATA #REQUIRED

name        CDATA #REQUIRED

parent      CDATA #IMPLIED

parentId    CDATA #IMPLIED>

このエレメントは、キー構成を定義するために使用されます。 同じ id 属性を持つエレメントが複数存在する場合、(プラグイン・レジストリーの読み取り順序で) 最後に宣言されたエレメントのみが有効であると考えられます。



<!ELEMENT context EMPTY>

<!ATTLIST context

description CDATA #IMPLIED

id          CDATA #REQUIRED

name        CDATA #REQUIRED

parent      CDATA #IMPLIED

parentId    CDATA #IMPLIED>

このエレメントは、コンテキストを定義する場合に使用します。 同じ id 属性を持つエレメントが複数存在する場合、(プラグイン・レジストリーの読み取り順序で) 最後に宣言されたエレメントのみが有効であると考えられます。



<!ELEMENT handlerSubmission EMPTY>

<!ATTLIST handlerSubmission

commandId CDATA #REQUIRED

handler   CDATA #REQUIRED>

このエレメントでは、コマンドのハンドラーを宣言します。 このハンドラーは、所定の制限と共にコマンドに関連付けられます。 この関連付けは、始動時に行われます。 ハンドラーを関連付けても、ワークベンチで常にこのハンドラーが選択されるわけではありません。 実際は、ワークベンチの状態を検査し、さまざまなハンドラー・サブミットを比較することによって選択が行われます。

この特定の API は試験用のものです。 この API を使用する場合は、将来この API が大幅に変更されるか、または完全に除去される可能性があることを理解する必要があります。 この API について、platform-ui-dev@eclipse.org までフィードバックをお寄せください。



<!ELEMENT scope EMPTY>

<!ATTLIST scope

description CDATA #IMPLIED

id          CDATA #REQUIRED

name        CDATA #REQUIRED

parent      CDATA #IMPLIED>

このエレメントは、有効範囲を定義する場合に使用します。 同じ id 属性を持つエレメントが複数存在する場合、(プラグイン・レジストリーの読み取り順序で) 最後に宣言されたエレメントのみが有効であると考えられます。 使用すべきではありません。代わりに「org.eclipse.ui.contexts」拡張ポイントを使用してください。



org.eclipse.ui プラグイン中の plugin.xml ファイルは org.eclipse.ui.commands 拡張ポイントを幅広く活用します。

この拡張ポイント以外のコマンド、カテゴリー、キー・バインディング、キー構成、またはコンテキストに関する共通 API はありません。 特定のコマンドを処理するアクションの登録、 およびコンテキストを照会および設定するための共通 API は、org.eclipse.ui.IKeyBindingService にあります。