このツールは Struts のアクションメッセージを提供します。 アクションメッセージについて抑えておくべき重要な点は:

• アクションメッセージはメッセージリソースから取得されます。 国際化されたメッセージの提供がサポートされています。
• アクションメッセージは置換パラメータを5つまで持つことができます。
• アクションはメッセージカテゴリを示す property 属性を持ちます。 これはビューデザイナが適切な場所にアクションメッセージを配置することを可能にします。 このツールのいくつかのメソッドは、処理対象とする特定のメッセージカテゴリを選択できる property パラメータを提供します。 property パラメータを指定しない場合、これらのメソッドは全てのアクションメッセージを処理します。

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

<tool>
  <key>messages</key>
  <scope>request</scope>
  <class>org.apache.velocity.tools.struts.ActionMessagesTool</class>
</tool>

Method Overview

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

アクションメッセージがある場合に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 パラメータは特定カテゴリのアクションメッセージの数を取得するときに使用します。

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

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

List getGlobal()

Returns

"global"プロパティの全てのメッセージのリスト

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

全てのメッセージについての地域化されたアクションメッセージのリストを返却します。

List getAll()

List getAll(String bundle)

Parameters

bundle

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

Returns

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

以下の例はアクションメッセージを表示するマクロです:

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

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

<ul>
    <li>これは最初のアクションメッセージです。</li>
    <li>これは二番目のアクションメッセージです。</li>
</ul>

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

List get(String property)

List get(String property, String bundle)

Parameters

property

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

bundle

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

Returns

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

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

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

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

<ul>
    <li>これは最初のアクションメッセージです。</li>
    <li>これは二番目のアクションメッセージです。</li>
</ul>