集約タグ・ライブラリーの属性
集約タグ・ライブラリーは、複数のポートレットを 1 つのページ上に集約するのに使用されます。
サポートされている引数は以下のとおりです。
- init
- このタグはポートレット・フレームワークを初期化するものであり、JSP の先頭で使用する必要があります。
このセクションで説明される他のすべてのタグは、このタグの本体内でのみ有効であるため、通常、init タグは JSP 全体を囲んでいます。
現在の URL がアクション・フラグを含んでいる場合は、対応するポートレットのアクション・メソッドが呼び出されます。
state タグと insert タグは、init タグのサブタグです。
init タグには、次のような属性があります。
- portletURLPrefix="<any string>"
この URL は、ポートレット URL で使用されるプレフィックスを定義します。 ポートレット URL は、state タグによって作成されるか、insert タグを使用することによって呼び出されるポートレットのレンダリング・メソッド内で作成されます。 これは必須属性です。
- portletURLSuffix="<any string>"
この URL は、ポートレット URL で使用されるサフィックスを定義します。 ポートレット URL は、state タグによって作成されるか、insert タグを使用することによって呼び出されるポートレットのレンダリング・メソッド内で作成されます。 これはオプション属性です。
- portletURLQueryParams="<any string>"
この URL は、ポートレット URL で使用される照会パラメーターを定義します。 ポートレット URL は、state タグによって作成されるか、insert タグを使用することによって呼び出されるポートレットのレンダリング・メソッド内で作成されます。 これはオプション属性です。
- portletURLPrefix="<any string>"
- scope, portlet
- scope タグおよび portlet タグは、ポートレット・アプリケーションが複数パーツのコンテキスト・ルート (例えば、/context1/context2) にインストールされている場合に必要となる情報を提供するために使用されます。
またこれらのタグは、パブリックなレンダリング・パラメーターを介したポートレット調整に関係するポートレット・ウィンドウを定義し、新しく作成された URL にレンダリング・パラメーターを追加します。urlParam タグには、次のような属性があります。
- context = "/<context1>/<context2>"
ポートレットをデプロイするポートレット・アプリケーションのコンテキスト・ルートを指定します。 この属性は必須です。
- portletname = "<portlet-name>"
ポートレット名を指定します。 この属性は必須です。
- windowId="<any string>"
コンクリート・ポートレット・インスタンスのウィンドウ ID を定義します。 この属性は必須です。
以下に、scope および portlet タグの使用方法の例を示します。<%@ taglib uri="http://ibm.com/portlet/aggregation" prefix="portlet" %> <portlet:scope> <portlet:portlet context="/myportletcontext1/myportletcontext2" portletname="MyPortlet" windowId="sample"/> </portlet:scope> <portlet:init portletURLPrefix="/myportalcontext/ "> …. </portlet:init>
- context = "/<context1>/<context2>"
- state
- state タグは、指定の状態を使用している指定のポートレットをポイントする URL を作成します。
この URL は、var 属性で指定された変数内に配置するか、出力ストリームに直接書き込むことができます。
このタグは、URL が呼び出されたときに、URL 内で定義された状態変更が指定のポートレットに適用される、HTML ボタン、イメージ、およびその他の項目の URL を作成するのに便利です。
state タグには、次のような属性があります。
- url="<context>/<portlet-name>"
コンテキストおよびポートレット名を使用してこのタグのポートレットを識別して、ポートレットをアドレス指定します。 この属性は必須です。
- windowId="<any string>"
このタグによって作成されたポートレット URL のウィンドウ ID を定義します。 これはオプション属性です。
- var="<any string>"
定義された場合は、URL が出力ストリームにではなく、所定の有効範囲と名前で変数に書き込まれます。 これはオプション属性です。
- scope = "page|request|session|application"
この属性が有効なのは、var 属性が選択されている場合だけです。 定義された場合、URL は出力ストリームに書き込まれず、所定の有効範囲と名前で変数が作成されます。 デフォルトは、page です。 これはオプション属性です。
- portletMode="view|help|edit|<custom>"
この属性は、ポートレット・モードを設定します。
- portletWindowState="maximized|minimized|normal|<custom>"
この属性は、ウィンドウ状態を指定します。
- action = "true/false"
この属性は、これがアクション URL かどうかを定義します。 これはオプション属性です。 デフォルトは false です。
- url="<context>/<portlet-name>"
- urlParam
- 新規作成された URL にレンダリング・パラメーターを追加します。
urlParam タグには、次のような属性があります。
- name="<any string>"
パラメーターの名前を示します。 これは必須属性です。
- value="<any string>"
パラメーターの値を示します。 これは必須属性です。
- name="<any string>"
- insert
- このタグはポートレットのレンダリング・メソッドを呼び出して、コンテンツおよびタイトルを取得します。
オプションで、contentVar 属性および titleVar 属性を使用して、指定したポートレットのコンテンツとタイトルを変数内に書き込むことができます。
insert タグには、次のような属性があります。
- url="<context>/<portlet-name>"(必須) コンテキスト
およびポートレット名を使用して、
このタグのポートレットを識別して、
ポートレットをアドレス指定します。
これは必須属性です。
- windowId="<any string>"
ポートレットのウィンドウ ID を定義します。これはオプション属性です。
- contentVar="<any string>"
定義された場合は、ポートレットのコンテンツが出力ストリームではなく、所定の有効範囲と名前で変数内に書き込まれます。これはオプション属性です。
- contentScope = "page|request|session|application"
この属性が有効なのは、contentVar タグが使用されている場合だけです。 定義された場合は、ポートレットのコンテンツが出力ストリームではなく、所定の有効範囲と名前で変数内に書き込まれます。デフォルトは、page です。 これはオプション属性です。
- titleVar="<any string>"
定義された場合は、ポートレットのタイトルが所定の有効範囲と名前で変数内に書き込まれます。定義されていない場合は、タイトルが無視され、出力ストリームには書き込まれません。 これはオプション属性です。
- titleScope = "page|request|session|application"
この属性が有効なのは、titleVar タグが使用されている場合だけです。 定義された場合は、ポートレットのタイトルが出力ストリームではなく、所定の有効範囲と名前で変数内に書き込まれます。デフォルトは、page です。 これはオプション属性です。
- url="<context>/<portlet-name>"(必須) コンテキスト
およびポートレット名を使用して、
このタグのポートレットを識別して、
ポートレットをアドレス指定します。