Package nablarch.common.web.tag
Class MessageTag
java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
nablarch.common.web.tag.CustomTagSupport
nablarch.common.web.tag.MessageTag
- All Implemented Interfaces:
jakarta.servlet.jsp.tagext.IterationTag
,jakarta.servlet.jsp.tagext.JspTag
,jakarta.servlet.jsp.tagext.Tag
,jakarta.servlet.jsp.tagext.TryCatchFinally
,Serializable
メッセージを出力するクラス。
MessageUtil
を使用してメッセージを取得する。- See Also:
-
Field Summary
Fields inherited from class jakarta.servlet.jsp.tagext.TagSupport
id, pageContext
Fields inherited from interface jakarta.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
Fields inherited from interface jakarta.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
void
setHtmlEscape
(boolean htmlEscape) HTMLエスケープをするか否かを設定する。
デフォルトはtrue。void
setLanguage
(String language) メッセージの言語を設定する。void
setMessageId
(String messageId) メッセージIDを設定する。void
setOption0
(Object option) メッセージフォーマットに使用するインデックスが0のオプション引数を設定する。void
setOption1
(Object option) メッセージフォーマットに使用するインデックスが1のオプション引数を設定する。void
setOption2
(Object option) メッセージフォーマットに使用するインデックスが2のオプション引数を設定する。void
setOption3
(Object option) メッセージフォーマットに使用するインデックスが3のオプション引数を設定する。void
setOption4
(Object option) メッセージフォーマットに使用するインデックスが4のオプション引数を設定する。void
setOption5
(Object option) メッセージフォーマットに使用するインデックスが5のオプション引数を設定する。void
setOption6
(Object option) メッセージフォーマットに使用するインデックスが6のオプション引数を設定する。void
setOption7
(Object option) メッセージフォーマットに使用するインデックスが7のオプション引数を設定する。void
setOption8
(Object option) メッセージフォーマットに使用するインデックスが8のオプション引数を設定する。void
setOption9
(Object option) メッセージフォーマットに使用するインデックスが9のオプション引数を設定する。void
リクエストスコープに格納する際に使用する変数名を設定する。void
setWithHtmlFormat
(boolean withHtmlFormat) HTMLフォーマット(改行と半角スペースの変換)をするか否かを設定する。
HTMLフォーマットはHTMLエスケープをする場合のみ有効となる。Methods inherited from class nablarch.common.web.tag.CustomTagSupport
doCatch, doFinally
Methods inherited from class jakarta.servlet.jsp.tagext.TagSupport
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue
-
Constructor Details
-
MessageTag
public MessageTag()
-
-
Method Details
-
setMessageId
メッセージIDを設定する。- Parameters:
messageId
- メッセージID
-
setOption0
メッセージフォーマットに使用するインデックスが0のオプション引数を設定する。- Parameters:
option
- インデックスが0のオプション引数
-
setOption1
メッセージフォーマットに使用するインデックスが1のオプション引数を設定する。- Parameters:
option
- インデックスが1のオプション引数
-
setOption2
メッセージフォーマットに使用するインデックスが2のオプション引数を設定する。- Parameters:
option
- インデックスが2のオプション引数
-
setOption3
メッセージフォーマットに使用するインデックスが3のオプション引数を設定する。- Parameters:
option
- インデックスが3のオプション引数
-
setOption4
メッセージフォーマットに使用するインデックスが4のオプション引数を設定する。- Parameters:
option
- インデックスが4のオプション引数
-
setOption5
メッセージフォーマットに使用するインデックスが5のオプション引数を設定する。- Parameters:
option
- インデックスが5のオプション引数
-
setOption6
メッセージフォーマットに使用するインデックスが6のオプション引数を設定する。- Parameters:
option
- インデックスが6のオプション引数
-
setOption7
メッセージフォーマットに使用するインデックスが7のオプション引数を設定する。- Parameters:
option
- インデックスが7のオプション引数
-
setOption8
メッセージフォーマットに使用するインデックスが8のオプション引数を設定する。- Parameters:
option
- インデックスが8のオプション引数
-
setOption9
メッセージフォーマットに使用するインデックスが9のオプション引数を設定する。- Parameters:
option
- インデックスが9のオプション引数
-
setLanguage
メッセージの言語を設定する。- Parameters:
language
- メッセージの取得先となる言語
-
setVar
リクエストスコープに格納する際に使用する変数名を設定する。- Parameters:
var
- リクエストスコープに格納する際に使用する変数名
-
setHtmlEscape
public void setHtmlEscape(boolean htmlEscape) HTMLエスケープをするか否かを設定する。
デフォルトはtrue。- Parameters:
htmlEscape
- HTMLエスケープをする場合はtrue、しない場合はfalse。
-
setWithHtmlFormat
public void setWithHtmlFormat(boolean withHtmlFormat) HTMLフォーマット(改行と半角スペースの変換)をするか否かを設定する。
HTMLフォーマットはHTMLエスケープをする場合のみ有効となる。- Parameters:
withHtmlFormat
- HTMLフォーマット(改行と半角スペースの変換)をする場合はtrue、しない場合はfalse。
-
doStartTag
public int doStartTag() throws jakarta.servlet.jsp.JspException指定されたメッセージIDとオプション引数を使用してメッセージを取得する。
language
属性の指定がない場合は、ThreadContext.getLanguage()
から取得した言語を使用してフォーマットしたメッセージを取得する。var
属性が指定された場合は、フォーマットしたメッセージをリクエストスコープに設定し、処理を終了する。 メッセージをリクエストスコープに設定する場合はHTMLエスケープとHTMLフォーマットを行わない。var
属性が指定されなかった場合は、メッセージを出力する。 メッセージを出力する場合はHTMLエスケープとHTMLフォーマットを行う。- Specified by:
doStartTag
in interfacejakarta.servlet.jsp.tagext.Tag
- Overrides:
doStartTag
in classjakarta.servlet.jsp.tagext.TagSupport
- Throws:
jakarta.servlet.jsp.JspException
-