クラス MessageTag
java.lang.ObjectSE
jakarta.servlet.jsp.tagext.TagSupport
org.springframework.web.servlet.tags.RequestContextAwareTag
org.springframework.web.servlet.tags.HtmlEscapingAwareTag
org.springframework.web.servlet.tags.MessageTag
- 実装されたすべてのインターフェース:
IterationTagEE
、JspTagEE
、TagEE
、TryCatchFinallyEE
、SerializableSE
、ArgumentAware
- 既知の直属サブクラス
ThemeTag
<message>
タグは、このページのスコープでメッセージを検索します。メッセージは ApplicationContext を使用して解決されるため、国際化をサポートします。 このタグインスタンス、ページレベル、web.xml
レベルの HTML エスケープ設定を検出します。JavaScript エスケープも適用できます。
「コード」が設定されていないか解決できない場合、「テキスト」がデフォルトのメッセージとして使用されます。このタグは、テキストの HTML エスケープにも使用できます。
メッセージ引数は、arguments
属性を介して、またはネストされた <spring:argument>
タグを使用して指定できます。
属性 | 必須 ? | ランタイム式? | 説明 |
---|---|---|---|
引数 | false | true | このタグのオプションのメッセージ引数を、(カンマで)区切られた文字列(各文字列引数は JSP EL を含むことができます)、オブジェクト配列(引数配列として使用)、単一オブジェクト(単一引数として使用)として設定します。 |
argumentSeparator | false | true | 引数の文字列値を分割するために使用される区切り文字。デフォルトは「カンマ」('、')です。 |
コード | false | true | メッセージを検索するときに使用するコード(キー)。コードが指定されていない場合は、text 属性が使用されます。 |
htmlEscape | false | true | このタグの HTML エスケープをブール値として設定します。現在のページのデフォルトの HTML エスケープ設定をオーバーライドします。 |
javaScriptEscape | false | true | このタグの JavaScript エスケープをブール値として設定します。デフォルトは false です。 |
メッセージ | false | true | MessageSourceResolvable 引数(直接または JSP EL を介して)。MessageSourceResolvable インターフェースをすべて実装する Spring 独自の検証エラークラスと組み合わせて使用すると、うまく適合します。例: これにより、フォーム内のすべてのエラーを繰り返し処理し、各ランタイムエラーを(ランタイム式を使用して)この 'message' 属性の値として渡すことができるため、このようなエラーメッセージを簡単に表示できます。 |
範囲 | false | true | 結果を変数にエクスポートするときに使用するスコープ。この属性は、var も設定されている場合にのみ使用されます。可能な値は、ページ、リクエスト、セッション、アプリケーションです。 |
テキスト | false | true | 指定されたコードのメッセージが見つからなかったときに出力するデフォルトのテキスト。テキストとコードの両方が設定されていない場合、タグは null を出力します。 |
var | false | true | 結果をページ、リクエスト、セッション、アプリケーションスコープにバインドするときに使用する文字列。指定しない場合、結果はライターに出力されます(つまり、通常は直接 JSP に出力されます)。 |
- 作成者:
- Rod Johnson, Juergen Hoeller, Nicholas Williams
- 関連事項:
フィールドサマリー
クラス org.springframework.web.servlet.tags.RequestContextAwareTag から継承されたフィールド
logger, REQUEST_CONTEXT_PAGE_ATTRIBUTE
クラス jakarta.servlet.jsp.tagext.TagSupportEE から継承されたフィールド
idEE, pageContextEE
インターフェース jakarta.servlet.jsp.tagext.IterationTagEE から継承されたフィールド
EVAL_BODY_AGAINEE
インターフェース jakarta.servlet.jsp.tagext.TagEE から継承されたフィールド
EVAL_BODY_INCLUDEEE, EVAL_PAGEEE, SKIP_BODYEE, SKIP_PAGEEE
コンストラクターのサマリー
メソッドのサマリー
修飾子と型メソッド説明void
addArgument
(ObjectSE argument) ネストされた spring:argument タグのコールバックフック。親タグに値を渡します。int
doEndTag()
メッセージを解決し、必要に応じてエスケープし、ページに書き込みます(または変数として公開します)。protected final int
実際の作業を実行するために doStartTag によって呼び出されます。protected MessageSource
現在の RequestContext のアプリケーションコンテキストを MessageSource として使用します。protected StringSE
デフォルトの例外メッセージを返します。void
release()
protected ObjectSE[]
resolveArguments
(ObjectSE arguments) 指定された引数オブジェクトを引数配列に解決します。protected StringSE
指定されたメッセージを具体的なメッセージ文字列に解決します。void
setArguments
(ObjectSE arguments) このタグのオプションのメッセージ引数を、カンマ区切りの文字列(各文字列引数に JSP EL を含めることができる)、オブジェクト配列(引数配列として使用)、単一のオブジェクト(単一引数として使用)として設定します。void
setArgumentSeparator
(StringSE argumentSeparator) 引数の文字列の分割に使用するセパレータを設定します。void
このタグのメッセージコードを設定します。void
setJavaScriptEscape
(boolean javaScriptEscape) このタグの JavaScript エスケープをブール値として設定します。void
setMessage
(MessageSourceResolvable message) このタグに MessageSourceResolvable を設定します。void
変数をエクスポートするスコープを設定します。void
このタグのメッセージテキストを設定します。void
解決されたメッセージを含む変数を公開する PageContext 属性名を設定します。protected void
writeMessage
(StringSE msg) メッセージをページに書き込みます。クラス org.springframework.web.servlet.tags.HtmlEscapingAwareTag から継承されたメソッド
htmlEscape, isDefaultHtmlEscape, isHtmlEscape, isResponseEncodedHtmlEscape, setHtmlEscape
クラス org.springframework.web.servlet.tags.RequestContextAwareTag から継承されたメソッド
doCatch, doFinally, doStartTag, getRequestContext
クラス jakarta.servlet.jsp.tagext.TagSupportEE から継承されたメソッド
doAfterBodyEE, findAncestorWithClassEE, getIdEE, getParentEE, getValueEE, getValuesEE, removeValueEE, setIdEE, setPageContextEE, setParentEE, setValueEE
フィールドの詳細
DEFAULT_ARGUMENT_SEPARATOR
引数を分割するためのデフォルトの区切り文字列: コンマ(",")。- 関連事項:
コンストラクターの詳細
MessageTag
public MessageTag()
メソッドの詳細
setMessage
このタグに MessageSourceResolvable を設定します。MessageSourceResolvable が指定されている場合は、このタグで指定されているコード、引数、テキストを効果的にオーバーライドします。
setCode
このタグのメッセージコードを設定します。setArguments
このタグのオプションのメッセージ引数を、カンマ区切りの文字列(各文字列引数に JSP EL を含めることができる)、オブジェクト配列(引数配列として使用)、単一のオブジェクト(単一引数として使用)として設定します。setArgumentSeparator
引数の文字列の分割に使用するセパレータを設定します。デフォルトはコンマ(",")です。addArgument
インターフェースからコピーされた説明:ArgumentAware
ネストされた spring:argument タグのコールバックフック。親タグに値を渡します。- 次で指定:
- インターフェース
ArgumentAware
のaddArgument
- パラメーター:
argument
- ネストされたspring:argument
タグの結果- 例外:
JspTagExceptionEE
setText
このタグのメッセージテキストを設定します。setVar
解決されたメッセージを含む変数を公開する PageContext 属性名を設定します。setScope
変数をエクスポートするスコープを設定します。デフォルトは SCOPE_PAGE(「ページ」)です。setJavaScriptEscape
このタグの JavaScript エスケープをブール値として設定します。デフォルトは "false" です。doStartTagInternal
クラスからコピーされた説明:RequestContextAwareTag
実際の作業を実行するために doStartTag によって呼び出されます。- 次で指定:
- クラス
RequestContextAwareTag
のdoStartTagInternal
- 戻り値:
- TagSupport.doStartTag と同じ
- 例外:
JspExceptionEE
IOExceptionSE
- 関連事項:
doEndTag
メッセージを解決し、必要に応じてエスケープし、ページに書き込みます(または変数として公開します)。- 次で指定:
- インターフェース
TagEE
のdoEndTagEE
- オーバーライド:
- クラス
TagSupportEE
のdoEndTagEE
- 例外:
JspExceptionEE
- 関連事項:
release
public void release()- 次で指定:
- インターフェース
TagEE
のreleaseEE
- オーバーライド:
- クラス
TagSupportEE
のreleaseEE
resolveMessage
指定されたメッセージを具体的なメッセージ文字列に解決します。返されるメッセージ文字列はエスケープしないでください。resolveArguments
指定された引数オブジェクトを引数配列に解決します。- パラメーター:
arguments
- 指定された引数 Object- 戻り値:
- 配列として解決された引数
- 例外:
JspExceptionEE
- 引数の変換に失敗した場合- 関連事項:
writeMessage
メッセージをページに書き込みます。サブクラスでオーバーライドできます。例: テスト目的
- パラメーター:
msg
- 書き込むメッセージ- 例外:
IOExceptionSE
- 書き込みに失敗した場合
getMessageSource
現在の RequestContext のアプリケーションコンテキストを MessageSource として使用します。getNoSuchMessageExceptionDescription
デフォルトの例外メッセージを返します。