nablarch.common.web.tag

Class MessageTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

nablarch.common.web.tag.CustomTagSupport

nablarch.common.web.tag.MessageTag

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, javax.servlet.jsp.tagext.TryCatchFinally

public class MessageTag
extends CustomTagSupport

メッセージを出力するクラス。

MessageUtilを使用してメッセージを取得する。

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor and Description
MessageTag()

Method Summary

Modifier and Type	Method and Description
int	doStartTag()
void	setHtmlEscape(boolean htmlEscape) HTMLエスケープをするか否かを設定する。 デフォルトはtrue。
void	setLanguage(java.lang.String language) メッセージの言語を設定する。
void	setMessageId(java.lang.String messageId) メッセージIDを設定する。
void	setOption0(java.lang.Object option) メッセージフォーマットに使用するインデックスが0のオプション引数を設定する。
void	setOption1(java.lang.Object option) メッセージフォーマットに使用するインデックスが1のオプション引数を設定する。
void	setOption2(java.lang.Object option) メッセージフォーマットに使用するインデックスが2のオプション引数を設定する。
void	setOption3(java.lang.Object option) メッセージフォーマットに使用するインデックスが3のオプション引数を設定する。
void	setOption4(java.lang.Object option) メッセージフォーマットに使用するインデックスが4のオプション引数を設定する。
void	setOption5(java.lang.Object option) メッセージフォーマットに使用するインデックスが5のオプション引数を設定する。
void	setOption6(java.lang.Object option) メッセージフォーマットに使用するインデックスが6のオプション引数を設定する。
void	setOption7(java.lang.Object option) メッセージフォーマットに使用するインデックスが7のオプション引数を設定する。
void	setOption8(java.lang.Object option) メッセージフォーマットに使用するインデックスが8のオプション引数を設定する。
void	setOption9(java.lang.Object option) メッセージフォーマットに使用するインデックスが9のオプション引数を設定する。
void	setVar(java.lang.String var) リクエストスコープに格納する際に使用する変数名を設定する。
void	setWithHtmlFormat(boolean withHtmlFormat) HTMLフォーマット(改行と半角スペースの変換)をするか否かを設定する。 HTMLフォーマットはHTMLエスケープをする場合のみ有効となる。

Methods inherited from class nablarch.common.web.tag.CustomTagSupport

doCatch, doFinally

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageTag

public MessageTag()

Method Detail

setMessageId

public void setMessageId(java.lang.String messageId)

メッセージIDを設定する。

Parameters:

messageId - メッセージID

setOption0

public void setOption0(java.lang.Object option)

メッセージフォーマットに使用するインデックスが0のオプション引数を設定する。

Parameters:

option - インデックスが0のオプション引数

setOption1

public void setOption1(java.lang.Object option)

メッセージフォーマットに使用するインデックスが1のオプション引数を設定する。

Parameters:

option - インデックスが1のオプション引数

setOption2

public void setOption2(java.lang.Object option)

メッセージフォーマットに使用するインデックスが2のオプション引数を設定する。

Parameters:

option - インデックスが2のオプション引数

setOption3

public void setOption3(java.lang.Object option)

メッセージフォーマットに使用するインデックスが3のオプション引数を設定する。

Parameters:

option - インデックスが3のオプション引数

setOption4

public void setOption4(java.lang.Object option)

メッセージフォーマットに使用するインデックスが4のオプション引数を設定する。

Parameters:

option - インデックスが4のオプション引数

setOption5

public void setOption5(java.lang.Object option)

メッセージフォーマットに使用するインデックスが5のオプション引数を設定する。

Parameters:

option - インデックスが5のオプション引数

setOption6

public void setOption6(java.lang.Object option)

メッセージフォーマットに使用するインデックスが6のオプション引数を設定する。

Parameters:

option - インデックスが6のオプション引数

setOption7

public void setOption7(java.lang.Object option)

メッセージフォーマットに使用するインデックスが7のオプション引数を設定する。

Parameters:

option - インデックスが7のオプション引数

setOption8

public void setOption8(java.lang.Object option)

メッセージフォーマットに使用するインデックスが8のオプション引数を設定する。

Parameters:

option - インデックスが8のオプション引数

setOption9

public void setOption9(java.lang.Object option)

メッセージフォーマットに使用するインデックスが9のオプション引数を設定する。

Parameters:

option - インデックスが9のオプション引数

setLanguage

public void setLanguage(java.lang.String language)

メッセージの言語を設定する。

Parameters:

language - メッセージの取得先となる言語

setVar

public void setVar(java.lang.String var)

リクエストスコープに格納する際に使用する変数名を設定する。

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 javax.servlet.jsp.JspException

 指定されたメッセージIDとオプション引数を使用してメッセージを取得する。
 
 language属性の指定がない場合は、ThreadContext.getLanguage()
 から取得した言語を使用してフォーマットしたメッセージを取得する。
 
 var属性が指定された場合は、フォーマットしたメッセージをリクエストスコープに設定し、処理を終了する。
 メッセージをリクエストスコープに設定する場合はHTMLエスケープとHTMLフォーマットを行わない。
 
 var属性が指定されなかった場合は、メッセージを出力する。
 メッセージを出力する場合はHTMLエスケープとHTMLフォーマットを行う。
 

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException