このツールは Struts のエラーメッセージを提供します。 エラーはサブミットされたフォームの検証中、あるいはリクエストの処理中に発生します。 エラーが起きた場合、ビューへの出力を生成できるようになります。 エラーについて抑えておくべき重要な点は:

• エラーメッセージはメッセージリソースから取得されます。 国際化されたメッセージの提供がサポートされています。
• エラーメッセージは置換パラメータを5つまで持つことができます。
• エラーはエラーカテゴリを示す property 属性を持ちます。 これはビューデザイナがエラーが発生した場所に適切にエラーメッセージを配置することを可能にします。 例えば、ページの全体に対してのエラーはページの一番上に表示し、 特定の入力フィールドに対してのエラーはこの入力フィールドの隣りに表示することができます。 このツールのいくつかのメソッドは、処理対象とする特定のエラーカテゴリを選択できる property パラメータを提供します。 property パラメータを指定しない場合、これらのメソッドは全てのエラーメッセージを処理します。

この話題のより詳細については Struts ユーザガイドの Building View Components の章を参照してください。

<tool>
  <key>errors</key>
  <scope>request</scope>
  <class>org.apache.velocity.tools.struts.ErrorsTool</class>
</tool>

Method Overview

exist()	エラーメッセージがある場合にtrueを返却、その他の場合false。
getSize()	エラーメッセージの数を返却します。
getGlobal()	これは$errors.get($errors.globalName)と同等の簡易メソッドです。
getAll()	全てのメッセージについての地域化されたエラーメッセージのリストを返却します。
get()	指定されたカテゴリのエラーについての地域化されたエラーメッセージのリストを返却します。
getMsgs()	エラーメッセージを表示します。

エラーメッセージがある場合にtrueを返却、その他の場合false。

boolean exist()

boolean exist(String property)

Parameters

property

チェックするエラーのカテゴリ。

Returns

エラーメッセージがある場合にtrueを返却、その他の場合false。

property パラメータを指定せずに exist() を呼び出すと全てのカテゴリのエラーメッセージがチェックされます。 property パラメータは特定カテゴリのエラーメッセージのチェックに使用します。

$errors.exist()
$errors.exist("password")

エラーメッセージの数を返却します。

int getSize()

int getSize(String property)

Parameters

property

対象とするエラーのカテゴリ。

Returns

エラーメッセージの数を返却します。

property パラメータを指定せずに getSize() を呼び出すと全てのカテゴリのエラーメッセージの総数を返却します。 property パラメータは特定カテゴリのエラーメッセージの数を取得するときに使用します。

$errors.getSize()
$errors.size
$errors.getSize("password")

これは$errors.get($errors.globalName)と同等の簡易メソッドです。

List getGlobal()

Returns

"global"プロパティの全てのエラーのリスト

より詳細についてはget()セクションを参照してください。

全てのメッセージについての地域化されたエラーメッセージのリストを返却します。

List getAll()

List getAll(String bundle)

Parameters

bundle

エラーメッセージを保持する(デフォルトではない)メッセージリソースバンドル。

Returns

特定のメッセージキーのエラーメッセージがメッセージリソースに無かった場合、 そのキー自体がエラーメッセージとして使用され、このとき警告がロギングされます。

以下の例はエラーメッセージを表示するマクロです:

#macro (errorMarkup)
    #if ($errors.exist)
        <ul>
        #foreach ($e in $errors.all )
            <li>$e</li>
        #end
        </ul>
    #end
#end

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

<ul>
    <li>フィールドExpiration Dateは必須です。</li>
    <li>入力された番号は有効なクレジットカード番号ではありません。</li>
</ul>

指定されたカテゴリのエラーについての地域化されたエラーメッセージのリストを返却します。

List get(String property)

List get(String property, String bundle)

Parameters

property

返却するエラーメッセージのカテゴリ。

bundle

エラーメッセージを保持する(デフォルトではない)エラーリソースバンドル。

Returns

java.lang.String の java.util.List 。 指定されたカテゴリにエラーメッセージが無い場合には、 null を返却します。 特定のメッセージキーのエラーメッセージがメッセージリソースに無かった場合、 そのキー自体がエラーメッセージとして使用され、このとき警告がロギングされます。

以下の例は特定のエラーカテゴリのエラーメッセージを表示するマクロです:

#macro (errorMarkup $property)
    #if ($errors.exist($property))
        <ul>
        #foreach ($er in $errors.get($property) )
            <li>$er</li>
        #end
        </ul>
    #end
#end

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

<ul>
    <li>フィールドExpiration Dateは必須です。</li>
    <li>入力された番号は有効なクレジットカード番号ではありません。</li>
</ul>

エラーメッセージを表示します。

String getMsgs()

String getMsgs(String property)

String getMsgs(String property, String bundle)

Parameters

property

表示するエラーメッセージのカテゴリ。

bundle

エラーメッセージを保持する(デフォルトではない)メッセージリソースバンドル。

Returns

フォーマットされたエラーメッセージ。 エラーが無い場合、空の String が返却されます。

このメソッドはエラーメッセージをリストとして表示します。 パラメータ無しで呼び出した場合、全てのエラーが表示されます。 property パラメータを指定した場合、特定のカテゴリのエラーのメッセージリストを表示します。 エラーメッセージの文字列はメッセージリソースから取得されます。 メッセージが見つからなかった場合、メッセージのキーを代わりに表示します。

このメソッドはメッセージヘッダとメッセージフッタがメッセージリソースに定義されていることを前提とします。 これらのメッセージのキーは errors.header と errors.footer です。

メッセージリソースが以下のように定義されている場合:

errors.header=以下のエラーを修正して下さい:<ul>
errors.footer=</ul>
error01=<li>フィールドExpiration Dateは必須です。</li>
error02=<li>入力された番号は有効なクレジットカード番号ではありません。</li>
...

エラーメッセージは以下のように表示されます:

以下のエラーを修正して下さい:<ul>
    <li>フィールドExpiration Dateは必須です。</li>
    <li>入力された番号は有効なクレジットカード番号ではありません。</li>
</ul>