Struts 論理タグの属性

この参照資料では、Struts 論理タグ・ ライブラリーの属性について説明します。 デフォルトで、各要素名に接頭部 logic: が付きます。

Struts タグおよびタグ属性について 詳しくは、Apache Struts の 仕様を参照してください。

それぞれの Struts タグには、そのタグの 「プロパティー」ビューを使用して設定できる多くの属性があります。タグの「プロパティー」ビューでの作業中に、 さらに詳しい情報が必要な属性があった場合は、次の属性のテーブルを使用してください。 属性の中には、 名前が同じでも、異なる要素では使用法が異なるものがあります。属性は、 アルファベット順にリストされています。

空き

表 1. 空きタグ属性
属性 説明
name property を省略する場合は 比較される変数として JSP Bean を指定し、property を指定する場合は この Bean の指定済みプロパティーの値を指定します。
property 比較する値を含む (name 属性で指定した Bean の) プロパティーの名前を 指定します。プロパティー参照は、単純、ネスト型、または 索引付きにできます。
scope name プロパティーで指定した Bean を検索する Bean 有効範囲を指定します。デフォルトでは、あらゆる有効範囲を 使用します。

ページの先頭に戻る。

等しい

表 2. 等しいタグ属性
属性 説明
cookie value 属性の値と比較する値を含む cookie の名前を指定します。
header 比較する値を含むヘッダーの名前を 指定します。名前は、大/小文字を区別しないで突き合わせされます。
name property を省略する場合は 比較される変数として JSP Bean を指定し、property を指定する場合は この Bean の指定済みプロパティーの値を指定します。
parameter value 属性の値と比較する値を含む URL 要求パラメーターの名前を指定します。
property 比較する値を含む (name 属性で指定した Bean の) プロパティーの名前を 指定します。プロパティー参照は、単純、ネスト型、または 索引付きにできます。
scope name プロパティーで指定した Bean を検索する Bean 有効範囲を指定します。デフォルトでは、あらゆる有効範囲を 使用します。
value このタグの別の属性で指定した変数と比較する 定数値を指定します。
注: これは、必須の属性です。

ページの先頭に戻る。

転送

表 3. 転送タグ属性
属性 説明
name 宛先、および使用される転送方法を識別するグローバル ActionForward エントリーの論理名を指定します。
注: タイル定義への転送は、 このタグからはできません。この転送は、アクションから 行う必要があります。
注: これは、必須の属性です。

ページの先頭に戻る。

以上

表 4. 以上タグ属性
属性 説明
cookie value 属性の値と比較する値を含む cookie の名前を指定します。
header 比較する値を含むヘッダーの名前を 指定します。名前は、大/小文字を区別しないで突き合わせされます。
name property を省略する場合は 比較される変数として JSP Bean を指定し、property を指定する場合は この Bean の指定済みプロパティーの値を指定します。
parameter value 属性の値と比較する値を含む URL 要求パラメーターの名前を指定します。
property 比較する値を含む (name 属性で指定した Bean の) プロパティーの名前を 指定します。プロパティー参照は、単純、ネスト型、または 索引付きにできます。
scope name プロパティーで指定した Bean を検索する Bean 有効範囲を指定します。デフォルトでは、あらゆる有効範囲を 使用します。
value このタグの別の属性で指定した変数と比較する 定数値を指定します。
注: これは、必須の属性です。

ページの先頭に戻る。

より大

表 5. より大タグ属性
プロパティー 説明
cookie value 属性の値と比較する値を含む cookie の名前を指定します。
header 比較する値を含むヘッダーの名前を 指定します。名前は、大/小文字を区別しないで突き合わせされます。
name property を省略する場合は 比較される変数として JSP Bean を指定し、property を指定する場合は この Bean の指定済みプロパティーの値を指定します。
parameter value 属性の値と比較する値を含む URL 要求パラメーターの名前を指定します。
property 比較する値を含む (name 属性で指定した Bean の) プロパティーの名前を 指定します。プロパティー参照は、単純、ネスト型、または 索引付きにできます。
scope name プロパティーで指定した Bean を検索する Bean 有効範囲を指定します。デフォルトでは、あらゆる有効範囲を 使用します。
value このタグの別の属性で指定した変数と比較する 定数値を指定します。
注: これは、必須の属性です。

ページの先頭に戻る。

反復

表 6. 反復タグ属性
属性 説明
collection 反復される (特定の要件に準拠する) コレクションに評価するランタイム式を指定します。
id 反復ごとに、コレクションの現行要素を含むページの有効範囲 JavaServer Pages (JSP) Bean の名前を指定します (NULL でない場合)。
注: これは、必須の属性です。
indexId 反復ごとに、コレクションの現行索引を含むページの有効範囲 JSP Bean の名前を指定します。
length このページ内で反復される (ベースとなるコレクション からの) エントリーの最大数を指定します。これは、要求する値を直接示す整数、 あるいは要求する値を定義しているタイプ java.lang.Integer の (任意の有効範囲の) JSP Bean の名前のいずれかです。デフォルトでは、実行される反復の回数は制限されていません。
name 反復されるコレクションを含む JSP Bean の 名前 (property を省略する場合) または 反復されるコレクションを戻すプロパティー getter を含む JSP Bean の名前 (property を指定する場合) を指定します。
offset ベースとなるコレクションからのエントリーが反復される 開始点のゼロ相対索引を指定します。これは、要求する値を直接示す整数、 あるいは要求する値を定義しているタイプ java.lang.Integer の (任意の有効範囲の) JSP Bean の名前のいずれかにできます。デフォルト値はゼロであり、これは、コレクションが 先頭から反復されることを意味します。
property 比較する値を含む (name 属性で指定した Bean の) プロパティーの名前を 指定します。プロパティー参照は、単純、ネスト型、または 索引付きにできます。
scope name プロパティーで指定した Bean を検索する Bean 有効範囲を指定します。デフォルトでは、あらゆる有効範囲を 使用します。
type id 属性に指定された JSP Bean を介して公開される要素の、 完全修飾 Java™ クラス名を指定します。 デフォルトでは、タイプ変換は実行されません。
注: コレクションの実要素は、このクラスと代入互換でなければなりません。そうでないと、 要求時間の ClassCastException エラーが発生します。

ページの先頭に戻る。

以下

表 7. 以下タグ属性
属性 説明
cookie value 属性の値と比較する値を含む cookie の名前を指定します。
header 比較する値を含むヘッダーの名前を 指定します。名前は、大/小文字を区別しないで突き合わせされます。
name property を省略する場合は 比較される変数として JSP Bean を指定し、property を指定する場合は この Bean の指定済みプロパティーの値を指定します。
parameter value 属性の値と比較する値を含む URL 要求パラメーターの名前を指定します。
property 比較する値を含む (name 属性で指定した Bean の) プロパティーの名前を 指定します。プロパティー参照は、単純、ネスト型、または 索引付きにできます。
scope name プロパティーで指定した Bean を検索する Bean 有効範囲を指定します。デフォルトでは、あらゆる有効範囲を 使用します。
value このタグの別の属性で指定した変数と比較する 定数値を指定します。
注: これは、必須の属性です。

ページの先頭に戻る。

未満

表 8. 未満タグ属性
属性 説明
cookie value 属性の値と比較する値を含む cookie の名前を指定します。
header 比較する値を含むヘッダーの名前を 指定します。名前は、大/小文字を区別しないで突き合わせされます。
name property を省略する場合は 比較される変数として JSP Bean を指定し、property を指定する場合は この Bean の指定済みプロパティーの値を指定します。
parameter value 属性の値と比較する値を含む URL 要求パラメーターの名前を指定します。
property 比較する値を含む (name 属性で指定した Bean の) プロパティーの名前を 指定します。プロパティー参照は、単純、ネスト型、または 索引付きにできます。
scope name プロパティーで指定した Bean を検索する Bean 有効範囲を指定します。デフォルトでは、あらゆる有効範囲を 使用します。
value このタグの別の属性で指定した変数と比較する 定数値を指定します。
注: これは、必須の属性です。

ページの先頭に戻る。

一致

表 9. 一致タグ属性
属性 説明
cookie value 属性の値と比較する値を含む cookie の名前を指定します。
header 比較する値を含むヘッダーの名前を 指定します。名前は、大/小文字を区別しないで突き合わせされます。
location 指定されない場合は、変数と値の間の突き合せが、変数文字列の 任意の位置で発生する可能性があります。 指定された場合は、変数文字列の指定された場所 (開始または終了) で突き合せが発生します。
name property を省略する場合は、突き合わせされる 変数がこの属性で指定した JSP Bean となるように指定し、property を指定する場合は、 この Bean の指定済みプロパティーの値を指定します。
parameter value 属性の値と比較する値を含む URL 要求パラメーターの名前を指定します。
property 比較する値を含む (name 属性で指定した Bean の) プロパティーの名前を 指定します。プロパティー参照は、単純、ネスト型、または 索引付きにできます。
scope name プロパティーで指定した Bean を検索する Bean 有効範囲を指定します。デフォルトでは、あらゆる有効範囲を 使用します。
value このタグの別の属性で指定した変数と比較する 定数値を指定します。
注: これは、必須の属性です。

ページの先頭に戻る。

メッセージ非表示

表 10. メッセージ非表示タグ属性
属性 説明
message true に設定すると、Globals.MESSAGE_KEY 定数ストリングから要求有効範囲 Bean を取り出しますが、 name 属性に割り当てられた値を無視します。デフォルトでは、このタグは、Globals.ERROR_KEY 定数ストリングから、反復される要求有効範囲 Bean を取り出します。
name 要求有効範囲からメッセージを取り出すためのパラメーター・キー を指定します。
property 比較する値を含む (name 属性で指定した Bean の) プロパティーの名前を 指定します。プロパティー参照は、単純、ネスト型、または 索引付きにできます。

ページの先頭に戻る。

メッセージ表示

表 11. メッセージ表示タグ属性
属性 説明
message true に設定すると、Globals.MESSAGE_KEY 定数ストリングから要求有効範囲 Bean を取り出しますが、 name 属性に割り当てられた値を無視します。デフォルトでは、このタグは、Globals.ERROR_KEY 定数ストリングから、反復される要求有効範囲 Bean を取り出します。
name 要求有効範囲からメッセージを取り出すためのパラメーター・キー を指定します。
property 比較する値を含む (name 属性で指定した Bean の) プロパティーの名前を 指定します。プロパティー参照は、単純、ネスト型、または 索引付きにできます。

ページの先頭に戻る。

空でない

表 12. 空でないタグ属性
属性 説明
name (任意の有効範囲に) JSP Bean が存在するかどうかを、 指定した名前で検査します。さらに property も指定した場合、name は、指定したプロパティーの NULL 以外のプロパティー値について検査します。
property 比較する値を含む (name 属性で指定した Bean の) プロパティーの名前を 指定します。プロパティー参照は、単純、ネスト型、または 索引付きにできます。
scope name プロパティーで指定した Bean を検索する Bean 有効範囲を指定します。デフォルトでは、あらゆる有効範囲を 使用します。

ページの先頭に戻る。

等しくない

表 13. 等しくないタグ属性
属性 説明
cookie value 属性の値と比較する値を含む cookie の名前を指定します。
header 比較する値を含むヘッダーの名前を 指定します。名前は、大/小文字を区別しないで突き合わせされます。
name property を省略する場合は 比較される変数として JSP Bean を指定し、property を指定する場合は この Bean の指定済みプロパティーの値を指定します。
parameter value 属性の値と比較する値を含む URL 要求パラメーターの名前を指定します。
property 比較する値を含む (name 属性で指定した Bean の) プロパティーの名前を 指定します。プロパティー参照は、単純、ネスト型、または 索引付きにできます。
scope name プロパティーで指定した Bean を検索する Bean 有効範囲を指定します。デフォルトでは、あらゆる有効範囲を 使用します。
value このタグの別の属性で指定した変数と比較する 定数値を指定します。
注: これは、必須の属性です。

ページの先頭に戻る。

不一致

表 14. 不一致タグ属性
属性 説明
cookie value 属性の値と比較する値を含む cookie の名前を指定します。
header 比較する値を含むヘッダーの名前を 指定します。名前は、大/小文字を区別しないで突き合わせされます。
location 指定されない場合は、変数と値の間の突き合せが、変数文字列の 任意の位置で発生する可能性があります。 指定された場合は、変数文字列の指定された場所 (開始または終了) で突き合せが発生します。
name property を省略する場合は、突き合わせされる 変数がこの属性で指定した JSP Bean となるように指定し、property を指定する場合は、 この Bean の指定済みプロパティーの値を指定します。
parameter value 属性の値と比較する値を含む URL 要求パラメーターの名前を指定します。
property 比較する値を含む (name 属性で指定した Bean の) プロパティーの名前を 指定します。プロパティー参照は、単純、ネスト型、または 索引付きにできます。
scope name プロパティーで指定した Bean を検索する Bean 有効範囲を指定します。デフォルトでは、あらゆる有効範囲を 使用します。
value このタグの別の属性で指定した変数と比較する 定数値を指定します。
注: これは、必須の属性です。

ページの先頭に戻る。

非表示

表 15. 非表示タグ属性
属性 説明
cookie value 属性の値と比較する値を含む cookie の名前を指定します。
header 比較する値を含むヘッダーの名前を 指定します。名前は、大/小文字を区別しないで突き合わせされます。
name property を省略する場合は 比較される変数として JSP Bean を指定し、property を指定する場合は この Bean の指定済みプロパティーの値を指定します。
parameter value 属性の値と比較する値を含む URL 要求パラメーターの名前を指定します。
property 比較する値を含む (name 属性で指定した Bean の) プロパティーの名前を 指定します。プロパティー参照は、単純、ネスト型、または 索引付きにできます。
scope name プロパティーで指定した Bean を検索する Bean 有効範囲を指定します。デフォルトでは、あらゆる有効範囲を 使用します。
value このタグの別の属性で指定した変数と比較する 定数値を指定します。

ページの先頭に戻る。

表示

表 16. 表示タグ属性
属性 説明
cookie value 属性の値と比較する値を含む cookie の名前を指定します。
header 比較する値を含むヘッダーの名前を 指定します。名前は、大/小文字を区別しないで突き合わせされます。
name (任意の有効範囲に) JSP Bean が存在するかどうかを、 指定した名前で検査します。さらに property も指定した場合、name は、指定したプロパティーの NULL 以外のプロパティー値について検査します。
parameter value 属性の値と比較する値を含む URL 要求パラメーターの名前を指定します。
property 比較する値を含む (name 属性で指定した Bean の) プロパティーの名前を 指定します。プロパティー参照は、単純、ネスト型、または 索引付きにできます。
role 現在の認証ユーザー (いる場合) が、指定済みセキュリティー・ロールのいずれかと 関連付けられているかどうかを検査します。複数の役割を指定するには、 役割名をコンマで区切ります。
scope name プロパティーで指定した Bean を検索する Bean 有効範囲を指定します。デフォルトでは、あらゆる有効範囲を 使用します。
user 現在の認証ユーザーが、指定した名前を持っているかどうかを 検査します。

ページの先頭に戻る。

リダイレクト

表 17. リダイレクト・タグ属性
属性 説明
action この転送の宛先の実コンテンツ相対 URI を含む グローバル・アクションの論理名。タグの説明に記述されているように、 このハイパーリンクは、照会パラメーターを組み込むことによって、動的に変更できます。 action 属性、forward 属性、 href 属性、または page 属性のうちいずれかを 指定しなければなりません。
anchor 生成済みハイパーリンクに #xxx のように追加 するオプションのアンカー・タグ (xxx) を指定します。
forward この redirect 要素の宛先の実コンテンツ相対 URI を 含むグローバル ActionForward クラスの論理名を指定します。 タグの説明に記述されているように、照会パラメーターを含めれば、動的に変更された URI を 変更することができます。 forward、href、linkName、または page の属性のうちいずれかを指定しなければなりません。
href この要素が制御権を移動する先の URL を 指定します。タグの説明に記述されているように、照会パラメーターを含めれば、URL を動的に 変更することができます。 forward、href、linkName、または page の属性のうちいずれかを指定しなければなりません。
name 照会パラメーターを表す Map クラスを含む JSP Bean の名前を指定します (property を省略する場合)。 または、Map を戻すために呼び出されるプロパティー getter を含む JSP Bean の名前を指定します (property を指定する場合)。
page このハイパーリンクが制御権を移動 する先のコンテキスト相対パス (/ 文字で始めます) を指定します (活動化されている場合)。タグの説明に記述されているように、照会パラメーターを含めれば、ハイパーリンクを動的に 変更することができます。 forward、href、linkName、または page の属性のうちいずれかを指定しなければなりません。
paramId 生成済みハイパーリンクに動的に追加する要求パラメーターの名前を指定します。 対応する値は paramName および (オプション) paramProperty 属性 で定義され、オプションで paramScope 属性でスコープされます。
paramName paramId で指定した要求パラメーターの値を含む String である JSP Bean の名前 (paramProperty を省略する場合)、あるいは String を戻すために呼び出されるプロパティー getter を含む JSP Bean の名前 (paramProperty を指定する場合) を指定します。 JSP Bean は、paramScope プロパティーで指定されている Bean の有効範囲 に制限されます (指定されている場合)。
paramProperty paramName 属性で指定した Bean の プロパティー名を指定します。この場合の戻り値は、 このハイパーリンクに動的に追加される (paramId 属性で指定した) 要求パラメーター の値を含む String でなければなりません。
paramScope paramName 属性で指定した Bean を検索する有効範囲を指定します。 デフォルトでは 全有効範囲が検索対象となります。
property 比較する値を含む (name 属性で指定した Bean の) プロパティーの名前を 指定します。プロパティー参照は、単純、ネスト型、または 索引付きにできます。
scope name プロパティーで指定した Bean を検索する Bean 有効範囲を指定します。デフォルトでは、あらゆる有効範囲を 使用します。
transaction true に設定すると、 この要素に対して生成された URL に、現在のトランザクション制御トークンを組み込みます。
useLocalEncoding true に設定された場合、LocalCharacterEncoding が使用されます。つまり、URL のパラメーター上で URLEncoding が実行される際に、優先される文字エンコードとして、UTF-8 ではなく HttpServletResponse に設定された characterEncoding です。

ページの先頭に戻る。

フィードバック