Struts Tiles タグの属性

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

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

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

<tiles:add />
<tiles:definition />
<tiles:get />
<tiles:getAsString />
<tiles:importAttribute />
<tiles:initComponentDefinitions />
<tiles:insert />
<tiles:put />
<tiles:putList />
<tiles:useAttribute />

Add

表 1. Add 要素プロパティー
属性	説明
beanName	値を使用する Bean の名前を指定します。この Bean は、指定済みコンテキスト (ある場合) から検索されます。その他の場合、メソッド pageContext.findAttribute が使用されます。`beanProperty` を指定すると、値は、対応する Bean プロパティーから検索されます。
beanProperty	値が検索される Bean プロパティーの名前を指定します。この属性は、ネスト済み index プロパティーをサポートします。
beanScope	Bean を検索する有効範囲を指定します。デフォルトでは、メソッド pageContext.findAttribute が使用されます。有効範囲は任意の JavaServer Pages (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

表 2. Definition タグ属性
属性	説明
extends	この新規定義を初期化するために使用する親定義の名前を指定します。親定義は、定義ファクトリー内で検索されます。
id	新規に作成された定義 Bean を保存するために使用する名前を指定します。
page	挿入するタイルのレイアウト・ファイル (JSP ファイルのタイプ) の URL を指定します。
role	この定義を挿入する前に検査する役割を指定します。役割が現在のユーザーに定義されていない場合は、定義は挿入されません。検査は、定義プロセス中にではなく、挿入時に行われます。
scope	新規に定義された Bean を作成する変数の有効範囲を指定します。この属性を省略すると、Bean はページの有効範囲内に作成されます。
template	`page` の同義語です。

ページの先頭に戻る。

Get

表 3. Get 要素プロパティー
属性	説明
flush	`true` の場合は、新規ページを挿入する前に現行ページの出力ストリームをフラッシュします。デフォルトは `false` です。
ignore	この属性の値が `true` であり、`name` で指定したコンテンツが存在しない場合は、何も書き込まずに戻します。デフォルト値は、`false` です。デフォルト値では、`name` コンテンツが存在しない場合に、ランタイム例外がスローされます。
name	タイルの有効範囲から取得するコンテンツの名前を指定します。
role	ユーザーが、指定された役割にない場合に、その要素が無視されます。

ページの先頭に戻る。

Get As String

表 4. Get As String タグ属性
属性	説明
ignore	この属性の値が `true` であり、`name` で指定した属性が存在しない場合は、何も書き込まずに戻します。デフォルト値は、`false` です。デフォルト値では、属性が存在しない場合、ランタイム例外がスローされます。
name	属性名を指定します。
role	ユーザーが、指定された役割にない場合に、その要素が無視されます。

ページの先頭に戻る。

Import 属性

表 5. Import 属性タグ属性
属性	説明
ignore	この属性の値が `true` であり、`name` で指定した属性が存在しない場合は、エラーなしで戻します。デフォルト値は、`false` です。デフォルト値では、属性が存在しない場合、ランタイム例外がスローされます。
name	インポートする属性の名前を指定します。デフォルトでは、すべての属性がインポートされます。
scope	属性のインポート先の有効範囲を指定します。デフォルトは `page` です。

ページの先頭に戻る。

Init コンポーネント定義

表 6. Init コンポーネント定義要素プロパティー
属性	説明
classname	作成し、かつ初期化するファクトリーのクラス名を指定します。
file	定義ファイルの名前を指定します。

ページの先頭に戻る。

Insert

表 7. Insert タグ属性
属性	説明
attribute	現在のタイル・コンテキスト内にある属性の名前を指定します。この属性の値は `name` に渡されます (下記の説明を参照してください)。
beanName	見つかった Bean またはプロパティー値が属性クラス (Direct、Instance など) のうちの 1 つのインスタンスである場合は、クラス・タイプに従って挿入します。その他の場合、その Bean で toString メソッドが呼び出されます。戻された String クラスが、挿入する名前として使用されます (下記の `name` を参照してください)。
beanProperty	Bean プロパティーの名前を指定します。このタグは、ネスト済み index プロパティーをサポートします。
beanScope	Bean 検索の有効範囲を指定します。指定されていない場合は、メソッド `pageContext.findAttribute` が使用されます。有効範囲は、任意の JSP の有効範囲、コンポーネント、またはテンプレートにすることができます。コンポーネントおよびテンプレートの場合は、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 を使用) `controllerClass` を `controllerUrl` と一緒に使用することはできません。
controllerUrl	ページを挿入する直前に呼び出すコントローラーの URL を指定します。通常 URL は Struts のアクションを示します。コントローラー (アクション) は、挿入されるタイルによってレンダリングされるデータを準備します。`controllerUrl` を `controllerClass` と一緒に使用することはできません。
definition	挿入する定義の名前を指定します。定義は、中央ファイル内で定義されます。この属性は、ファクトリーから得た定義のみを挿入できます。`<tiles:definition>` タグで定義された定義を挿入するには、`beanName=""` を使用してください。
flush	`true` に設定した場合、挿入する前に現行ページの出力ストリームをフラッシュします。
ignore	この属性の値が `true` であり、`name` で指定した属性が存在しない場合は、何も書き込まずに戻します。デフォルト値は、`false` です。デフォルト値では、属性が存在しない場合、ランタイム例外がスローされます。
name	挿入するエンティティーの名前を指定します。エンティティーは、定義、属性、タイルの順に検索されます。
page	`component` の同義語です。
role	ユーザーが、指定された役割にない場合は、そのタグが無視されます。
template	`component` の同義語です。

ページの先頭に戻る。

Put

表 8. Put 要素プロパティー
属性	説明
beanName	値を使用する Bean の名前を指定します。この Bean は、指定済みコンテキスト (ある場合) から検索されます。その他の場合、メソッド pageContext.findAttribute が使用されます。`beanProperty` を指定すると、値は、対応する Bean プロパティーから検索されます。
beanProperty	Bean プロパティーの名前を指定します。このタグは、ネスト済み index プロパティーをサポートします。
beanScope	Bean 検索の有効範囲を指定します。指定されていない場合は、メソッド `pageContext.findAttribute` が使用されます。有効範囲は、任意の JSP の有効範囲、コンポーネント、またはテンプレートにすることができます。コンポーネントおよびテンプレートの場合は、Bean は、タイル/コンポーネント/テンプレートのコンテキストで検索されます。
content	`value` の同義語です。
direct	コンテンツの表示方法を指定します。
name	書き込む属性の名前を指定します。
role	ユーザーが、指定された役割にない場合は、そのタグが無視されます。
type	コンテンツ・タイプを指定します。 string コンテンツは直接印刷されます。 page、template コンテンツは指定済み URL から組み込まれます。 definition 値は、ファクトリーで定義された定義を意味します。定義は、`<insert attribute="attributeName">` タグの挿入されたタイルで検索されます。ここで、`attributeName` は、このタグに使用される名前です。
value	属性値をストリングまたはオブジェクトで指定します。`value`、`content`、または `beanName` を指定しなければなりません。

ページの先頭に戻る。

Put リスト

表 9. Put リスト・タグ属性
属性	説明
name	リストの名前を指定します。

ページの先頭に戻る。

Use 属性

表 10. Use 属性タグ属性
属性	説明
classname	宣言済み変数のクラスを指定します。
id	宣言済み属性および変数名を指定します。
ignore	この属性の値が `true` であり、`name` で指定した属性が存在しない場合は、エラーなしで戻します。デフォルト値は、`false` です。デフォルト値では、属性が存在しない場合、ランタイム例外がスローされます。
name	タイル機能の属性名を指定します。
scope	宣言済み属性の有効範囲を指定します。デフォルトは `page` です。

ページの先頭に戻る。

フィードバック