スキーマ定義ページ

このページについて

このフォーム・ページを使用して、編集済みスキーマの文法を構成するスキーマ・オブジェクトの構造およびプロパティーを編集できます。

スキーマ・オブジェクトの構造は、拡張ポイント要素セクションで 編集されます。 このセクションは、エディター領域の左上部を占めます。

スキーマ・オブジェクトのプロパティーは、<schema-object> の詳細セクションで 編集されます。 このセクションは、拡張ポイント要素セクションで選択したスキーマ要素のタイプによって、エディター領域の右上部でアクティブになります。

ページ・セクション

このページは、次のセクションで構成されています。

拡張ポイント要素セクション

このセクションでは、以下を実行できます。

このセクションは「スキーマ定義 (Schema Definition)」フォーム・ページから直接アクセスできます。

拡張ポイント要素セクションのフィールド

「拡張ポイント要素ビューアー (extension point element viewer)」フィールドを使用して、以下を実行できます。

このビューアーには、以下のノードが含まれています。

要素:

コンポジター:

属性:

例: 拡張要素 は、1 つ以上のショートカット要素 のシーケンスが正式な子として許可されることを指定します。 要素参照 を使用して、ショートカット要素 を表します。 シーケンス・コンポジター を使用して、要素 のシーケンスを表します。

拡張ポイント要素セクション 2

例: ショートカット要素 は、説明要素またはカテゴリー要素のいずれかが正式な子として許可されることを指定します。 要素参照 を使用して、説明要素 およびカテゴリー要素 を表します。 選択コンポジター を使用して、要素 の選択項目を表します。

拡張ポイント要素セクション 1

拡張ポイント要素セクションのアクション

「要素の追加」ボタンをクリックして、新規のグローバル要素宣言を拡張ポイント・スキーマ文法に 追加します。 このアクションは、任意のノードが選択されている場合に使用可能です。 注: 要素宣言の順序は重要ではありません。

「属性の追加」ボタンをクリックして、新規のローカル属性宣言を拡張ポイント・スキーマ文法の選択済み要素に追加します。 このアクションは、拡張要素 ノードを除く、すべての選択済み要素 ノードに使用可能です。 拡張要素 ノードは常に同じ属性を持ちます。すなわち、ID、名前、ポイントです。 注: 属性宣言の順序は重要ではありません。

拡張ポイント・スキーマ文法からスキーマ・オブジェクトを削除するには、選択したノードを右クリックして「削除」を選択します。 このアクションは、拡張要素 ノードを除いて、 すべての選択済みノードに使用可能です。 共有しないスキーマの場合、拡張要素 ノードは特殊なルート要素で、編集済みスキーマの文法へ のエントリー・ポイントの定義に使用されます。 プラグインのマニフェスト・エディターに定義されたあらゆる拡張は、「拡張」の親要素を使用して、XML 関連のマークアップを指定する必要があります。

要素の子を、拡張ポイント・スキーマ文法の他の要素のシーケンスまたは選択項目で構成するように指定するには、以下を実行します。

  1. 親要素として指定したい要素 ノードを選択し、 右クリックします。
  2. 「新規」 > 「コンポジター」 > 「シーケンス」を選択し、要素のシーケンスを定義します。 「新規」 > 「コンポジター」 > 「選択」を選択し、要素の選択項目を定義します。
  3. 新規のコンポジター・ノードを選択し、右クリックします。
  4. 「新規」 > 「参照」サブメニューから、親要素の子 として指定したい要素を選択します。 「参照」サブメニューには、拡張ポイント・スキーマ文法で グローバルに宣言されたすべての要素が入力されています。
  5. ステップ (3) および (4) を繰り返して、追加の子要素を指定します。 シーケンス・コンポジターを指定した場合、 追加要素をそのシーケンスで指定することを意味します。 選択コンポジターを指定した場合、 要素の追加選択項目を指定することを意味します。

注: 要素を他の要素の子として指定する場合、 中間のシーケンス・コンポジターまたは選択コンポジターは常に親要素によって使用されなければなりません。コンポジター・ノードは接続ノードです。 一方、要素参照 ノードはリーフ・ノードです。そのため、コンポジター・ノードは、常に少なくとも 1 つの子要素参照 ノードを指定する必要があります。

注: シーケンス・コンポジターおよび選択コンポジターは、より複雑な文法を作成するために、回数に制限なくネストすることができます。

注: 文法には、自己参照サイクルを含めることはできません。 要素 A が要素 B を子として必要とし、要素 B が要素 A を子として必要とする場合に、禁止されているサイクルの最も基本的な書式が発生してしまいます。

要素が子を持たず、開始および終了 XML タグの間にテキストを使用できるように指定する (文字コンテンツ) には、属性、コンポジターおよび要素参照を要素 (要素コンテンツ) に追加せずに、要素の構造を単純にそのままにしておきます。 注: 要素は、文字コンテンツおよび要素コンテンツの 混合コンテンツを指定できません。

説明セクション

このセクションで、編集済みスキーマの文法内の任意の要素 、属性またはコンポジターに対して簡単な説明を提供できます。

このセクションは「スキーマ定義 (Schema Definition)」フォーム・ページから直接アクセスできます。

説明セクション

説明セクションのフィールド

説明テキストのフィールドを編集して、 拡張ポイント要素セクションで選択済みの現在の要素、属性 またはコンポジターのノードの簡単な説明を提供します。 有効な HTML マークアップを、必要に応じてこのフィールド内で使用できます。

注: 要素参照説明を更新すると、参照先のグローバル 要素宣言の説明も更新されます。その逆も同じです。

要素の詳細セクション

このセクションでは、要素のプロパティーを編集できます。 要素には 2 種類あります。拡張要素と非拡張要素です。 拡張要素は特殊なルート要素宣言で、編集済みスキーマの文法へ のエントリー・ポイントの定義に使用されます。 非拡張要素はグローバル要素宣言で、編集済みスキーマの文法内で基本的な構造ビルディング・ブロックとして使用されます。

このセクションは、拡張要素 ノードまたは非拡張要素 ノードの いずれかを拡張ポイント要素セクションで選択することによって、アクティブになります。

拡張要素の要素の詳細セクション。

要素の詳細セクション 1

非拡張要素の要素の詳細セクション。

要素の詳細セクション 2

要素の詳細セクションのフィールド

要素名を指定するには、「名前」フィールドを編集します。

要素が内部要素であるかどうかを示すには、「内部」フィールド内の「true」ボタンまたは 「false」ボタンのいずれかをクリックします。 プラグインのマニフェスト・エディターは、内部拡張 XML マークアップに警告のフラグを立てます (デフォルト)。 このフィールドは、エクスポートされるパッケージの x-internal 属性に類似しています。

「true」ボタンまたは 「false」ボタンのいずれかを 「非推奨」フィールドでクリックして、要素が推奨されるか、推奨されないかを示します。プラグインのマニフェスト・エディターは、推奨されない拡張 XML マークアップに警告のフラグを立てます (デフォルト)。 このフィールドは、Java の Javadoc @deprecated タグと似ています。

拡張要素が非推奨としてマークされた場合、「置換」フィールドを編集して、同じ機能を実現できるようにユーザーがその場所で使用する非推奨でない拡張ポイントを指定します。

「ラベルのプロパティー」フィールドで、要素の定義済み属性を 1 つ選択し、プラグインのマニフェスト・エディターで要素のラベルとして使用する属性値を指定します。 例えば、ある値が選択された場合、プラグインのマニフェスト・エディターの 「拡張」 ページにある「すべての拡張」セクションの要素のノード・ラベルは、selected-attribute-value (element-name) となります。 一方、値が選択されていない場合、要素のノード・ラベルは、(element-name) となります。

「アイコン」フィールドで、 要素の定義済みリソース・タイプ属性を 1 つ選択し、プラグインのマニフェスト・エディターで要素のノードを表すために 使用するアイコン・リソースを指定します。 プラグインのマニフェスト・エディターの「拡張」ページにある「すべての拡張」セクションに要素の ノード・アイコンを正しく表示するには、以下の条件を満たす必要があります。

「true」ボタンまたは 「false」ボタンのいずれかを 「翻訳可能」フィールドでクリックして、要素の文字コンテンツが翻訳可能か、可能でないかを示します。このフィールドは、指定された子 (要素コンテンツ) または属性を持たない要素で、開始および終了 XML タグ内にテキストを指定できる (文字コンテンツ) 要素にのみ適用可能です。 要素の文字コンテンツが翻訳可能としてマークされている場合、コントリビュートされた拡張 XML マークアップで PDE ツールを使用して、コンテンツをプロパティー・ファイルに外部化して、複数言語サポートを可能にすることができます。

読み取り専用の「DTD 近似値」フィールドを使用して、要素スキーマ文法について、同等の要素 DTD 文法への概算の 1 対 1 マッピングを表示できます。DTD (文書タイプ定義) は、XML 文書の正式な文法を指定する場合に XML スキーマの代用になる手法で、強力ではありませんが読みやすい手法です。 以下の表記を使用して、DTD 近似値を指定します。

コンポジターの詳細セクション

このセクションでは、コンポジターのプロパティーを編集できます。 コンポジターには 2 種類あります。シーケンス・コンポジターと選択コンポジターです。 シーケンス・コンポジターを使用すると、編集済みスキーマ文法で他の要素のシーケンスから要素の子を構成するように指定できます。 選択コンポジターを使用すると、編集済みスキーマ文法で他の要素の選択項目から要素の子を構成するように指定できます。

このセクションは、「シーケンス」ノードまたは「選択」ノードのいずれかを拡張ポイント要素セクションで選択することによって、アクティブになります。

コンポジターの詳細セクション

コンポジターの詳細セクションのフィールド

「最小発生数」フィールドを編集して、他の要素から成るこのコンポジターや複数のコンポジターを、コントリビュートされた拡張 XML マークアップで表示できる最小回数を指定します。このフィールドの値は PDE が使用し、プラグインのマニフェスト・エディター内の多重度の制約を検証します。 要素 A には、その子として要素 B または要素 C の一方のみが必要である場合に、選択コンポジターを使用して最低 2 回の発生回数を指定すると、これが有効になるためには、コントリビュートされた拡張 XML マークアップに、要素 B と要素 C の組み合わせとなるような 2 つのインスタンスを定義する必要があります。

「最大発生数」フィールドを編集して、他の要素から成るこのコンポジターや複数のコンポジターを、コントリビュートされた拡張 XML マークアップで表示できる最大回数を指定します。このフィールドの値は PDE が使用し、プラグインのマニフェスト・エディター内の多重度の制約を検証します。 要素 A には、その子として要素 B または要素 C の一方のみが必要である場合に、選択コンポジターを使用して最大 2 回の発生回数を指定すると、これが有効になるためには、コントリビュートされた拡張 XML マークアップに、要素 B と要素 C の組み合わせとなるような 2 つ以内のインスタンスを定義することができます。

「アンバウンド」フィールドをチェックして、 コントリビュートされた拡張 XML マークアップにこのコンポジターが表示される最大回数に制約を設けないように指定します。

「タイプ」フィールドで値を選択し、このコンポジターについて「シーケンス」または「選択」のいずれかを指定します。

読み取り専用の「DTD 近似値」フィールドを使用して、コンポジター・スキーマ文法について、同等のコンポジター DTD 文法への概算の 1 対 1 マッピングを表示できます。DTD 近似値の指定に使用する表記は、この文書中の項目『要素の詳細セクションのフィールド』で説明しています。

要素参照の詳細セクション

このセクションでは、要素参照のプロパティーを編集できます。 要素参照は、編集済みスキーマの文法内でのグローバル要素宣言に対する参照です。要素参照は、アトミック・ビルディング・ブロックとしてコンポジターが使用し、グローバル要素宣言の文法を定義します。

このセクションは、要素参照ノードを拡張ポイント要素セクションで選択することによって、アクティブになります。

要素参照の詳細セクション

要素参照の詳細セクションのフィールド

「最小発生数」フィールドを編集して、コントリビュートされた拡張 XML マークアップでこの要素を表示する最小回数を指定します。このフィールドの値は PDE が使用し、プラグインのマニフェスト・エディター内の多重度の制約を検証します。 要素 A で最小回数 2 を指定した場合、要素 A の 2 インスタンスが有効になるように、コントリビュートされた拡張 XML マークアップに定義する必要があります。

「最大発生数」フィールドを編集して、コントリビュートされた拡張 XML マークアップでこの要素を表示する最大回数を指定します。このフィールドの値は PDE が使用し、プラグインのマニフェスト・エディター内の多重度の制約を検証します。 要素 A で最大回数 2 を指定した場合、2 以内の要素 A のインスタンスが有効になるように、コントリビュートされた拡張 XML マークアップに定義できます。

「アンバウンド」フィールドをチェックして、 コントリビュートされた拡張 XML マークアップにこの要素が表示される最大回数に制約を設けないように指定します。

読み取り専用の「DTD 近似値」フィールドを使用して、要素スキーマ文法について、同等の要素 DTD 文法への概算の 1 対 1 マッピングを表示できます。DTD 近似値の指定に使用する表記は、この文書中の項目『要素の詳細セクションのフィールド』で説明しています。

要素参照の詳細セクションのアクション

「参照」フィールド内の element-name ハイパーリンクをクリックし、このローカル要素参照が参照しているグローバル要素宣言のプロパティーを編集します。このアクションが完了したら、参照された要素 ノードが拡張ポイント要素セクションで選択され、対応する要素の詳細セクションがアクティブになります。

属性の詳細セクション

このセクションでは、属性のプロパティーを編集できます。 属性を使用して、要素の追加情報を提供します。

このセクションは、必須属性、 オプション属性、クラス属性 またはリソース属性 のノードのいずれかを、拡張ポイント要素セクションで選択することによってアクティブになります。

列挙の制約を指定する「文字列」タイプの 必須属性に関する属性の詳細セクション。

属性の詳細セクション 1

デフォルト値を指定する「論理型」タイプのオプションの属性に関する属性の詳細セクション。

属性の詳細セクション 2

クラス属性の属性の詳細セクション。属性値によって表されるクラスが、指定のクラスを拡張したり、指定のインターフェースを実装したりする必要があることを示します。

属性の詳細セクション 3

リソース属性の属性の詳細セクション。

属性の詳細セクション 4

スキーマ ID 属性の使用

拡張ポイントの作成者は、他の属性を参照する属性を定義することができます。 これは、拡張ポイント属性を型 ID として設定し、それが参照する属性を選択することによって行えます。 org.eclipse.ui.handlers 拡張ポイントはその一例です。 コマンド属性は、org.eclipse.ui.commands 拡張ポイントで定義されているコマンドを参照します。

スキーマ ID の使用

ハンドラーを提供する拡張開発者は、commandId 属性について有効なすべての ID から選択することができます。 ID のミススペルというよくある間違いを防止するために、存在していない ID については警告が発行されます。

属性の詳細セクションのフィールド

属性名を指定するには、「名前」フィールドを編集します。

「true」ボタンまたは 「false」ボタンのいずれかを 「非推奨」フィールドでクリックして、属性が推奨されるか、推奨されないかを示します。プラグインのマニフェスト・エディターは、推奨されない拡張 XML マークアップに警告のフラグを立てます (デフォルト)。 このフィールドは、Java の Javadoc @deprecated タグと似ています。

「用途」フィールドで値を選択し、コントリビュートされた拡張 XML マークアップ内の定義要素に属性を指定する必要があるかどうかを示します。 以下が選択可能です。

「デフォルト値」フィールドを編集し、コントリビュートされた拡張 XML マークアップ内の定義要素に属性が指定されていない場合に、この属性にデフォルト値を指定します。このフィールドは、「用途」フィールドで「デフォルト」が選択されている場合にのみ適用可能です。

「タイプ」フィールドで値を選択し、属性値タイプを指定します。 以下が選択可能です。

「true」ボタンまたは 「false」ボタンのいずれかを 「翻訳可能」フィールドでクリックして、属性の値が翻訳可能か、可能でないかを示します。このフィールドは、「タイプ」フィールドで「文字列」値が選択されている場合にのみ適用可能です。属性の値が翻訳可能としてマークされている場合、コントリビュートされた拡張 XML マークアップで PDE ツールを使用して、これらの値をプロパティー・ファイルに外部化して、複数言語サポートを可能にすることができます。

「制限事項」フィールドを使用して、属性値が値として使用する際に制約される文字列のリストを表示できます。フィールドに値が含まれていない場合、 属性値に制限事項はありません。 このフィールドは、「タイプ」フィールドで「文字列」値が選択されている場合にのみ適用可能です。 注: 文字列の基本タイプに関する列挙制限は、 編集済みスキーマの文法で、この機能を実現するために使用されます。

「拡張」フィールドを編集し、ターゲット・プラットフォームのクラスパスに対して完全修飾クラス名を指定します (org.eclipse.ui.part.EditorPart など)。これは、属性値として指定されたクラスによってサブクラス化されていなければなりません。PDE は、コントリビュートされた拡張 XML マークアップのクラス属性値を検証し、スーパー・クラスを拡張していることを確認します。 このフィールドは、「タイプ」フィールドで「Java」値が選択されている場合にのみ適用可能です。

「実装」フィールドを編集し、ターゲット・プラットフォームのクラスパスに対して完全修飾インターフェース名を指定します (org.eclipse.ui.IEditorPart など)。これは、属性値として指定されたクラスによって実装されていなければなりません。PDE は、コントリビュートされた拡張 XML マークアップのクラス属性値を検証し、インターフェースを実装していることを確認します。 このフィールドは、「タイプ」フィールドで「Java」値が選択されている場合にのみ適用可能です。

属性の詳細セクションのアクション

「制限事項」フィールドの「追加...」ボタン をクリックし、属性値に新規の制限事項を追加するために「新規制限事項」ダイアログを開きます。ダイアログが完了したら、属性が値としての使用を制限されている文字列の値のリストに新規制限事項が追加されます。このアクションは、「タイプ」フィールドで「文字列」値が選択されている場合にのみ使用可能です。

「制限事項」フィールド内の文字列の値を選択し、「削除」ボタンをクリックして、属性が値としての使用を制限されている文字列の値のリストから制限事項を削除します。このアクションは、「タイプ」フィールドで「文字列」値が選択されている場合にのみ使用可能です。

「拡張」フィールドに指定されている値が、 ターゲット・プラットフォームのクラスパスの完全修飾クラス名を参照している場合、「拡張」ハイパーリンクをクリックすると、新規の Java ソース・エディターでそのクラスが開きます。そうでない場合は、「拡張」ハイパーリンクをクリックすると 「新規 Java クラス」ウィザードが開き、 新規クラスの作成が可能になります。 このアクションは、「タイプ」フィールドで「Java」値が選択されている場合にのみ使用可能です。

「実装」フィールドに指定されている値が、 ターゲット・プラットフォームのクラスパスの完全修飾インターフェース名を参照している場合、「実装」ハイパーリンクをクリックすると、新規の Java ソース・エディターでそのインターフェースが開きます。そうでない場合は、「実装」ハイパーリンクをクリックすると 「新規 Java クラス」ウィザードが開き、 新規インターフェースの作成が可能になります。 このアクションは、「タイプ」フィールドで「Java」値が選択されている場合にのみ使用可能です。

「参照...」ボタンをクリックし、「型の選択」ダイアログを開いて、ターゲット・プラットフォームのクラスパスの既存クラスを選択し、「拡張」フィールドの値として使用します。 このアクションは、「タイプ」フィールドで「Java」値が選択されている場合にのみ使用可能です。

「参照...」ボタンをクリックし、「型の選択」ダイアログを開いて、ターゲット・プラットフォームのクラスパスの既存インターフェースを選択し、「実装」フィールドの値として使用します。 このアクションは、「タイプ」フィールドで「Java」値が選択されている場合にのみ使用可能です。

関連リンク