JSP ライブラリー定義の構成
JSP ライブラリー定義には、コンポーネント・ライブラリーに必要なプロジェクト・リソースと、JSP タグの解釈に必要なメタデータが含まれます。これは、カスタム JSP タグ・ライブラリーのこの製品への統合をカスタマイズする際に役立ちます。
始める前に
手順
JSP ライブラリー定義
「JSP ライブラリー定義 (JSP Library Definition)」エディターは、新規 JSP ライブラリーをプロジェクトに組み込む方法に関する詳細を構成するために使用されます。
このタスクについて
- ライブラリー名
- ライブラリーの名前。
- 説明
- ライブラリーの説明。
- Taglib の URI
- コンポーネント・ライブラリーの Taglib の URI。
- 接頭部
- タグに付ける接頭部。
- バージョン
- バージョン番号は、ライブラリー定義内の構成のレベルを示します。既存の Web アプリケーションに対してより新しいリソースが使用可能になったときに、シグナル通知します。 ライブラリー定義を最初に作成するときに、選択したタグ・ライブラリーに意味のあるバージョンを選択します。
例えば、公的に使用可能なタグ・ライブラリーのリリース番号を最初に使用します。 バージョン番号の一般的な形式は、ドット区切りの文字列 (例えば、1.2.3.4 など) です。ライブラリー定義が使用されて、タグ・ライブラリーのリソースが 1 つ以上の Web アプリケーションにインストールされると、その定義にさらに変更を加えた場合に、バージョンの更新が必要になる場合があります。
デプロイされたライブラリー定義の「アプリケーション構成」セクションに変更を加える場合は、バージョン番号を増やします。バージョン番号の増加は、ワークベンチに対して、さらに新しいリソースまたは構成変更が使用可能になったことを示します。タグ・ライブラリーを使用する Web プロジェクトには、エラーのマークが付けられます。そのエラーに関連付けられたクイック・フィックスは、Web プロジェクトを現行構成によって更新できます。 要確認: タグ・ライブラリーが Web プロジェクトに追加されていない場合は、バージョン番号を増やす必要はありません。「アプリケーション構成」セクション以外のライブラリー定義の領域に加えた変更は、動的に読み取られるため、バージョンの変更は必要ありません。
アプリケーション構成
以下に、新規コンポーネント・ライブラリーを使用するように Web プロジェクトをセットアップする方法について詳しく 説明します。この構成では、ファイルを Web プロジェクトにコピーする方法を宣言し、また、コンポーネントを正しく機能させるために行う必要のある構成変更を宣言します。
このタスクについて
- リソース
- リソース域は、ライブラリーが最初に使用されるときに Web プロジェクトにコピーされるファイルを定義するために使用されます。 ソース・パスは、JSP 定義プロジェクト内のファイルを指す相対パスです。 ターゲット・パスは、そのライブラリーが使用されるプロジェクト内のパスです。 例えば、ソース・パス /mystylesheet.css からのファイルのターゲットとして、/theme が指定されます。 このターゲット・パスにより、CSS ファイルのコピーは Web プロジェクトの /theme フォルダーに置かれることになります。
- web.xml の更新
- このセクションには、ライブラリーが使用される Web プロジェクトのデプロイメント記述子に対して行われる、いくつかのタイプの変更に関する情報が含まれています。新規のサーブレット、コンテキスト・パラメーター、およびフィルターを、エディター内の対応するサブセクションで構成できます。
- サーブレット、コンテキスト・パラメーター、またはフィルターを追加するには、次のようにします。
- web.xml を選択します。
- 「追加」をクリックした後、ダイアログ・ボックスから項目を選択します。
- サーブレット
- このページでは、web.xml に追加する新規サーブレットのパラメーターを定義します。
- コンテキスト・パラメーター
- このセクションには、Web デプロイメント記述子にコンテキスト・パラメーターを追加するための詳細を記録します。Web プロジェクトでライブラリーが初めて使用されるときに、web.xml ファイルが変更されてこの情報が組み込まれます。
- フィルター
- このセクションでは、web.xml ファイルに追加する新規フィルターを定義します。
エディターの「追加」をクリックすることによって、このフィルターの初期化パラメーターが追加されます。
- 初期化パラメーター
- このページでは、web.xml フィルター定義の初期化パラメーターに関するデータを収集します。
- URL マッピング
- このセクションでは、フィルターの URL ベースのマッピングを収集します。
- サーブレット・マッピング
- このセクションでは、web.xml の他の場所で定義されているサーブレット名に基づいたフィルター・マッピングを収集します。
タグ・ライブラリー
このセクションでは、ライブラリーを形成するすべてのカスタム・タグをリストし、ツールの動作に関するさまざまな詳細を構成できるようにします。例えば、パレット内のタグの外観、タグをエディター上にドロップしたときの動作、Web ページ・ソース内のコンポーネントの外観、およびタグの属性やデータ・バインディングに関するさまざまな詳細を指定できます。
このタスクについて
エディターのこのセクションを使用して、コンポーネント・ライブラリー内の実際のタグに関する詳細を構成します。ライブラリー定義が生成されると、その定義にはコンポーネント・ライブラリー内のすべてのタグが含まれます。「上へ」ボタンと「下へ」ボタンを使用して、タグの順序を変更できます。指定されたタグの順序付けが、パレット内のライブラリーの外観に表示されます。
ライブラリーのパレット・カテゴリーに関する一部の視覚情報を、このページで構成できます。ライブラリー内のすべてのタグに適用するスタイル・シートのリンクまたは JavaScript 参照は、ここで構成してください。タグがパレットから追加されるときに、対応する <link> タグと <script> タグが Web ページに追加されます。
- タグ
- このページでは、パレット内のコンポーネント・タグの外観 (アイコンやラベルの情報など) を構成します。タグはデフォルトで非表示にすることも、パレット選択項目から削除することもできます。
- プロパティーのドロップ
- パレットから新規タグを挿入したときの振る舞いは、このページのパラメーターで変更できます。コンポーネントがコンテナーに類似したコントロールであり、他のコンポーネントを子にすることができる場合は、「子を許可」を選択してください。スタイルシート・リンク、JavaScript 参照を、このページでタグごとに指定できます。 スタイルシートと JavaScript は、「タグ」ページでライブラリー全体に対して設定することもできます。
- デフォルトのタグ属性
- タグのデフォルト属性値を設定するには、その属性の名前と値を指定してください。あるコンポーネント・タグがパレットから追加されると、ここで設定した属性値が自動的に設定されます。
- 視覚化
- 多くのコンポーネントについては、ビジュアル・ページ・エディターでのタグの表示が正しくレンダリングされます。場合によってはタグのレンダリングが完全に失敗したり、適切に行われなかったりすることがあります。 レンダリングが失敗した場合、タグは、タグ名が示されたグレイのボックスとして表示されます。 この問題が発生した場合、何らかの変数修飾子を使用して基本 HTML タグを指定することにより、タグの外観をカスタマイズできます。 このタグは、ページ・エディター内で視覚化の代替として使用されます。
- 使用可能な視覚化テンプレートのサンプルがあり、変数修飾子の使用方法を示す例が含まれています。テンプレートを表示するには、「詳細」セクションの「編集」をクリックします。視覚化パターン変数についてさらに学習したい方に :
視覚化パターンは、ページ・エディターの「設計」ペイン内のコンポーネントの外観を制御するために使用します。パターンは、HTML マークアップと、視覚化のコンテンツを動的に変更するいくつかのオプション置換変数で構成されています。コンポーネントをページにドラッグすると、対応するパターンが評価されます。ページ・エディターは結果の HTML を使用して有用な設計時の表現を作成します。 使用可能なパターン変数の詳細を表 1 に示してあります。
表 1. 視覚化パターン変数. 変数についての説明と例を示します。 変数 説明 例 ${children} ${children} 変数は、視覚化するタグの子タグがパターン内の ${children} 変数の位置に存在する場合に、それらをすべて発行します。子タグは元のページでの出現順序で挿入されます。子タグもパターンを使用できるため、ページ・エディターはそれらの視覚化を計算します。すべての子タグが同じ位置に挿入されるため、パターンでは ${children} 変数を一度だけ使用できます。 <div> ${children} </div>${children:row} ${children} 変数の row 修飾子は、HTML テーブル・セルの <td> エレメントの順序で子タグを発行します。 複数のコンポーネントを水平方向に整列させるときに、この変数を使用します。 <table> <tr> ${children:row} </tr> </table>${children:grid(param[,param]*)} grid 修飾子は、タグの子が含まれる HTML テーブルの行とセルのセットを作成します。 子は左から右へ追加され、指定された列数に達すると、次の行に折り返されます。デフォルトの列カウントは 2 です。オプションのコンマ区切りパラメーター・リストは、グリッド内の桁数をオーバーライドします。
パラメーター・オプションは以下のとおりです。- attr.attrName
- attrName という名前を持つタグ属性の値。 このパラメーターは整数に解決される必要があります。
- N
- 正整数定数。
パラメーターは、有効な値が見つかるまで、順次調べられます。 例えば、パターン ${children:grid(attr.size, attr.numcols, 3)} は、タグの size 属性が定義された場合はそれを使用し、numcols 属性が定義された場合はそれを使用します。どちらの属性も定義されていない場合は、定数 3 が使用されます。
<table> ${children:grid(attr.columns, 2)} </table>${children:stack(param)} stack 修飾子は、視覚化されたスタック・セルにデータを取り込む目的で、テーブルの行とセルを作成するために、タブ付きパネルで使用されます。子タグごとに、クリック可能なラベルの水平方向テーブルが作成されます。ラベルの 1 つをクリックすると、視覚化された子タグがスタックの一番上に移動します。オプション・パラメーターでは、attr.attrName 構文を使用して、ラベルに使用する子タグのタグ属性を指定します。 <table> ${children:stack(attr.label)} </table>${attr:attrName} この変数は、パターン内で現行位置にあるタグの属性値を置き換えます。属性に設定値が含まれていない場合は、空の文字列が挿入されます。 <input type="text" value="${attr:value}" /> - タグ属性
- タグごとに、属性の説明とタイプを指定できます。 リスト内での属性の順序と、各属性のタイプは、「プロパティー」ビューでの属性の表示方法と編集方法に影響を与えます。 可能な選択項目のセット、または属性値の設定で利用できる特定のヘルパー・ダイアログ・ボックスを表す、特定のタイプもあります。
- 「プロパティー」ビュー
- このオプションのセクションには、ユーザー定義の「プロパティー」ビュー・ページのユーザー・インターフェース・エレメントおよびレイアウト情報が含まれます。
ネストされた子エレメントを「プロパティー・ビュー」セクションの下に追加して、
1 つ以上のタブの内容を定義できます。
- タブ
- タブは、その内部に他の UI エレメントを含み、
「プロパティー」ビューに対応します。
ビューにはタブ名が表示され、メイン (先頭) タブ
が最初に表示されます。最初のタブは常に選択されたタグの名前を持つので、最初のタブの名前属性の値は無視されます。
- 列
- 列エレメントは、他の UI エレメントのセットを視覚的にグループ化して垂直の列にします。 2 つ以上の列がタブまたはセクション・エレメント内に定義されて、各列に子コントロールが構成されます。 列が使用されている同じコンテナー内では、列以外のエレメントはサポートされていません。 複数列の配置をセクション内の独自の領域に分離しなければならない場合があります。
- エディター
- エディター・エレメントは、次のものを定義します。
- ラジオ・ボタンなど、「プロパティー」ビューに表示されるユーザー・インターフェース・コントロールのタイプ。
- ユーザー・インターフェース・コントロールが変更する現在のタグの属性。
- ユーザー・インターフェース・コントロールの横に表示するストリング・ラベル。
- エディター・パラメーター
- いくつかのエディター・エレメントは、オプションのエディター・パラメーターを使用してコントロールの動作をカスタマイズできます。 例えば、組み合わせボックスや他の類似の選択コントロールは、許容値を定義する choices というパラメーターを使用して構成できます。 choices パラメーターの値は構文 enum{value1, value2, value3} を使用するか、または組み合わせボックスで別個のラベルと値が使用される場合には enum{name1:value1, name2:value2} を使用します。 他のほとんどの事前定義のエディター・パラメーターは、 true または false 値を受け入れます。
- ラベル
- ラベル・エレメントは、「プロパティー」ビューにテキスト情報を含むラベルを配置します。
- セクション
- セクション・エレメントは、UI の内蔵部分を定義するコンテナーです。 セクションを使用すると、その中に含まれる複数のコントロールの間隔を制御できます。 例えば、周りを囲むレイアウトの複数の列にまたがるようにセクションを構成したり、セクション自体のコンテンツ用に新しい列構造を定義するよう構成したりすることができます。
- セパレーター
- セパレーター・エレメントは、「プロパティー」ビューのコンテンツを分離するために、水平線を使用します。