public class MessagesPopupTag
extends javax.servlet.jsp.tagext.TagSupport
1ユーザが異なるユースケースの画面を操作し、エラー・メッセージのポップ
アップ表示が同時に行われるとき、セッション上にユースケース毎のエラー・
メッセージ情報が結合されて表示されてしまう。
このタグと<ts:errors>タグ、及び<ts:messages>タグと
組み合わせる事により、画面単位で発生したポップアップエラーの混同を
避けることが可能となる。
MessagesPopupTag
は、リクエスト属性として登録されている
エラー・メッセージ情報をセッションに保存する。
MessagesPopupTag
は、<ts:body>
タグと連携してポップアップ画面を開く。
MessagesPopupTag
を用いる際には、必ず
<ts:body>
タグと共に用い、また、
MessagesPopupTag
が<ts:body>
タグよりも
前に記述されなくてはならない。
MessagesPopupTag
は、JavaScript
の
onLoad
イベント発生時のスクリプトを追加することで、
エラー・メッセージ情報表示用のポップアップ画面を開く。
従って、エラー・メッセージ情報表示用のポップアップ画面を表示する際、
下記の手順を取る。そのため、エラー・メッセージを表示前の画面では無く、
エラー・メッセージ発生時の遷移先画面にこのタグを配置するよう留意する
こと。
onLoad
イベントでポップアップ画面が開かれる。
MessagesPopupTag
は、<ts:body>
タグが
生成する本来のonLoad
イベント処理スクリプトに上書きされる。
JSP
内で MessagesPopupTag
の前に
onLoad
タグがある場合には、エラーがないときには
onLoad
タグ内のスクリプトが有効になり、
エラーがある場合には MessagesPopupTag
による設定で上書きされ、
エラー表示用のポップアップ画面が優先される。
MessagesPopupTag
では、以下の属性をサポートする。
属性名 | デフォルト値 | 必須性 | 実行時式 | 概要 |
popup |
- | true |
true |
ポップアップ画面で表示するURL。JavaScript の
window.open() の第一引数に対応する。 |
title |
popup |
false |
true |
エラーを表示するポップアップ画面のタイトル。 |
param |
- | false |
true |
JavaScript でポップアップ画面を開くときのパラメータ文字列。
|
paramType |
- | false |
true |
JavaScript でポップアップ画面を開くときのパラメータ文字列を、
ApplicationResources ファイルから取得する場合の
リソースキー。
|
paramFunc |
- | false |
true |
JavaScript でポップアップ画面を開くときの
パラメータ文字列を取得する JavaScript 関数名。
|
windowId |
- | false |
true |
開いたポップアップ画面を保持する JavaScript 変数名。
|
このタグによって設定されるスクリプティング変数はありません。
<ts:messagesPopup popup="/popup/errors.do" />
...
<ts:body ...>
修飾子とタイプ | フィールドと説明 |
---|---|
static String |
ON_LOAD_KEY
onLoad 時の処理をリクエスト属性に保存するときのキー。 |
static String |
POPUP_ERROR_KEY
ポップアップ時にリクエストパラメータで渡されるエラー情報のキー。
|
static String |
POPUP_MESSAGE_KEY
ポップアップ時にリクエストパラメータで渡されるメッセージ情報のキー。
|
コンストラクタと説明 |
---|
MessagesPopupTag() |
修飾子とタイプ | メソッドと説明 |
---|---|
int |
doEndTag()
タグ評価終了時に呼ばれるメソッド。
|
int |
doStartTag()
タグ評価開始時に呼ばれるメソッド。
|
void |
release()
タグハンドラ解放時の処理。
|
void |
setParam(String value)
JavaScript
でポップアップ画面を開くときのパラメータ文字列を設定する。 |
void |
setParamFunc(String value)
JavaScript
でポップアップ画面を開くときのパラメータ文字列として、
指定されたJavaScript 関数の戻り値を設定する。 |
void |
setParamType(String value)
JavaScript
でポップアップ画面を開くときのパラメータ文字列を、
ApplicationResources ファイルから取得して設定する。 |
void |
setPopup(String value)
ポップアップ画面で表示するURLを設定する。
|
void |
setTitle(String value)
エラーを表示するポップアップ画面のタイトルを設定する。
|
void |
setWindowId(String value)
開いたポップアップ画面を保持する
JavaScript
変数名を設定する。 |
public static final String POPUP_ERROR_KEY
public void setPopup(String value)
value
- ポップアップ画面で表示するURLpublic void setTitle(String value)
value
- タイトルpublic void setParam(String value)
JavaScript
でポップアップ画面を開くときのパラメータ文字列を設定する。value
- パラメータpublic void setParamType(String value)
JavaScript
でポップアップ画面を開くときのパラメータ文字列を、
ApplicationResources
ファイルから取得して設定する。value
- パラメータpublic void setParamFunc(String value)
JavaScript
でポップアップ画面を開くときのパラメータ文字列として、
指定されたJavaScript
関数の戻り値を設定する。value
- パラメータpublic void setWindowId(String value)
JavaScript
変数名を設定する。value
- 変数名public int doStartTag() throws javax.servlet.jsp.JspException
doStartTag
インタフェース内 javax.servlet.jsp.tagext.Tag
doStartTag
クラス内 javax.servlet.jsp.tagext.TagSupport
EVAL_BODY_INCLUDE
javax.servlet.jsp.JspException
- JSP例外public int doEndTag() throws javax.servlet.jsp.JspException
doEndTag
インタフェース内 javax.servlet.jsp.tagext.Tag
doEndTag
クラス内 javax.servlet.jsp.tagext.TagSupport
EVAL_PAGE
javax.servlet.jsp.JspException
- JSP例外public void release()
release
インタフェース内 javax.servlet.jsp.tagext.Tag
release
クラス内 javax.servlet.jsp.tagext.TagSupport
Copyright © 2015. All Rights Reserved.