Struts Bean タグの属性

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

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

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

ページの先頭に戻る

定義

表 2. 定義タグ属性
属性 説明
id 指定済みプロパティーの値で使用可能にするスクリプト記述変数の名前 (および関連する ページ scope 属性) を指定します。
注: これは、必須の属性です。
name 新規ページの scope 属性定義のためにアクセスされるプロパティーを含む Bean の 属性名 (property を指定する 場合)、またはこのタグによって作成された新規参照で重複している Bean の 属性名 (property を指定しない 場合) を指定します。この属性は、value 属性または ネストされた本体コンテンツを指定しない限り、必須です。
property name で指定した Bean でアクセスされる プロパティーの名前を指定します。この値は、単純、索引付き、またはネストされたプロパティー参照式にすることができます。デフォルト では、name で識別された Bean には、id で識別された新規参照が置かれます。
scope name で指定した Bean を取り出すために 検索する変数の有効範囲を指定します。デフォルト では、PageContext.findAttribute() によって適用されるデフォルト・ルール が適用されます。
toScope 新規に定義された Bean を作成する変数の有効範囲を指定します。 デフォルトでは、Bean は page の有効範囲に作成されます。
type id 属性として公開される値の 完全修飾クラス名を指定します。デフォルト は、value 属性を指定した場合は java.lang.String であり、 それ以外は java.lang.Object です。
value 公開される Bean に設定される java.lang.String 値 を指定します。この属性は、name 属性またはネストされた本体コンテンツを指定しない限り、必須です。

ページの先頭に戻る

ヘッダー

表 3. ヘッダー・タグ属性
プロパティー 説明
id 指定済みプロパティーの値で使用可能にするスクリプト記述変数の名前 (および関連する ページ scope 属性) を指定します。
注: これは、必須の属性です。
multiple この属性に任意の値が指定された場合、HttpServletRequest.getHeaders() が呼び出され、 タイプ String[] の Bean として結果が定義されます。 指定されなかった場合は、HttpServletRequest.getHeader() が呼び出され、 タイプ String の Bean として結果の定義が実行されます。
name 値が取得される要求ヘッダーの名前を指定します。
value 公開される Bean に設定される java.lang.String 値 を指定します。この属性は、name 属性またはネストされた本体コンテンツを指定しない限り、必須です。
注: これは、必須の属性です。

ページの先頭に戻る

インクルード

表 4. インクルード・タグ属性
属性 説明
anchor 生成済みハイパーリンクに追加するオプションのアンカー・タグを指定します。
forward 組み込まれるリソースの実コンテンツ相対 URI を含むグローバル ActionForward の論理名。
href 組み込まれるリソースの絶対 URL。
id 指定された Web アプリケーション・リソースの値で使用可能なスクリプト記述変数の名前および関連する ページ scope 属性を指定します。
注: これは、必須の属性です。
page 組み込まれる Web アプリケーション・リソースのモジュール相対 URI。
transaction このインクルードに対して生成された URL に、現在のトランザクション 制御トークンを組み込む場合は、true に設定します。

ページの先頭に戻る

メッセージ

表 5. メッセージ・タグ属性
属性 説明
arg0 最初のパラメーターの置換値を指定します (ある場合)。
arg1 2 番目のパラメーターの置換値を指定します (ある場合)。
arg2 3 番目のパラメーターの置換値を指定します (ある場合)。
arg3 4 番目のパラメーターの置換値を指定します (ある場合)。
arg4 5 番目のパラメーターの置換値を指定します (ある場合)。
bundle メッセージを含む MessageResources オブジェクトが保管されて いるアプリケーションの有効範囲 Bean の名前を指定します。デフォルトは Globals.MESSAGES_KEY です。
key メッセージ・リソース内に必ず対応する値を持つ、 要求済みメッセージのメッセージ・キーを指定します。 デフォルトでは、キーは name プロパティーおよび property プロパティーから取得されます。
locale 現在選択済みのロケール・オブジェクトが保管されて いるセッション・スコープ Bean の名前を指定します。デフォルトは Globals.LOCALE_KEY です。
name property で指定した値 (指定している場合) を取り出すためにアクセスされるプロパティーを含む Bean の属性名を 指定します。property を省略すると、この Bean そのものの 値がメッセージ・リソース・キーとして使用されます。
property name で指定した Bean でアクセスされる プロパティーの名前を指定します。この値は、単純、索引付き、またはネストされたプロパティー参照式にすることができます。デフォルト では、name で識別された Bean には、id で識別された新規参照が置かれます。
property name で指定した Bean でアクセスされる プロパティーの名前を指定します。この値は、単純、索引付き、またはネストされたプロパティー参照式にすることができます。デフォルト では、name で識別された Bean の値がそのままメッセージ・リソース・キーとして使用されます。
scope name で指定した Bean を取り出すために 検索する変数の有効範囲を指定します。デフォルト では、PageContext.findAttribute() によって適用されるデフォルト・ルール が適用されます。

ページの先頭に戻る

ページ

表 6. ページ・タグ属性
属性 説明
id 指定済みページ・コンテキスト・プロパティーの値で使用可能にするスクリプト記述変数の名前 (および関連する ページ scope 属性) を指定します。
注: これは、必須の属性です。
property 現在のページ・コンテキストから取得および公開されるプロパティーの名前。applicationconfigrequestresponse、または session のいずれかである必要があります。
注: これは、必須の属性です。

ページの先頭に戻る

パラメーター

表 7. パラメーター・タグ属性
属性 説明
id 指定済み要求パラメーターの値で使用可能にするスクリプト記述変数の名前 (および関連するページ scope 属性) を指定します。
注: これは、必須の属性です。
multiple この属性に任意の値が指定された場合、ServletRequest.getParameterValues() が呼び出され、 タイプ String[] の Bean として結果が定義されます。 指定されなかった場合は、ServletRequest.getParameter() が呼び出され、タイプ String の Bean として結果の定義が実行されます。
name 値が取得される要求パラメーターの名前を指定します。
注: これは、必須の属性です。
value 指定された名前のパラメーターがこの要求に含まれていない場合に戻されるデフォルトのパラメーター値。

ページの先頭に戻る

リソース

表 8. リソース・タグ属性
属性 説明
id 指定済み Web アプリケーション・リソースの値で使用可能にするスクリプト記述変数の名前 (および関連する ページ scope 属性) を指定します。
注: これは、必須の属性です。
input この属性の任意の値が指定された場合、リソースは InputStream として 使用可能になります。この属性が指定されない場合、リソースは String として 使用可能になります。
name ロードされ、使用可能にされる Web アプリケーション・リソースのモジュール相対名。
注: これは、必須の属性です。

ページの先頭に戻る

サイズ

表 9. サイズ・タグ属性
属性 説明
collection 配列、コレクション、またはマップに対して評価するランタイム式。
id タイプ java.lang.Integer の ページの有効範囲 JSP Bean の名前。カウントされる基礎となるコレクションのサイズを含むために作成されます。
注: これは、必須の属性です。
name カウントされるコレクションを含む (property が指定されない場合)、 またはプロパティー getter が呼び出されて、カウントされるコレクションを戻す (property が指定された場合)、JSP Bean の名前 (オプションとして、スコープ属性によって指定された有効範囲に制限されます)。
property name 属性で指定した Bean のプロパティーの名前。getter メソッドが、カウントされるコレクションを戻します。
scope name 属性で指定した JSP Bean を検索する Bean 有効範囲。指定されていない場合は、使用可能な有効範囲が昇順で検索されます。

ページの先頭に戻る

Struts

表 10. Struts タグ属性
属性 説明
formBean 公開する Struts ActionFormBean 定義オブジェクトの名前を指定します。
forward 公開するグローバル Struts ActionForward 定義オブジェクトの名前を指定します。
id 指定済み Struts 内部構成オブジェクトの値で使用可能にするスクリプト記述変数の名前 (および関連するページ scope 属性) を指定します。
注: これは、必須の属性です。
マッピング 公開する Struts ActionMapping 定義オブジェクトの一致するパスを指定します。

ページの先頭に戻る

書き込み

表 11. 書き込みタグ属性
属性 説明
bundle メッセージを含む MessageResources オブジェクトが保管されてい るアプリケーションの有効範囲 Bean の名前を指定します。デフォルトは Globals.MESSAGES_KEY です。
filter false に設定すると、HTML で区別される文字のレンダリング済みプロパティー値のフィルターを抑制します。 デフォルトでは、このような値は、それぞれの同等なエンティティーに変換されます。
format Bean またはプロパティー値を String オブジェクト に変換するために使用する書式制御ストリングを指定します。デフォルト では、value データ・タイプの書式制御ストリングは、 メッセージ・リソース内でキーに従って検索されます。
formatKey アプリケーション・リソース内で書式制御ストリングを検索するために使用する キーを指定します。
ignore true に設定した場合、name プロパティーおよび scope プロパティーで指定した Bean が存在しないと、何も書き込まずに戻します。 false に設定した場合、Bean が存在しないと、ランタイム例外をスローします。
locale 現在選択済みのロケール・オブジェクトが保管されて いるセッション・スコープ Bean の名前を指定します。デフォルトは Globals.LOCALE_KEY です。
name property で指定した値 (指定している場合) を取り出すためにアクセスされるプロパティーを含む Bean の属性名を 指定します。property を指定しないと、この Bean そのものの値がレンダリングされます。
注: これは、必須の属性です。
property name で指定した Bean でアクセスされる プロパティーの名前を指定します。デフォルト では、name で識別された Bean がそのままレンダリングされます。指定したプロパティーが NULL を戻した場合、出力はレンダリングされません。
scope name で指定した Bean を取り出すために 検索する変数の有効範囲を指定します。デフォルト では、PageContext.findAttribute() によって適用されるデフォルト・ルール が適用されます。

ページの先頭に戻る


フィードバック