Struts は HTTP リクエストの解析と、 サブミットされたリクエストパラメータのJava ビーンへの設定を行います。 このJava ビーンは、初期値を含むフォームの値の設定にも利用されます。 また、自動的なフォームの検証コードをフックさせることもできます。

FormTool はフォームや、 Struts アプリケーションのコンテキスト内のフォームビーンを扱うさまざまなメソッドを提供します。

<tool>
  <key>form</key>
  <scope>request</scope>
  <class>org.apache.velocity.tools.struts.FormTool</class>
</tool>

Method Overview

getBean()	Retrieve and return the form bean associated with this request.
getCancelName()	Returns the query parameter name under which a cancel button press must be reported if form validation is to be skipped.
getToken()	Retrieves and returns the transaction control token for this session.
getTokenName()	Returns the query parameter name under which a transaction token must be reported.

Method Overview

getBean()	リクエストに関連するフォームビーンを取得し、返却します。
getCancelName()	キャンセルボタンが押下された場合の、 フォームの自動バリデーションのスキップを通知するクエリパラメータの名称を返却します。
getToken()	現在のセッションのトランザクション制御トークンを取得し、返却します。
getTokenName()	トランザクショントークンを通知するクエリパラメータの名称を返却します。

## Populating an input field with a default value
<input type="text" name="username" value="$form.getBean().username">

## The same can be written as
<input type="text" name="username" value="$form.bean.username">

## For repeated use create a local reference
#set ($defaults = $form.bean) 
<input type="text" name="username" value="$defaults.username">

## Accessing the form using the form name defined in struts-config.xml
## Velocity searches the request and session attributes for loginForm
<input type="text" name="username" value="$loginForm.username">

リクエストに関連するフォームビーンを取得し、返却します。

ActionForm getBean()

Returns

request/sessionに関連する ActionForm 、 関連するフォームビーンがマッピングに無い場合は null 。

これは簡易メソッドです。 フォームビーンは、Velocity コンテキストから Struts の設定で定義した名称で自動的に利用できます。

フォームビーンを繰り返し使用する場合、 毎回 getBean() を呼び出すより、ローカル変数を作成して参照すると良いでしょう。

## インプットフィールドにデフォルト値を設定し、値を取得します
<input type="text" name="username" value="$form.getBean().username">

## こう書いても上と同じです
<input type="text" name="username" value="$form.bean.username">

## 繰り返し参照する場合はローカル変数として定義します
#set ($defaults = $form.bean) 
<input type="text" name="username" value="$defaults.username">

## struts-config.xml で定義されたフォームの名前を使用してフォームへアクセスします
## Velocity は loginForm を request や session の属性(attribute)から検索します
<input type="text" name="username" value="$loginForm.username">

## A cancel button
<input type="submit" name="$form.getCancelName()" value="Cancel">

## Can also be written as
<input type="submit" name="$form.cancelName" value="Cancel">

<input type="submit" name="org.apache.struts.taglib.html.CANCEL"
value="Cancel">

キャンセルボタンが押下された場合の、 フォームの自動バリデーションのスキップを通知するクエリパラメータの名称を返却します。

int getCancelName()

Returns

org.apache.struts.taglib.html.Constants.CANCEL_PROPERTY の値。

リクエストパラメータのキーにこのメソッドの返却値と同じ値が含まれていた場合、フォームの自動バリデーションがスキップされます。 一般的なアプリケーションでは、フォームのキャンセルボタンの name 属性でこの「おまじない」を使います。 このボタンが押下された場合、フォームの自動バリデーションがスキップされます。 もしフォームの自動バリデーションを行っていない場合、この「おまじない」は何の意味もありません。

## キャンセルボタン
<input type="submit" name="$form.getCancelName()" value="Cancel">

## これはこのようにも書けます
<input type="submit" name="$form.cancelName" value="Cancel">

これは以下の出力を生成します:

<input type="submit" name="org.apache.struts.taglib.html.CANCEL"
value="Cancel">

現在のセッションのトランザクション制御トークンを取得し、返却します。

String getToken()

Returns

トークン String 、またはトークンが存在しない場合 null 。

See Also

getTokenName() メソッドに例があります。

## A hidden form field with the transaction token
<input type="hidden" name="$form.getTokenName()"
value="$form.getToken()">

## Can also be written as
<input type="hidden" name="$form.tokenName"
value="$form.token">

<input type="hidden" name="org.apache.struts.taglib.html.TOKEN" 
value="84c29b4dea56ecf69524ef6b965c5e80">

トランザクショントークンを通知するクエリパラメータの名称を返却します。

int getTokenName()

Returns

org.apache.struts.taglib.html.Constants.TOKEN_KEY の値。

See Also

トランザクショントークンの仕組みの詳細については org.apache.struts.action.Action クラスの JavaDoc を参照してください (この Struts の機能のドキュメントとして、これより良いものを私は知りません)。

## トランザクショントークンの hidden フィールド
<input type="hidden" name="$form.getTokenName()"
value="$form.getToken()">

## これはこのようにも書けます
<input type="hidden" name="$form.tokenName()"
value="$form.token()">

このような出力が生成されます:

<input type="hidden" name="org.apache.struts.taglib.html.TOKEN" 
value="84c29b4dea56ecf69524ef6b965c5e80">