この文書では、Struts HTML タグ・ライブラリーで定義されるエレメントのプロパティーについて説明します。デフォルトでは、これらの各エレメントの名前には html: 接頭部が付きます。
それぞれの Struts エレメントには、エレメントの「プロパティー」ビューを使用して設定できる多くのプロパティーがあります。エレメントの「プロパティー」ビューでの作業中に、さらに詳しい情報が必要なプロパティーがあった場合は、次のプロパティーの表を参照してください。 プロパティーの中には、名前が同じでも、異なるエレメントでは使用法が異なるものがあります。プロパティーはアルファベット順にリストされています。
プロパティー | エレメント内部 | 説明 |
---|---|---|
accept | file | ユーザーが実行依頼するサーバーが処理方法を認識できるように、 コンマで区切られたコンテンツ・タイプ・リストを指定します。このリストは、クライアント・ブラウザー が選択できるファイル・オプションのセットを制限する ために使用されます。デフォルトでは、コンテンツ・タイプ・リストは送信されません。 |
accesskey | button、cancel、checkbox、file、hidden、image、link、 multibox、password、radio、reset、submit、text、textarea | このエレメントに直ちにフォーカスを移動するために使用するキーボード文字を指定します。 |
action | form、frame、link | この転送の宛先の実コンテンツ相対 URI を含むグローバル・アクション の論理名を指定します。action、forward、href、または page の属性のうちいずれかを指定しなければなりません。paramId 属性または name 属性を追加すれば、このハイパーリンクを動的に変更することができます。 [form の場合は必須] |
align | image | このイメージの位置合わせを指定します。 非推奨: この属性は HTML 4 では使用すべきではありません。代わりに CSS の使用を推奨します。詳しくは、www.w3.org/TR/REC-html40/struct/objects.html#h-13.7.4 を参照してください。
|
align | img | 以下の値のいずれかを用いてイメージの位置合わせ方法を指定します。
|
alt | button、cancel、checkbox、file、hidden、image、img、 multibox、password、radio、reset、select、submit、text、textarea | コンポーネントの代替テキストを指定します。この代替テキスト は、ブラウザーが、フォームをサポートしていない、イメージを表示しないように設定 されているなど、エレメントが正常にレンダリングされない場合にコンテンツとして機能します。 |
altKey | button、cancel、checkbox、file、hidden、image、img、 multibox、password、radio、reset、select、submit、text、textarea | このエレメント用の代替テキストのメッセージ・リソース・キー を指定します。 |
anchor | frame、link、include、rewrite | 生成済みハイパーリンクに追加するオプションのアンカー・タグを指定します。属性値に番号記号 (#) を指定しないでください。 |
border | image、img | イメージの周囲の枠の幅 (ピクセル単位) を 指定します。 |
bundle | errors、image、img、messages、option | 使用する MessageResources インスタンスの サーブレット・コンテキスト属性キーを指定します。このキーは、アクション・サーブレットに 構成されているアプリケーション・リソースにデフォルト設定します。 |
cdata | javascript | true に設定され、かつ XHTML が使用可能になっている場合に、XML 構文解析を防ぐために、CDATA セクションの JavaScript™ コードを折り返します。デフォルトは、W3C の勧告に従って true です。 |
collection | options | (ある有効範囲の) JSP Bean の名前を指定します。これは、他の Bean のコレクションであり、各 Bean は、それぞれのオプションに対して、値およびラベルの検索で使用する property および labelProperty 属性で指定されるプロパティーを持っています。 |
cols | textarea | 表示するカラム数を指定します。 |
disabled | button、cancel、checkbox、file、image、option、multibox、 password、radio、reset、select、submit、text、textarea | true に設定すると、 入力フィールドが使用不可になります。 |
dynamicJavascript | javascript | false に設定すると、動的 JavaScript コードのレンダリングを行いません。デフォルトは true です。 |
enctype | form | メソッドが POST の場合に、このフォームの送信に使用されるコンテンツのエンコード方式 を指定します。ファイル・タグを使用してファイル・アップロードを使用できるようにする場合は、 これを multipart/form-data に設定する必要があります。この属性を 省略すると、ブラウザーのデフォルト (通常は application/x-www-form-urlencoded) が使用されます。 |
filter | options、optionsCollection | false に設定すると、HTML で区別される文字のオプション・ラベルのフィルターを抑制します。デフォルトでは、このような値は、それぞれの同等なエンティティーに変換されます。 |
focus | form | (このフォーム上にあるフィールドの中から) JavaScript 関数で初期フォーカスを割り当てるフィールド名を指定します。この属性を省略すると、この目的での特殊な JavaScript コードのレンダリングは行われません。 |
focusIndex | form | フォーカス・フィールドがラジオ・ボタン・グループなどのフィールド配列 の場合、フォーカスを受け取る配列内の索引を指定します。 |
footer | messages | メッセージの反復の終了後に印刷されるオプションのメッセージ・リソース・キーを指定します。 |
formName | javascript | 妥当性検査規則の特定のセットを検索するためのキー (フォーム名 ) を 指定します。 |
forward | frame、include、rewrite | この転送の宛先の実コンテンツ相対 URI を含むグローバル ActionForward の論理名を指定します。action、forward、href、または page の属性のうちいずれかを指定しなければなりません。 paramId 属性または name 属性を追加すれば、このハイパーリンクを動的に変更することができます。 |
frameborder | frame | 1 に設定すると、このフレームの周囲に フレーム枠を生成します。デフォルトは 0 です。 |
frameName | frame | レンダリングされた frame エレメント の name 属性の値を指定します。 |
header | messages | メッセージの反復の開始前に印刷されるオプションのメッセージ・リソース・ キーを指定します。 |
height | img | 表示されるイメージの高さを指定します。この属性を width と一緒に指定すると、ブラウザーによるページのレンダリングが 高速になります。 |
href | frame、link、include、rewrite | このハイパーリンクが、アクティブな場合に制御権を移動 する先の URL を指定します。action、forward、href、または page の属性のうちいずれかを指定しなければなりません。paramId 属性または name 属性を追加すれば、このハイパーリンクを動的に変更することができます。 |
hspace | img | イメージとテキストの間の水平方向余白の量を指定します。テキストをイメージと同じパラグラフに入れたり、イメージの周りで折り返したりすることができます。 |
htmlComment | javascript | JavaScript コードを HTML コメントで囲むかどうかを指定します。この属性は XHTML モードでは無視されます。スクリプトが XML パーサーによって削除されるためです。スクリプトを XML パーサーから隠す方法について詳しくは、cdata 属性を参照してください。デフォルトは true です。 |
id | messages | 反復ごとに、メッセージのコレクションの現行エレメントを含むページの有効範囲 JSP Bean の必須名を指定します (NULL でない場合)。[必須] |
idName | radio | radio タグの値を戻す (ある有効範囲の) Bean の名前を 指定します。通常はイテレーターによって公開される idName 属性がある場合、この反復でラジオ・タグの値を戻す idName Bean 上 のプロパティーの名前として value 属性が使用されます。 |
imageName | img | ユーザーがこのページ内のスクリプトから参照できるように ページ内で定義される名前を指定します。ここで指定した値は、 生成された img エレメント内の name 属性の値になります。 |
indexed | button、checkbox、file、hidden、image、password、radio、 select、submit、text、textarea | logic:iterate タグ内部でのみ有効です。 true の場合、html タグの名前が propertyName[int] としてレンダリングされます。ここで、int は反復のたびに生成され、祖先 logic:iterate タグから取得されます。 |
indexed | link | logic:iterate タグ内部でのみ有効です。 true の場合、indexId 属性からの名前付き indexed パラメーターを照会ストリングに追加します。 indexed パラメーターは、index[int] のように なります。ここで、int は反復のたびに生成され、 祖先 logic:iterate タグから取得されます。 |
indexId | link | indexed パラメーターに対して異なる名前を指定します。詳しくは、indexed 属性を参照してください。 |
ismap | img | このイメージが属するサーバー・サイド・マップの名前を 指定します。 |
key | option | 指定すると、このオプションについてユーザーに表示されるテキスト 用に、bundle で指定したリソース・バンドル内で検索するメッセージ・キーを定義します。デフォルトでは、表示されるテキストをこのタグの 本体コンテンツから取得します。 |
label | optionsCollection | オプションごとにレンダリングされるラベルを表す コレクション内の Bean のプロパティーを指定します。デフォルトは label です。 |
labelName | options | これらのオプションに対して、ユーザーに表示されるラベルのコレクションを含む (ある有効範囲の) JSP Bean の名前を指定します。 |
labelProperty | options | これらのオプションに対して、 ユーザーに表示されるラベルのコレクションを戻すフォーム Bean (すなわち、labelName 属性によって指定 された Bean) のプロパティーを指定します。 |
linkName | link | このページ内のハイパーリンクが参照できるように ページ内で定義されるアンカー名を指定します。ここで指定した値は、 生成済み anchor タグ内の name 属性の値になります。 |
locale | errors、image、img、messages、option | 国際化メッセージの検索に使用する要求またはセッション の locale 属性の値を指定します。 |
locale | html | 何も設定されていない状態で true に
設定すると、現在の要求の Accept-Language ヘッダー (ある場合) に基づいて、セッションにロケールを保管します。セッションがまだ存在していない場合、この属性がそれを作成します。lang 属性には
適切な言語コードが割り当てられます。 非推奨: セッションをサポートしないアプリケーションに対してセッションを作成することは
望ましくありません。セッションを作成せずに同じ結果を得るには、lang 属性を使用してください。
|
longdesc | frame | フレームの詳細説明の URI を指定します。この説明は、title 属性によって提供される簡略説明を補足するもので、特に 非ビジュアルのユーザー・エージェントに役立ちます。 |
lowsrc | img | 低解像度のグラフィックス・カードを所有するユーザー用のイメージ
を指定します。 非推奨: この属性は
HTML 4.01 仕様では定義されておらず、Struts の将来のバージョンでは削除される
予定です。
|
marginheight | frame | フレームのコンテンツとその上部および下部マージンの間に残しておくスペース量 (ピクセル単位)を指定します。 |
marginwidth | frame | フレームのコンテンツとその左および右マージンの間に残しておくスペース量 (ピクセル単位)を指定します。 |
maxlength | file、password、text | 受け入れ可能な最大入力文字数を 指定します。 |
message | messages | true に設定すると、Globals.MESSAGE_KEY 定数ストリングから Bean を取り出します。name 属性に割り当てられている値は無視されます。デフォルトでは、 このタグは、Globals.ERROR_KEY 定数ストリングから反復される Bean を 取り出します。 |
method | form、javascript | この要求を実行依頼するために使用される HTTP メソッド (GET または POST) を指定します。 |
multiple | select | 受け入れ可能な最大入力文字数を 指定します。 |
name | checkbox、errors、file、form、frame、hidden、img、link、 messages、multibox、options、password、radio、rewrite、select、text、textarea、 include | 照会パラメーターを表すマップを含む JSP Bean の名前 (property を 指定しない場合)、あるいはマップを戻すために呼び出されるプロパティー getter を含む JSP Bean の名前 (property を指定する場合) を指定します。 |
name | optionsCollection | この入力フィールドの現行値のレンダリング時に相談 されるプロパティーを含む Bean の属性名を指定します。デフォルトでは、 その内部でこのエレメントがネストされているフォーム・タグと関連付けられている Bean が使用されます。 |
noresize | frame | true に設定すると、ユーザーによるフレームのサイズ変更を防ぎます。デフォルトは false です。 |
onblur | button、cancel、checkbox、file、hidden、image、link、 multibox、password、radio、reset、select、submit、text、textarea | このエレメントが入力フォーカスを失うと、JavaScript イベント・ハンドラー を実行します。 |
onchange | button、cancel、checkbox、file、hidden、image、multibox、 password、radio、reset、select、submit、text、textarea | このエレメントが入力フォーカスを失い、その値が 変更されていると、JavaScript イベント・ハンドラーを実行します。 |
onclick | button、cancel、checkbox、file、hidden、image、img、 link、link、multibox、password、radio、reset、select、submit、text、textarea | このエレメントがマウスでクリックされると、JavaScript イベント・ハンドラーを実行します。 |
ondblclick | button、cancel、checkbox、file、hidden、image、img、 link、multibox、password、radio、reset、select、submit、text、textarea | このエレメントがマウスでダブルクリックされると、JavaScript イベント・ハンドラーを実行します。 |
onfocus | button、cancel、checkbox、file、hidden、image、link、 multibox、password、radio、reset、select、submit、text、textarea | このエレメントが入力フォーカスを受け取ると、JavaScript イベント・ハンドラーを実行します。 |
onkeydown | button、cancel、checkbox、file、hidden、image、img、 link、multibox、password、radio、reset、select、submit、text、textarea | このエレメントがフォーカスを持ち、キーが押されると、JavaScript イベント・ハンドラーを実行します。 |
onkeypress | button、cancel、checkbox、file、hidden、image、img、 link、multibox、password、radio、reset、select、submit、text、textarea | このエレメントがフォーカスを持ち、キーが押されて 放されると、JavaScript イベント・ハンドラーを実行します。 |
onkeyup | button、cancel、checkbox、file、hidden、image、img、 link、multibox、password、radio、reset、select、submit、text、textarea | このエレメントがフォーカスを持ち、キーが放されると、JavaScript イベント・ハ ンドラーを実行します。 |
onmousedown | button、cancel、checkbox、file、hidden、image、img、 link、multibox、password、radio、reset、select、submit、text、textarea | このエレメントがマウス・ポインターの下にあり、 マウス・ボタンが押されると、JavaScript イベント・ハンドラーを実行します。 |
onmousemove | button、cancel、checkbox、file、hidden、image、img、 link、multibox、password、radio、reset、select、submit、text、textarea | このエレメントがマウス・ポインターの下にあり、 そのポインターが移動すると、JavaScript イベント・ハンドラーを実行します。 |
onmouseout | button、cancel、checkbox、file、hidden、image、link、 multibox、password、radio、reset、select、submit、text、textarea | このエレメントがマウス・ポインターの下にあり、 そのポインターがエレメントの外側に移動すると、JavaScript イベント・ハンドラーを実行します。 |
onmouseover | button、cancel、checkbox、file、hidden、image、link、 multibox、password、radio、reset、select、submit、text、textarea | このエレメントがマウス・ポインターの下になく、そのポインターがエレメントの内側に移動すると、JavaScript イベント・ハンドラーを実行します。 |
onmouseup | button、cancel、checkbox、file、hidden、image、link、 multibox、password、radio、reset、select、submit、text、textarea | このエレメントがマウス・ポインターの下にあり、マウス・ボタンが放されると、JavaScript イベント・ハンドラーを実行します。 |
onreset | form | フォームがリセットされると、JavaScript イベント・ハンドラーを実行します。 |
onsubmit | form | フォームが送信されると、JavaScript イベント・ハンドラーを実行します。 |
page | frame、image、img、javascript、link、include、rewrite | このハイパーリンク (アクティブな場合) が制御権を移動する先のモジュール相対パス (スラッシュ (/) で始める) を指定します。 action、forward、href、または page の属性のうちいずれかを指定しなければなりません。 paramId 属性または name 属性を追加すれば、このハイパーリンクを動的に変更することができます。 |
pageKey | image、img | この入力タグに対して、イメージのモジュール相対パスを指定しているメッセージ・リソース・ストリングのキーを指定します。 |
paramId | frame、img、link、rewrite | 生成済みハイパーリンクに動的に追加する要求パラメーターの名前を指定します。対応する値は paramName および (オプション) paramProperty 属性で定義され、オプションで paramScope 属性でスコープされます。 |
paramName | frame、img、link、rewrite | paramId で指定した要求パラメーターの値を含む String である JSP Bean の名前 (paramProperty を省略する場合)、あるいは String を戻すために呼び出されるプロパティー getter を含む JSP Bean の名前 (paramProperty を指定する場合) を指定します。 JSP Bean は、paramScope プロパティーで指定されている Bean の有効範囲に制限されます (指定されている場合)。 |
paramProperty | frame、img、link、rewrite | paramName 属性で指定した Bean の プロパティー名を指定します。この場合の戻り値は、 このハイパーリンクに動的に追加される (paramId 属性で指定した) 要求パラメーター の値を含む String でなければなりません。 |
paramScope | frame、img、link、rewrite | paramName 属性で指定した Bean を検索する有効範囲を指定します。デフォルトでは 全有効範囲が検索対象となります。 |
property | button、checkbox、file、multibox、password、select | 指定した値に設定される、この実行依頼に入れられる要求パラメーターの 名前を指定します。[必須] |
property | cancel | 指定した値に設定される、この実行依頼に入れられる要求パラメーターの
名前を指定します。 重要: この属性をデフォルト以外の値に設定すると、Struts コントローラー・サーブレットまたは Action.isCancelled() メソッドでは、取り消しキーとして認識されません。
ユーザーが独自の取り消しの検出を行うことが必要になります。
|
property | errors | エラー・メッセージを表示させるプロパティーの 名前を指定します。デフォルトでは、(プロパティーに関係なく) すべてのエラー・メッセージ が表示されます。 |
property | frame、img、link、rewrite | name 属性で指定した Bean のプロパティーの 名前を指定します。この場合の戻り値は、ハイパーリンクに追加される照会パラメーターを含む java.util.Map クラス でなければなりません。この属性を指定する場合は、name 属性も指定しなければなりません。 |
property | hidden | value を指定しない場合は、 入力フィールドの名前と対応する Bean プロパティーの名前を 指定します。対応する Bean プロパティー (ある場合) はタイプ String でなければなりません。 [必須] |
property | image | このイメージ・タグのプロパティー名を指定します。要求のパラメーター名は、property.x および property.y と表示されます。この x と y は、イメージのマウス・クリックの座標を表します。このような値をフォーム Bean から取り出すには、getX()、getY()、setX()、および setY() メソッドを定義して、プロパティーを 空ストリング (property="") に指定します。 |
property | messages | メッセージを表示させるプロパティーの 名前を指定します。デフォルトでは、(プロパティーに関係なく) すべてのメッセージ が表示されます。 |
property | options | これらのオプションに対して、 サーバーに戻される値のコレクションを戻すフォーム Bean (すなわち、name 属性で指定 された Bean) のプロパティーを指定します。 |
property | radio | このラジオ・タグに対する対応する Bean プロパティー を指定します。[必須] |
property | reset | 生成される入力フィールドの名前を指定します。 |
property | text、textarea | value を指定しない場合は、 入力フィールドの名前と対応する Bean プロパティーの名前を 指定します。対応する Bean プロパティー (ある場合) はタイプ String でなければなりません。 [必須] |
readonly | password、text、textarea | true に設定すると、この入力フィールドは読み取り専用になります。 |
redisplay | password | false に設定すると、既存値が再表示されないことを示します。可視の HTML ページ上では再表示される値が アスタリスクで表示されますが、実際のパスワード値の平文は、クライアント・ブラウザー の「ページ・ソースの表示 (Show Page Source)」メニュー・オプションから見ることができます。デフォルトは true です。ログイン・ページで値を false に設定することもできます。 |
rows | textarea | 表示する行数を指定します。 |
scope | frame、img、link、rewrite | name 属性で指定した Bean を検索する有効範囲を指定します。デフォルトでは 全有効範囲が検索対象となります。 |
scrolling | frame | スクロール・バーを無条件に作成する (yes) か、まったく作成しない (no) か、あるいは必要なときにのみ作成する (auto) か、を指定します。 |
server | base | request.getServerName() の代わりに使用するサーバー名を指定します。 |
size | file、password、select、text | 割り振る文字位置の数を指定します。 |
src | frame、image、img、javascript | この入力タグに対して、イメージのソース URL を指定 します。 |
srcKey | image、img | この入力タグに対して、イメージのソース URL を指定しているメッセージ・リソース・ストリングのキーを指定します。 |
staticJavascript | javascript | 静的 JavaScript コードをレンダリングするかどうかを指定します。デフォルトは true です。 |
style | button、cancel、checkbox、file、form、frame、hidden、 image、img、link、multibox、option、options、optionsCollection、password、 radio、reset、select、submit、text、textarea | コンポーネントに対して CSS スタイル情報を指定します (例えば 、style="font-size : 8pt ; color : red")。 |
styleClass | button、cancel、checkbox、file、form、frame、hidden、 image、img、link、multibox、option、options、optionsCollection、password、 radio、reset、select、submit、text、textarea | この HTML エレメントに適用する CSS stylesheet のクラスを指定します。これにより、class 属性が作成されます。 |
styleId | button、cancel、checkbox、file、form、frame、hidden、 image、img、link、multibox、option、password、radio、reset、select、submit、 text、textarea | この HTML エレメントに割り当てる ID を指定します。これにより、id 属性が作成されます。 |
tabindex | button、cancel、checkbox、file、image、link、multibox、 password、radio、reset、select、submit、text、textarea | このエレメントのタブ順序 (正の整数の昇順) を 設定します。 |
target | base、form、link | フレーム付きでの表示など、このフォームの送 信先のウィンドウ・ターゲットを指定します。 |
title | button、cancel、checkbox、file、frame、hidden、image、 img、link、multibox、password、radio、reset、select、submit、text、textarea | このエレメント用の通知タイトルを指定します。 |
titleKey | button、cancel、checkbox、file、frame、hidden、image、 img、link、multibox、password、radio、reset、select、submit、text、textarea | このエレメント用の通知タイトルに対するメッセージ・リソース・キーを 指定します。 |
transaction | frame、link、include、rewrite | true に設定すると、生成済みハイパーリンクに現在のトランザクション制御トークンを組み込んで、受信アクション内で isTokenValid() テストを渡せるようにします。 |
type | form | 作成するフォームのタイプを示すフォーム Bean クラスの名前を指定します。 |
usemap | img | このイメージのホット・スポット・エリアのマッピングのために、このページ内に定義 されたマップ名を指定します。 |
value | button、cancel、image、password、radio、reset、submit | このボタンに付けられるラベルの値を 指定します。この値は、指定した要求パラメーターの値としても送信 されます。 |
value | checkbox、multibox | フォームの送信時にチェック・ボックスがチェックされている場合に送信される値を指定します。デフォルトでは、チェック・ボックスがチェックされていると、 値 on が戻されます。 |
value | file、hidden、text、textarea | このフィールドが初期化される値を指定します。 |
value | option | ユーザーによってこのオプションが選択されてい る場合に、このフィールド用に送信される値を指定します。[必須] |
value | optionsCollection | 各オプションに対してレンダリングされる値を表す、コレクション内の Bean のプロパティーを指定します。デフォルトは value です。 |
value | select | 選択したオプションのマーキングのために比較する値を 指定します。 |
vspace | img | イメージとテキストの間の上下の垂直方向余白の量を指定します。 |
width | img | 表示するイメージの幅を指定します。この属性を height と一緒に指定すると、ブラウザーによるページのレンダリングが 高速になります。 |
write | hidden | true に設定すると、HTML type="hidden" エレメントを作成するだけでなく、このフィールドの値を応答ページにレンダリングして可視にします。デフォルトでは、 隠しエレメントのみが作成されます。 |
xhtml | html | true に設定すると、生成済み html エレメントの xml:lang 属性および xmlns 属性をレンダリングします。さらに、これにより、 他のすべての html タグが XHTML 1.0 としてレンダリングします。(<html:xhtml/> タグにも 同様の目的があります。) |