この文書では、Struts 論理タグ・ライブラリーで定義される エレメントの属性について説明します。デフォルトでは、これらの各エレメントの名前には logic: 接頭部が付きます。
それぞれの Struts エレメントには、エレメントの「プロパティー」ビューを使用して設定できる多くのプロパティーがあります。エレメントの「プロパティー」ビューでの作業中に、さらに詳しい情報が必要なプロパティーがあった場合は、次のプロパティーの表を参照してください。 プロパティーの中には、名前が同じでも、異なるエレメントでは使用法が異なるものがあります。プロパティーはアルファベット順にリストされています。
プロパティー | エレメント内部 | 説明 |
---|---|---|
anchor | redirect | 生成済みハイパーリンクに #xxx のように追加 するオプションのアンカー・タグ (xxx) を指定します。 |
collection | iterate | 反復される (特定の要件に準拠する) コレクションに評価するランタイム式 を指定します。 |
cookie | equal、greaterEqual、greaterThan、lessEqual、lessThan、 notEqual、notPresent、present | value 属性の値と比較する値を含む cookie の名前を指定します。 |
forward | redirect | この redirect エレメントの宛先の実コンテンツ相対 URI を 含むグローバル ActionForward クラスの論理名を指定します。タグの説明に記述されているように、照会パラメーターを含めれば、動的に変更された URI を 変更することができます。 forward、href、linkName、または page の属性のうちいずれかを指定しなければなりません。 |
header | equal、greaterEqual、greaterThan、lessEqual、lessThan、 notEqual、notMatch、notPresent、present | 比較する値を含むヘッダーの名前を 指定します。名前は、大/小文字を区別しないで突き合わせされます。 |
href | redirect | このエレメントが制御権を移動する先の URL を 指定します。タグの説明に記述されているように、照会パラメーターを含めれば、URL を動的に変更することができます。 forward、href、linkName、または page の属性のうちいずれかを指定しなければなりません。 |
id | iterate | 反復ごとに、コレクションの 現行エレメントを含む ページの有効範囲 JSP Bean の名前を指定します (NULL でない場合)。[必須] |
indexId | iterate | 反復ごとに、コレクションの現行索引を含むページの有効範囲 JSP Bean の名前を指定します。 |
length | iterate | このページ内で反復される (ベースとなるコレクション からの) エントリーの最大数を指定します。これは、要求する値を直接示す整数、 あるいは要求する値を定義しているタイプ java.lang.Integer の (任意の有効範囲の) JSP Bean の名前のいずれかです。デフォルトでは、実行される反復の回数は制限されていません。 |
message | messagesNotPresent、messagesPresent | true に設定すると、Globals.MESSAGE_KEY 定数ストリングから要求有効範囲 Bean を取り出しますが、 name 属性に割り当てられた値を無視します。デフォルトでは、このタグは、Globals.ERROR_KEY 定数ストリングから、反復される要求有効範囲 Bean を取り出します。 |
name | equal、greaterEqual、greaterThan、lessEqual、lessThan、 notEqual、notMatch、notPresent、present | property を省略する場合は比較される変数として JSP Bean を指定し、property を指定する場合はこの Bean の指定済みプロパティーの値を指定します。 |
name | forward | 宛先、および使用される転送方法を識別するグローバル ActionForward
エントリーの論理名を指定します。 注: タイル定義への転送は、
このタグからはできません。この転送は、アクションから行う必要があります。
[必須] |
name | iterate | 反復されるコレクションを含む JSP Bean の 名前 (property を省略する場合) または反復されるコレクションを戻すプロパティー getter を含む JSP Bean の名前 (property を指定する場合) を指定します。 |
name | match、notMatch | property を省略する場合は、突き合わせされる変数がこの属性で指定した JSP Bean となるように指定し、property を指定する場合は、 この Bean の指定済みプロパティーの値を指定します。 |
name | messagesNotPresent、messagesPresent | 要求有効範囲からメッセージを取り出すためのパラメーター・キー を指定します。 |
name | notPresent、present | (任意の有効範囲に) JSP Bean が存在するかどうかを、指定した名前で検査します。さらに property を指定する場合、name は、指定したプロパティーの非空プロパティー値を検査します。 |
name | redirect | 照会パラメーターを表す Map クラスを 含む JSP Bean の名前 (property を省略する場合)、または Map を戻すために呼び出されるプロパティー getter を含む JSP Bean の名前 (property を指定する場合) を指定します。 |
offset | iterate | ベースとなるコレクションからのエントリーが反復される 開始点のゼロ相対索引を指定します。これは、要求する値を直接示す整数、 あるいは要求する値を定義しているタイプ java.lang.Integer の (任意の有効範囲の) JSP Bean の名前のいずれかにできます。デフォルト値はゼロであり、これは、コレクションが 先頭から反復されることを意味します。 |
page | redirect | このハイパーリンクが制御権を移動 する先のコンテキスト相対パス (/ 文字で始めます) を指定します (活動化されている場合)。タグの説明に記述されているように、照会パラメーターを含めれば、ハイパーリンクを動的に変更することができます。 forward、href、linkName、または page の属性のうちいずれかを指定しなければなりません。 |
parameter | equal、greaterEqual、greaterThan、lessEqual、lessThan、 notEqual、notMatch、notPresent、present | value 属性の値と比較する値を含む URL 要求パラメーターの名前を指定します。 |
paramId | redirect | 生成済みハイパーリンクに動的に追加する要求パラメーターの名前を指定します。対応する値は paramName および (オプション) paramProperty 属性で定義され、オプションで paramScope 属性でスコープされます。 |
paramName | redirect | paramId で指定した要求パラメーターの値を含む String である JSP Bean の名前 (paramProperty を省略する場合)、あるいは String を戻すために呼び出されるプロパティー getter を含む JSP Bean の名前 (paramProperty を指定する場合) を指定します。 JSP Bean は、paramScope プロパティーで指定されている Bean の有効範囲に制限されます (指定されている場合)。 |
paramProperty | redirect | paramName 属性で指定した Bean の プロパティー名を指定します。この場合の戻り値は、 このハイパーリンクに動的に追加される (paramId 属性で指定した) 要求パラメーター の値を含む String でなければなりません。 |
paramScope | redirect | paramName 属性で指定した Bean を検索する有効範囲を指定します。デフォルトでは 全有効範囲が検索対象となります。 |
property | empty、equal、iterate、messagesNotPresent、messagesPresent、 notEqual、notPresent、present、redirect | 比較する値を含む (name 属性で指定した Bean の) プロパティーの名前を 指定します。プロパティー参照は、単純、ネスト型、または索引付きにできます。 |
role | notPresent、present | 現在の認証ユーザー (いる場合) が、指定済みセキュリティー役割のいずれかと 関連付けられているかどうかを検査します。複数の役割を指定するには、 役割名をコンマで区切ります。 |
scope | equal、greaterEqual、greaterThan、lessEqual、lessThan、 notEqual、notMatch、notPresent、present | name プロパティーで指定した Bean を検索する Bean 有効範囲を指定します。デフォルトでは、あらゆる有効範囲を 使用します。 |
transaction | redirect | true に設定すると、 このエレメントに対して生成された URL に、現在のトランザクション制御トークンを組み込みます。 |
type | iterate | id 属性に指定された
JSP Bean を介して公開されるエレメントの完全修飾 Java™ クラス名を指定します。デフォルトでは、タイプ変換は実行されません。 注: コレクション
の実エレメントは、このクラスと代入互換でなければなりません。そうでないと、
要求時間の ClassCastException エラーが発生します。
|
user | notPresent、present | 現在の認証ユーザーが、指定した名前を持っているかどうかを 検査します。 |
value | equal、greaterEqual、greaterThan、lessEqual、lessThan、 notEqual | このタグの別の属性で指定した変数と比較する 定数値を指定します。 |