Struts Tiles タグのプロパティー

この文書では、Struts Tiles タグ・ライブラリーで定義されるエレメントのプロパティーについて説明します。デフォルトでは、これらの各エレメントの 名前には tiles: 接頭部が付きます。

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

エレメント プロパティー 説明
add beanName 値を使用する Bean の名前を指定します。この Bean は、指定済みコンテキスト (ある場合) から検索され ます。その他の場合、メソッド pageContext.findAttribute が使用されます。beanProperty を指定すると、 値は、対応する Bean プロパティーから検索されます。
beanProperty 値が検索される Bean プロパティーの名前を 指定します。この属性は、ネスト済み index プロパティーをサポートします。
beanScope Bean を検索する有効範囲を指定します。 デフォルトでは、メソッド pageContext.findAttribute が使用されます。有効範囲は 任意の JSP の有効範囲、component、または template にすることができます。 最後の 2 つのケースでは、Bean は、タイル・コンテキスト内で検索されます。
content value の同義語です。
direct コンテンツの処理方法を指定します。true はコンテンツがファイルに含まれていることを意味します。false (デフォルト) はコンテンツが他の場所から組み込まれることを意味します。 これは、 コンテンツ・タイプを指定するもう 1 つの方法です。true を指定すると、コンテンツはストリングと解釈されます。その他の場合、コンテンツはページと解釈されます。 この属性は、JSP テンプレートとの互換性を持つために存在します。
role エレメントの条件を作成する役割を指定します。 ユーザーが指定された役割にない場合、そのエレメントは、定義に使用されていない限り、無視されます。
type 以下のコンテンツ・タイプのいずれかを指定します。
definition
ファクトリー (XML ファイル) 内に定義する定義を指定します。この定義 は、<insert attribute="attributeName"> タグに入れて、挿入されているタイル内で検索されます。 ここで、attributeName はこのタグに使用される名前です。
page
指定済み URL からのコンテンツを組み込みます。この属性の同義語は、template です。
string
コンテンツを直接提供します。
type 属性を省略すると、 コンテンツは、型付き Bean からのものでない限り、型なしになります。
value エレメントの値を指定します。値は、 ストリングまたはオブジェクトにすることができます。
definition extends この新規定義を初期化するために使用する親定義の 名前を指定します。親定義は、定義ファクトリー内で検索 されます。
id 新規に作成された定義 Bean を保管するために使用する 名前を指定します。
page 挿入するタイルのレイアウト・ファイル (JSP ファイル のタイプ) の URL を指定します。
role この定義を挿入する前に検査する役割を指定します。 役割が現在のユーザーに定義されていない場合は、定義は挿入されません。検査は、 定義プロセス中にではなく、挿入時に行われます。
scope 新規に定義された Bean を作成する変数の有効範囲を指定します。 この属性を省略すると、Bean はページの有効範囲内に 作成されます。
template page の同義語です。
get flush true の場合は、新規ページを挿入する前に現行ページの出力ストリームをフラッシュします。 デフォルトは false です。
ignore この属性の値が true であり、name で指定したコンテンツが存在しない場合は、何も書き込まずに戻します。 デフォルト値は false です。name コンテンツが存在しない場合は、ランタイム例外がスローされます。
name タイルの有効範囲から取得するコンテンツの名前 を指定します。
role ユーザーが、指定された役割にない場合に、そのエレメントが無視されます。
getAsString ignore この属性の値が true であり、name で指定した属性が存在しない場合は、何も書き込まずに戻します。 デフォルト値は false です。属性が存在しない場合は、ランタイム例外がスローされます。
name 属性名を指定します。
role ユーザーが、指定された役割にない場合に、そのエレメントが無視されます。
importAttribute ignore この属性の値が true であり、name で指定した属性が存在しない場合は、エラーなしで戻します。 デフォルト値は false です。属性が存在しない場合は、ランタイム例外がスローされます。
name インポートする属性の名前を指定します。 デフォルトでは、すべての属性がインポートされます。
scope 属性のインポート先の有効範囲を指定します。 デフォルトは page です。
initComponentDefinitions classname 作成し、かつ初期化するファクトリーのクラス名を 指定します。
file 定義ファイルの名前を指定します。
insert attribute 現在のタイル・コンテキスト内にある属性の名前 を指定します。この属性の値は name に渡されます (下記の説明を参照してください)。
beanName 見つかった Bean またはプロパティー値が 属性クラス (Direct、Instance など) のうちの 1 つのインスタンス である場合は、クラス・タイプに従って挿入します。その他の場合、その Bean の toString メソッドを 呼び出し、挿入時の名前に String クラスを使用します (下記の name を参照してください)。
beanProperty 値が検索される Bean プロパティーの名前を 指定します。この属性は、ネスト済み index プロパティーをサポートします。
beanScope Bean を検索する有効範囲を指定します。 デフォルトでは、メソッド pageContext.findAttribute が使用されます。有効範囲は 任意の JSP の有効範囲、component、または template にすることができます。 最後の 2 つのケースでは、Bean は、タイル・コンテキスト内で検索されます。
component 挿入するタイルの URI を表すストリングを 指定します。
controllerClass ページを挿入する直前に呼び出すコントローラーの Java™ クラス・タイプを指定します。コントローラーは、挿入されるタイルによってレンダリング されるデータを準備します。そのクラスは、以下のクラスのいずれかをインプリメントまたは 拡張する必要があります。
  • org.apache.struts.tiles.Controller
  • org.apache.struts.tiles.ControllerSupport
  • org.apache.struts.action.Action (ラッパー org.apache.struts.action.ActionController を使用)
controllerClasscontrollerUrl と一緒に使用することはできません。
controllerUrl ページを挿入する直前に呼び出すコントローラーの URL を指定します。通常 URL は Struts のアクションを示します。コントローラー (アクション) は、挿入されるタイルによってレンダリングされるデータを 準備します。controllerUrlcontrollerClass と一緒に使用することはできません。
definition 挿入する定義の名前を指定します。定義は、 中央ファイル内で定義されます。この属性は、ファクトリーから得た定義のみを 挿入できます。タグ <tiles:definition> で定義する定義を挿入 できるようにするには、beanName="" を使用してください。
flush true に 設定した場合、挿入する前に現行ページの出力ストリームをフラッシュします。
ignore この属性の値が true であり、name で指定した属性が存在しない場合は、何も書き込まずに戻します。 デフォルト値は false です。属性が存在しない場合は、ランタイム例外がスローされます。
name 挿入するエンティティーの名前を指定します。エンティティー は、定義、属性、タイルの順に検索されます。
page component の同義語です。
role ユーザーが、指定された役割にない場合は、そのタグが無視されます。
template component の同義語です。
put beanName 値を使用する Bean の名前を指定します。この Bean は、指定済みコンテキスト (ある場合) から検索され ます。その他の場合、メソッド pageContext.findAttribute が使用されます。beanProperty を指定すると、 値は、対応する Bean プロパティーから検索されます。
beanProperty 値が検索される Bean プロパティーの名前を 指定します。この属性は、ネスト済み index プロパティーをサポートします。
beanScope Bean を検索する有効範囲を指定します。 デフォルトでは、メソッド pageContext.findAttribute が使用されます。有効範囲は 任意の JSP の有効範囲、component、または template にすることができます。 最後の 2 つのケースでは、Bean は、タイル・コンテキスト内で検索されます。
content value の同義語です。
direct コンテンツの処理方法を指定します。true はコンテンツがファイルに含まれていることを意味します。false (デフォルト) はコンテンツが他の場所から組み込まれることを意味します。 これは、 コンテンツ・タイプを指定するもう 1 つの方法です。true を指定すると、コンテンツはストリングと解釈されます。その他の場合、コンテンツはページと解釈されます。 この属性は、JSP テンプレートとの互換性を持つために存在します。
name 書き込む属性の名前を指定します。
role ユーザーが、指定された役割にない場合は、そのタグが無視されます。
type 以下のコンテンツ・タイプのいずれかを指定します。
definition
ファクトリー (XML ファイル) 内に定義する定義を指定します。この定義 は、<insert attribute="attributeName"> タグに入れて、挿入されているタイル内で検索されます。 ここで、attributeName はこのタグに使用される名前です。
page
指定済み URL からのコンテンツを組み込みます。この属性の同義語は、template です。
string
コンテンツを直接提供します。
type 属性を省略すると、 コンテンツは、型付き Bean からのものでない限り、型なしになります。
value 属性値をストリングまたはオブジェクトで 指定します。valuecontent、 または beanName を指定しなければなりません。
putList name リストの名前を指定します。
useAttribute classname 宣言済み変数のクラスを指定します。
id 宣言済み属性および変数名を指定します。
ignore この属性の値が true であり、name で指定した属性が存在しない場合は、エラーなしで戻します。 デフォルト値は false です。属性が存在しない場合は、ランタイム例外がスローされます。
name タイルの属性名を指定します。
scope 宣言済み属性の有効範囲を指定します。デフォルトは page です。
関連タスク
JSP ファイルへの Struts タグの追加
関連資料
Struts Bean タグのプロパティー
Struts HTML タグのプロパティー
Struts 論理タグのプロパティー
Struts ネスト・タグのプロパティー
Struts タグのプロパティー
ご利用条件 | フィードバック
(C) Copyright IBM Corporation 1999, 2004. All Rights Reserved. (C) Copyright IBM Japan 2005