jp.littlesoft.web
クラス ActionPage

java.lang.Object
  jp.littlesoft.web.ActionPage

すべての実装されたインタフェース:

Serializable, EventListener, TableListener

直系の既知のサブクラス:

DefaultPage, SQLActionPage

public class ActionPage
extends Object
implements TableListener, Serializable

アクションページの基底クラス。
当クラスを継承して機能毎のアクションページを作成します。

バージョン:

1.3.0

作成者:

LittleSoft Corporation

関連項目:

直列化された形式

入れ子のクラスの概要

static interface	ActionPage.DefaultCheckReqest アクションメソッドを実行する前に自動のチェックリクエストを行うか？
static interface	ActionPage.EscapeString HTMLエスケープを行うかを付与するアノテーションです。
static interface	ActionPage.UseJDBC JDBCコネクションを使用するメソッドに付与するアノテーションです。

フィールドの概要

protected String	actionPageId アクションページ毎の識別子です。
static String	ARGS_ISNULL
static String	DELIMITER_ARGS アクションメソッドの引数のセパレータを表す定数です。
protected org.apache.log4j.Logger	logger
String	methodName executeメソッドでディスパッチするメソッド名
protected ActionPage	parentPage 親の ActionPage オブジェクトです。
static String	PN_ACTIONPAGE_ID アクションページの識別子を表す定数です。
static String	PN_APPLICATION_PARAMS 親のアクションページの識別子を表す定数です。
static String	PN_ARGS アクションメソッドの引数を表す定数です。
static String	PN_CLASS 自身のクラス名を表す定数です。
static String	PN_FORM_NAME フォームタグ名を表す定数です。
static String	PN_JSESSION_ID JSESSIONIDを表す定数です。
static String	PN_LOADING_SCRIPT ロードするJavaScriptを表す定数です。
static String	PN_METHOD
static String	PN_PARENT_ACTIONPAGE_ID 親のアクションページの識別子を表す定数です。
static String	PN_SELF_GET_URL 自身のURLを表す定数です。
static String	PN_SELF_URL 自身のURLを表す定数です。
static String	PN_SEQ リクエストの送信順序判定用の識別子です。
static String	PN_SUBSESSION_ID サブセッションの識別子を表す定数です。
static String	PN_USE_AJAX Ajaxの使用／未使用です。
static String	RA_PARENT_ARGS リクエスト属性予約名 ： 親ページから子ページへの引数（HashMapオブジェクト）
static String	RA_PARENT_PAGE リクエスト属性予約名 ： 子ページへ渡される親ページのインスタンス
protected javax.servlet.http.HttpServletRequest	request クライアントがServletへ要求したリクエスト内容を含む HttpServletRequest オブジェクトです。
protected javax.servlet.http.HttpServletResponse	response Servletがクライアントに返すレスポンス内容を含む HttpServletResponse オブジェクトです。
String	selfClassName 自クラス名
protected HashMap<String,ActionPage>	subActionPage 子の ActionPage オブジェクトのリストです。
protected ActionSubSession	subSession クライアントがアクセスする ActionSubSession オブジェクトです。

コンストラクタの概要

ActionPage()
ActionPage オブジェクトを生成します。

ActionPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
引数 request、response で指定された ActionPage オブジェクトを生成します。

メソッドの概要

void	closeSession() セッションからサブセッションを削除します。
void	closeSubPage() 親のアクションページが持つ、子アクションページのリストから自分自身の アクションページを削除します。
<E extends Serializable> void	dataChanged(TableEvent<?> e, TableEvent.Operation operation) Table オブジェクトのデータが変更された際の処理を実装します。
void	doDefault() 指定したアクションメソッドが、存在しなかった場合に実行されるデフォルトの アクションメソッドです。
void	doDefault(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) 指定したアクションメソッドが、存在しなかった場合に実行されるデフォルトの アクションメソッドです。
void	execute(ActionSubSession subSession, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) サブセッションまたは親アクションページから処理要求がディスパッチされた際の処理を実装します。
void	forward(String className) 指定したアクションページを生成し、そのdoDefaultメソッドを実行します。
Object[]	getActionMethodArguments() ls.exec, ls.ajax の引数を取得します.
String	getActionPageId() アクションページの識別子を取得します。
Connection	getConnection() JDBCコネクションを取得します。
String	getContentType() 出力するページのContentTypeを取得します。
ActionController	getController() リクエストからアクションコントローラを取得します。
HashMap<String,String>	getControlParams(boolean increment) コントロール項目の内容をHashMapで取得します.
String	getFormName() 出力するページのFormタグの名称を取得します。
String	getJsessionID() リクエストからJSESSIONIDの値を取得する.
String	getLoadscript() ページがロードされる際、実行されるJavaScriptコードを取得する.
String	getMergedString(String templateName) 指定されたテンプレートファイルを解析した内容（String）を返します。
ActionPage	getParentPage() 親のアクションページを取得します。
javax.servlet.http.HttpServletRequest	getRequest() リクエストを取得します。
javax.servlet.http.HttpServletResponse	getResponse() レスポンスを取得します。
String	getSequenceValue() リクエスト送信順序判定用の識別子を取得します。
String	getSequenceValue(boolean increment) リクエスト送信順序判定用の識別子を取得します。
protected Object	getSessionAttribute(String name) セッションから、引数 name で指定された属性名のオブジェクトを取得します。
ActionSubSession	getSubSession() サブセッションを取得します。
UploadFileManager	getUploadFileManager() アップロードファイルマネージャーを取得する.
protected org.apache.velocity.app.VelocityEngine	getVelocityEngine()
void	init(ActionSubSession subSession, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) メンバー変数セットのための初期処理です。
void	init(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) サブセッション取得のための初期処理を行います。
boolean	isAjaxRequest() Ajaxリクエストかどうかを判定します。
boolean	isAjaxRequest(javax.servlet.http.HttpServletRequest request) Ajaxリクエストかどうかを判定します。
boolean	isStrictSession() アクションページがバックボタンによる不正なリクエストを受け付けるかどうかを取得します。
boolean	isUseAjax() アクションページがAjaxを使用するかどうかを取得します。
void	merge(String templateName) 指定されたテンプレートを解析（Publicフィールドとテンプレートの合成）し、 設定されている出力先にページを出力します。
void	merge(String templateName, PrintWriter out) 指定されたテンプレートを解析（Publicフィールドとテンプレートの合成）し、 指定された出力先にページを出力します。
protected void	onAjaxExceptionAction(Exception x) executeメソッド実行時の例外発生時処理（ls.ajax使用時）
protected void	onDefaultCheckRequestError(String methodName, ArrayList<ICheckableRequest> errorComponents, boolean showAlert) アクションページの自動チェックリクエストでエラーが発生した際、呼ばれるメソッド.
protected void	onExecExceptionAction(Exception x) executeメソッド実行時の例外発生時処理（ls.exec使用時）
void	onJavaAppCallBack() クライアント(WebBrowser)側で起動されたJavaアプリケーションからのコールバック.
void	onJavaAppCallBack(Attributes attributes) クライアント(WebBrowser)側で起動されたJavaアプリケーションからのコールバック.
protected void	onReleaseConnectionExcepion(Exception x) JDBCコネクション解放エラー時の処理を行います。
protected void	onStartAction(String methodName) アクションメソッドの実行前に呼び出される処理を実装します。
protected void	onStartShow() ページ出力前に呼び出される処理を実装します。
protected void	onStartShow(org.apache.velocity.VelocityContext velocityContext) ページ出力前に呼び出される処理を実装します。
void	releaseJDBCConnection() アクションページ内のJDBCコネクションを開放します。
protected void	removeSessionAttribute(String name) セッションから、引数 name で指定された属性名のオブジェクトを削除します。
<E extends Serializable> void	rowDeleting(TableEvent<?> e) Table オブジェクトへの行追加、行変更の削除前の処理を実装します。
<E extends Serializable> boolean	rowFiltering(TableEvent<?> e) Table オブジェクトへのフィルタ適用時の処理を実装します。
<E extends Serializable> void	rowValidating(TableEvent<?> e) Table オブジェクトへの行追加、行変更の確定前の処理を実装します。
void	setContentType(String contentType) 出力するページのContentTypeを設定します。
void	setContenxt(String key, Object value) Velocityに解析させるキーと値のペアを設定します。
void	setFormName(String formName) 出力するページのFormタグの名称を設定します。
void	setLoadscript(String loadscript) ページがロードされる際、実行されるJavaScriptコードを設定する.
void	setParentPage(ActionPage parentPage) 親のアクションページを設定します。
protected void	setSessionAttribute(String name, Object value) セッションへ、引数 name、value で指定されたオブジェクトをセットします。
void	setStrictSession(boolean strictSession) アクションページがバックボタンによる不正なリクエストを受け付けるかどうかを設定します。
void	setTemplateName(String templateName) 解析・出力するVelocityテンプレートを設定します。
void	setUseAjax(boolean useAjax) アクションページがAjaxを使用するかどうかを設定します。
void	show() 設定されているテンプレートを解析し、設定されている出力先にページを出力します。
void	show(PrintWriter out) 設定されているテンプレートを解析し、指定された出力先（ファイル等）にページを出力します。
void	show(String templateName) 指定されたテンプレートを解析し、設定されている出力先にページを出力します。
void	show(String templateName, PrintWriter out) 指定されたテンプレートを解析し、指定された出力先にページを出力します。
void	showDialog(HashMap args) 引数で指定されたダイアログアクションページクラスを開きます。
void	showDialog(String className) 引数で指定されたダイアログアクションページクラスを開きます。
void	showWithAlert(String alertMessage)
void	showWithAlert(String alertMessage, boolean increment) JavaScriptのAlertつきで、ページを出力します。
void	startJavaApp(HashMap<String,?> args) クライアント(WebBrowser)側でJavaアプリケーションを起動する.
void	startNewSubSession(HashMap args) 指定したアクションページを使って、新しいサブセッションを開始します.
void	valueBound(javax.servlet.http.HttpSessionBindingEvent e) セッションへサブセッションが登録された際、またはサブセッションに当アクションページが 設定された際の処理を実装します。
void	valueUnbound(javax.servlet.http.HttpSessionBindingEvent e) セッションからサブセッションが削除された際、またはサブセッションから当アクションページが 設定された際の処理を実装します。
void	writeAjaxExceptionResponse(String errorMessage) Ajaxリクエストに対するレスポンスを出力します。
void	writeAjaxResponse() Ajaxリクエストに対するレスポンスを出力します。
void	writeAjaxResponse(JSONObject responseObject) Ajaxリクエストに対するレスポンスを出力します。
void	writeAjaxResponse(String content) Ajaxリクエストに対するレスポンスを出力します。
void	writeAjaxResponse(String content, JSONObject responseObject) Ajaxリクエストに対するレスポンスを出力します。
void	writeAjaxSequenceErrorResponse(String errorMessage) Ajaxリクエストに対するレスポンスを出力します。

クラス java.lang.Object から継承されたメソッド

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

フィールドの詳細

RA_PARENT_PAGE

public static final String RA_PARENT_PAGE

リクエスト属性予約名 ： 子ページへ渡される親ページのインスタンス

RA_PARENT_ARGS

public static final String RA_PARENT_ARGS

リクエスト属性予約名 ： 親ページから子ページへの引数（HashMapオブジェクト）

PN_JSESSION_ID

public static final String PN_JSESSION_ID

JSESSIONIDを表す定数です。

関連項目:

定数フィールド値

PN_SUBSESSION_ID

public static final String PN_SUBSESSION_ID

サブセッションの識別子を表す定数です。 （Veloctyからアクセスできる予約済みの属性名）

関連項目:

定数フィールド値

PN_CLASS

public static final String PN_CLASS

自身のクラス名を表す定数です。 （Veloctyからアクセスできる予約済みの属性名）

関連項目:

定数フィールド値

PN_SELF_URL

public static final String PN_SELF_URL

自身のURLを表す定数です。 （Veloctyからアクセスできる予約済みの属性名）

関連項目:

定数フィールド値

PN_SELF_GET_URL

public static final String PN_SELF_GET_URL

自身のURLを表す定数です。 （Veloctyからアクセスできる予約済みの属性名）

関連項目:

定数フィールド値

PN_FORM_NAME

public static final String PN_FORM_NAME

フォームタグ名を表す定数です。 （Veloctyからアクセスできる予約済みの属性名）

関連項目:

定数フィールド値

PN_METHOD

public static final String PN_METHOD

関連項目:

定数フィールド値

PN_ARGS

public static final String PN_ARGS

アクションメソッドの引数を表す定数です。 （Veloctyからアクセスできる予約済みの属性名）

関連項目:

定数フィールド値

PN_SEQ

public static final String PN_SEQ

リクエストの送信順序判定用の識別子です。 （Veloctyからアクセスできる予約済みの属性名）

関連項目:

定数フィールド値

PN_LOADING_SCRIPT

public static final String PN_LOADING_SCRIPT

ロードするJavaScriptを表す定数です。 （Veloctyからアクセスできる予約済みの属性名）

関連項目:

定数フィールド値

PN_USE_AJAX

public static final String PN_USE_AJAX

Ajaxの使用／未使用です。 （Veloctyからアクセスできる予約済みの属性名）

関連項目:

定数フィールド値

PN_ACTIONPAGE_ID

public static final String PN_ACTIONPAGE_ID

アクションページの識別子を表す定数です。 （Veloctyからアクセスできる予約済みの属性名）

関連項目:

定数フィールド値

PN_PARENT_ACTIONPAGE_ID

public static final String PN_PARENT_ACTIONPAGE_ID

親のアクションページの識別子を表す定数です。 （Veloctyからアクセスできる予約済みの属性名）

関連項目:

定数フィールド値

PN_APPLICATION_PARAMS

public static final String PN_APPLICATION_PARAMS

親のアクションページの識別子を表す定数です。 （Veloctyからアクセスできる予約済みの属性名）

関連項目:

定数フィールド値

DELIMITER_ARGS

public static final String DELIMITER_ARGS

アクションメソッドの引数のセパレータを表す定数です。 （Veloctyからアクセスできる予約済みの属性名）

関連項目:

定数フィールド値

ARGS_ISNULL

public static final String ARGS_ISNULL

関連項目:

定数フィールド値

subSession

protected transient ActionSubSession subSession

クライアントがアクセスする ActionSubSession オブジェクトです。

request

protected transient javax.servlet.http.HttpServletRequest request

クライアントがServletへ要求したリクエスト内容を含む HttpServletRequest オブジェクトです。

response

protected transient javax.servlet.http.HttpServletResponse response

Servletがクライアントに返すレスポンス内容を含む HttpServletResponse オブジェクトです。

logger

protected transient org.apache.log4j.Logger logger

actionPageId

protected String actionPageId

アクションページ毎の識別子です。

parentPage

protected ActionPage parentPage

親の ActionPage オブジェクトです。

自身が子ページ（ダイアログ）の場合にのみ、オブジェクトがセットされます。

subActionPage

protected HashMap<String,ActionPage> subActionPage

子の ActionPage オブジェクトのリストです。

自身が親ページ（ダイアログを持つ）場合のみ、子ページがセットされます。

selfClassName

public String selfClassName

自クラス名

methodName

public String methodName

executeメソッドでディスパッチするメソッド名

コンストラクタの詳細

ActionPage

public ActionPage()

ActionPage オブジェクトを生成します。

ActionPage

public ActionPage(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)

引数 request、response で指定された ActionPage オブジェクトを生成します。

サブセッション取得のための初期処理を呼び出します。

パラメータ:

request - クライアントがServletへ要求したリクエスト内容を含む HttpServletRequest オブジェクト

response - Servletがクライアントに返すレスポンス内容を含む HttpServletResponse オブジェクト

関連項目:

ActionPage(), init(HttpServletRequest, HttpServletResponse)

メソッドの詳細

init

public void init(javax.servlet.http.HttpServletRequest request,
                 javax.servlet.http.HttpServletResponse response)

サブセッション取得のための初期処理を行います。

リクエストにセットされている ActionSubSession オブジェクトを取得し、 メンバー変数セットのための初期処理を呼び出します。

パラメータ:

request - クライアントがServletへ要求したリクエスト内容を含む HttpServletRequest オブジェクト

response - Servletがクライアントに返すレスポンス内容を含む HttpServletResponse オブジェクト

関連項目:

init(ActionSubSession, HttpServletRequest, HttpServletResponse)

init

public void init(ActionSubSession subSession,
                 javax.servlet.http.HttpServletRequest request,
                 javax.servlet.http.HttpServletResponse response)

メンバー変数セットのための初期処理です。

メンバー変数に ActionSubSession オブジェクト、 HttpServletRequest オブジェクト、 HttpServletResponse オブジェクトをセットします。

パラメータ:

subSession - クライアントがアクセスする ActionSubSession オブジェクト

request - クライアントがServletへ要求したリクエスト内容を含む HttpServletRequest オブジェクト

response - Servletがクライアントに返すレスポンス内容を含む HttpServletResponse オブジェクト

getController

public ActionController getController()

リクエストからアクションコントローラを取得します。

戻り値:

アクションコントローラ

getSessionAttribute

protected Object getSessionAttribute(String name)

セッションから、引数 name で指定された属性名のオブジェクトを取得します。

パラメータ:

name - 属性名

戻り値:

オブジェクト

setSessionAttribute

protected void setSessionAttribute(String name,
                                   Object value)

セッションへ、引数 name、value で指定されたオブジェクトをセットします。

パラメータ:

name - 属性名

value - オブジェクト

removeSessionAttribute

protected void removeSessionAttribute(String name)

セッションから、引数 name で指定された属性名のオブジェクトを削除します。

パラメータ:

name - 属性名

setTemplateName

public void setTemplateName(String templateName)

解析・出力するVelocityテンプレートを設定します。

Velocityのファイル検索パスからの相対パスで記述します。

パラメータ:

templateName - Velocityテンプレートファイル名

showWithAlert

public void showWithAlert(String alertMessage,
                          boolean increment)
                   throws javax.servlet.ServletException,
                          IOException

JavaScriptのAlertつきで、ページを出力します。

パラメータ:

alertMessage - 出力するAlertメッセージ

例外:

javax.servlet.ServletException - 例外発生時

IOException - 例外発生時

関連項目:

show()

showWithAlert

public void showWithAlert(String alertMessage)
                   throws javax.servlet.ServletException,
                          IOException

例外:

javax.servlet.ServletException

IOException

show

public void show()
          throws javax.servlet.ServletException,
                 IOException

設定されているテンプレートを解析し、設定されている出力先にページを出力します。

例外:

javax.servlet.ServletException - 例外発生時

IOException - 例外発生時

関連項目:

show(String, PrintWriter)

show

public void show(String templateName)
          throws javax.servlet.ServletException,
                 IOException

指定されたテンプレートを解析し、設定されている出力先にページを出力します。

パラメータ:

templateName - Velocityテンプレートファイル名

例外:

javax.servlet.ServletException - 例外発生時

IOException - 例外発生時

関連項目:

show(String, PrintWriter)

show

public void show(PrintWriter out)
          throws javax.servlet.ServletException,
                 IOException

設定されているテンプレートを解析し、指定された出力先（ファイル等）にページを出力します。

パラメータ:

out - 出力先

例外:

javax.servlet.ServletException - 例外発生時

IOException - 例外発生時

関連項目:

show(String, PrintWriter)

show

public void show(String templateName,
                 PrintWriter out)
          throws javax.servlet.ServletException,
                 IOException

指定されたテンプレートを解析し、指定された出力先にページを出力します。

パラメータ:

templateName - Velocityテンプレートファイル名

out - 出力先

例外:

javax.servlet.ServletException - 例外発生時

IOException - 例外発生時

関連項目:

setTemplateName(String), merge(String, PrintWriter)

getMergedString

public String getMergedString(String templateName)
                       throws javax.servlet.ServletException,
                              IOException

指定されたテンプレートファイルを解析した内容（String）を返します。

パラメータ:

templateName - Velocityテンプレートファイル名

戻り値:

マージしたString

例外:

javax.servlet.ServletException - 例外発生時

IOException - 例外発生時

関連項目:

merge(String, PrintWriter)

merge

public void merge(String templateName)
           throws javax.servlet.ServletException,
                  IOException

指定されたテンプレートを解析（Publicフィールドとテンプレートの合成）し、 設定されている出力先にページを出力します。

showとの違いはthis.templateNameとSubSessionのActionPageが更新されない事です。

パラメータ:

templateName - Velocityテンプレートファイル名

例外:

javax.servlet.ServletException - 例外発生時

IOException - 例外発生時

関連項目:

merge(String, PrintWriter)

merge

public void merge(String templateName,
                  PrintWriter out)
           throws javax.servlet.ServletException,
                  IOException

指定されたテンプレートを解析（Publicフィールドとテンプレートの合成）し、 指定された出力先にページを出力します。

showとの違いはthis.templateNameとSubSessionのActionPageが更新されない事です。

パラメータ:

templateName - Velocityテンプレートファイル名

out - 出力先

例外:

javax.servlet.ServletException - 例外発生時

IOException - 例外発生時

関連項目:

onStartShow(), setContenxt(String, Object)

getControlParams

public HashMap<String,String> getControlParams(boolean increment)

コントロール項目の内容をHashMapで取得します.

パラメータ:

increment - true: sequenceValueが変化します.

戻り値:

HashMap

setContenxt

public void setContenxt(String key,
                        Object value)

Velocityに解析させるキーと値のペアを設定します。

パラメータ:

key - キー

value - 値

execute

public void execute(ActionSubSession subSession,
                    javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws Exception

サブセッションまたは親アクションページから処理要求がディスパッチされた際の処理を実装します。

メンバー変数セットのための初期処理、アクションメソッド前処理、アクションメソッド実行を行います。
アクションメソッドの指定が無い場合(初期表示時など)、指定されたテンプレートファイルでページを出力します。

指定されたアクションメソッドがアクションページに存在しない場合、「doDefault」を 対象のアクションメソッドとします。

アクションメソッドに「UseJDBC」アノテーションが付与されている場合、自動的にセッション管理を 行います。

パラメータ:

subSession - クライアントがアクセスする ActionSubSession オブジェクト

request - クライアントがServletへ要求したリクエスト内容を含む HttpServletRequest オブジェクト

response - Servletがクライアントに返すレスポンス内容を含む HttpServletResponse オブジェクト

例外:

Exception - 例外発生時

関連項目:

init(ActionSubSession, HttpServletRequest, HttpServletResponse), show()

getActionMethodArguments

public Object[] getActionMethodArguments()

ls.exec, ls.ajax の引数を取得します.

戻り値:

引数配列

onDefaultCheckRequestError

protected void onDefaultCheckRequestError(String methodName,
                                          ArrayList<ICheckableRequest> errorComponents,
                                          boolean showAlert)

アクションページの自動チェックリクエストでエラーが発生した際、呼ばれるメソッド.
ブラウザにエラーメッセージをAlertで表示させるレスポンスを出力するのがディフォルトの動作です。
アプリケーションプログラムは当メソッドをオーバーライドして独自の振る舞いを実装してください。

パラメータ:

methodName - リクエストに含まれていた実行対象のメソッド名

errorComponents - エラーが発生したWebDataTable

onExecExceptionAction

protected void onExecExceptionAction(Exception x)
                              throws Exception

executeメソッド実行時の例外発生時処理（ls.exec使用時）

パラメータ:

x - 例外オブジェクト

例外:

Exception - 例外発生時

onAjaxExceptionAction

protected void onAjaxExceptionAction(Exception x)
                              throws Exception

executeメソッド実行時の例外発生時処理（ls.ajax使用時）

パラメータ:

x - 例外オブジェクト

例外:

Exception - 例外発生時

writeAjaxExceptionResponse

public void writeAjaxExceptionResponse(String errorMessage)
                                throws Exception

Ajaxリクエストに対するレスポンスを出力します。

このメソッドでは返却されたレスポンスは、lsjcontrol.htmlにてonExceptionファンクションを 呼び出します。

パラメータ:

errorMessage - Exceptionの内容

例外:

Exception - 例外発生時

writeAjaxSequenceErrorResponse

public void writeAjaxSequenceErrorResponse(String errorMessage)
                                    throws Exception

Ajaxリクエストに対するレスポンスを出力します。

このメソッドでは返却されたレスポンスは、lsjcontrol.htmlにてonSequenceErrorファンクションを 呼び出します。

パラメータ:

errorMessage - シーケンスエラーの内容

例外:

Exception - 例外発生時

releaseJDBCConnection

public void releaseJDBCConnection()
                           throws Exception

アクションページ内のJDBCコネクションを開放します。

例外:

Exception

onReleaseConnectionExcepion

protected void onReleaseConnectionExcepion(Exception x)
                                    throws Exception

JDBCコネクション解放エラー時の処理を行います。

パラメータ:

x - 例外 オブジェクト

例外:

Exception - 例外発生時

doDefault

public void doDefault(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws Exception

指定したアクションメソッドが、存在しなかった場合に実行されるデフォルトの アクションメソッドです。

パラメータ:

request - クライアントがServletへ要求したリクエスト内容を含む HttpServletRequest オブジェクト

response - Servletがクライアントに返すレスポンス内容を含む HttpServletResponse オブジェクト

例外:

Exception - 例外発生時

関連項目:

init(HttpServletRequest, HttpServletResponse), doDefault()

doDefault

public void doDefault()
               throws Exception

指定したアクションメソッドが、存在しなかった場合に実行されるデフォルトの アクションメソッドです。

例外:

Exception - 例外発生時

関連項目:

onStartAction(String), show()

forward

public void forward(String className)
             throws Exception

指定したアクションページを生成し、そのdoDefaultメソッドを実行します。

パラメータ:

className - クラス名

例外:

Exception

startNewSubSession

public void startNewSubSession(HashMap args)
                        throws Exception

指定したアクションページを使って、新しいサブセッションを開始します.

パラメータ:

className - アクションクラス名

例外:

Exception

onStartAction

protected void onStartAction(String methodName)
                      throws Exception

アクションメソッドの実行前に呼び出される処理を実装します。

このメソッドの処理は空です。

パラメータ:

methodName - アクションメソッド名

例外:

Exception - 例外発生時

onStartShow

protected void onStartShow()
                    throws Exception

ページ出力前に呼び出される処理を実装します。

このメソッドの処理は空です。

例外:

Exception - 例外発生時

onStartShow

protected void onStartShow(org.apache.velocity.VelocityContext velocityContext)
                    throws Exception

ページ出力前に呼び出される処理を実装します。

VelocityContextに値をセットすることができます。

このメソッドの処理は空です。

例外:

Exception - 例外発生時

isStrictSession

public boolean isStrictSession()

アクションページがバックボタンによる不正なリクエストを受け付けるかどうかを取得します。

Trueの場合、自分が最後に出力したページのHTTPリクエストしか受け付ません。
ブラウザのバックボタンや再読込によるHTTPリクエストはエラーとなり、最終ページが強制的に再表示されます。

戻り値:

True：不正リクエストを受け付ける、False：受け付けない

setStrictSession

public void setStrictSession(boolean strictSession)

アクションページがバックボタンによる不正なリクエストを受け付けるかどうかを設定します。

Trueの場合、自分が最後に出力したページのHTTPリクエストしか受け付ません。
ブラウザのバックボタンや再読込によるHTTPリクエストはエラーとなり、最終ページが強制的に再表示されます。

パラメータ:

strictSession - True：不正リクエストを受け付ける、False：受け付けない

getSequenceValue

public String getSequenceValue()

リクエスト送信順序判定用の識別子を取得します。

戻り値:

リクエスト送信順序判定用の識別子

getSequenceValue

public String getSequenceValue(boolean increment)

リクエスト送信順序判定用の識別子を取得します。

インクリメントを行った場合、新しい識別子が発行・設定されます。

パラメータ:

increment - True：インクリメントを行う、False：行わない

戻り値:

リクエスト送信順序判定用の識別子

getContentType

public String getContentType()

出力するページのContentTypeを取得します。

戻り値:

ContentType

setContentType

public void setContentType(String contentType)

出力するページのContentTypeを設定します。

パラメータ:

contentType - ContentType

getFormName

public String getFormName()

出力するページのFormタグの名称を取得します。

戻り値:

Formタグの名称

setFormName

public void setFormName(String formName)

出力するページのFormタグの名称を設定します。

パラメータ:

formName - Formタグの名称

valueBound

public void valueBound(javax.servlet.http.HttpSessionBindingEvent e)

セッションへサブセッションが登録された際、またはサブセッションに当アクションページが 設定された際の処理を実装します。

このメソッドの処理は空です。

パラメータ:

e - HttpSessionBindingEvent オブジェクト

valueUnbound

public void valueUnbound(javax.servlet.http.HttpSessionBindingEvent e)

セッションからサブセッションが削除された際、またはサブセッションから当アクションページが 設定された際の処理を実装します。

このメソッドの処理は空です。

パラメータ:

e - HttpSessionBindingEvent オブジェクト

writeAjaxResponse

public void writeAjaxResponse()
                       throws Exception

Ajaxリクエストに対するレスポンスを出力します。

例外:

Exception

writeAjaxResponse

public void writeAjaxResponse(JSONObject responseObject)
                       throws Exception

Ajaxリクエストに対するレスポンスを出力します。

パラメータ:

responseObject - レスポンスしたいJSONObject

例外:

Exception

writeAjaxResponse

public void writeAjaxResponse(String content)
                       throws Exception

Ajaxリクエストに対するレスポンスを出力します。

Ajaxを使用する場合は、

   actionPage.setUseAjax(true);
 

としくてください。また、HTMLテンプレートにはjavaScritタグでprototype.jsを指定してください。

Ajaxレスポンスにはshowメソッドを使用しません。

   this.writeAjaxResponse(String);
 

でHTMLの断片を書き出します。

HTMLの断片をテンプレートで編集したい場合は、

   getMergedString("template/sample/xxxxxxxxxxx.html")
 

で予めActionPage オブジェクトの内容とマージします。

書き出した内容は、JSONオブジェクトとしてクライアントJavaScriptのonComplete(response)に返されます。
response.contentがthis.writeAjaxResponse()で書き出した文字列です。

responseには上記の他、ActionPageのパブリックフィールド、ActionPage内のWebDataTableのプロパティなどが セットされています。
※詳しくはwriteAjaxResponse()のソースを見てください。

もっと複雑な内容をresponseに入れたい場合は、

   writeAjaxResponse(String content, org.json.JSONObject responseObject)
 

を使用してくだい。予めJSONObjectを作成して、必要なオブジェクトをputしてからwriteAjaxResponseを呼び出すことで どのような内容も、クライアントJavaScriptに返却できるようになります。

パラメータ:

content - 出力する文字列

例外:

Exception - 例外発生時

関連項目:

writeAjaxResponse(String, JSONObject)

writeAjaxResponse

public void writeAjaxResponse(String content,
                              JSONObject responseObject)
                       throws Exception

Ajaxリクエストに対するレスポンスを出力します。

パラメータ:

content - 出力する文字列

responseObject - レスポンスオブジェクト

例外:

Exception - 例外発生時

isUseAjax

public boolean isUseAjax()

アクションページがAjaxを使用するかどうかを取得します。

戻り値:

True：Ajaxを使用する、False：使用しない

setUseAjax

public void setUseAjax(boolean useAjax)

アクションページがAjaxを使用するかどうかを設定します。

パラメータ:

useAjax - True：Ajaxを使用する、False：使用しない

dataChanged

public <E extends Serializable> void dataChanged(TableEvent<?> e,
                                                 TableEvent.Operation operation)

Table オブジェクトのデータが変更された際の処理を実装します。

このメソッドの処理は空です。

定義:

インタフェース TableListener 内の dataChanged

パラメータ:

e - TableEvent

operation - オペレーション

関連項目:

TableListener.dataChanged(jp.littlesoft.data.event.TableEvent, TableEvent.Operation)

rowDeleting

public <E extends Serializable> void rowDeleting(TableEvent<?> e)
                 throws Exception

Table オブジェクトへの行追加、行変更の削除前の処理を実装します。

このメソッドの処理は空です。

定義:

インタフェース TableListener 内の rowDeleting

パラメータ:

e - TableEvent

例外:

Exception - 例外発生時

関連項目:

TableListener.rowDeleting(jp.littlesoft.data.event.TableEvent)

rowFiltering

public <E extends Serializable> boolean rowFiltering(TableEvent<?> e)

Table オブジェクトへのフィルタ適用時の処理を実装します。

このメソッドの処理は空です。

定義:

インタフェース TableListener 内の rowFiltering

パラメータ:

e - TableEvent

戻り値:

boolean true:表示行に含める、false:表示行に含めない。

関連項目:

TableListener.rowFiltering(jp.littlesoft.data.event.TableEvent)

rowValidating

public <E extends Serializable> void rowValidating(TableEvent<?> e)
                   throws Exception

Table オブジェクトへの行追加、行変更の確定前の処理を実装します。

このメソッドの処理は空です。

定義:

インタフェース TableListener 内の rowValidating

パラメータ:

e - TableEvent

例外:

Exception - 例外発生時

関連項目:

TableListener.rowValidating(jp.littlesoft.data.event.TableEvent)

getActionPageId

public String getActionPageId()

アクションページの識別子を取得します。

戻り値:

アクションページの識別子

getParentPage

public ActionPage getParentPage()

親のアクションページを取得します。

戻り値:

親のアクションページ

setParentPage

public void setParentPage(ActionPage parentPage)

親のアクションページを設定します。

パラメータ:

parentPage - 親のアクションページ

closeSubPage

public void closeSubPage()

親のアクションページが持つ、子アクションページのリストから自分自身の アクションページを削除します。

getConnection

public Connection getConnection()
                         throws Exception

JDBCコネクションを取得します。

戻り値:

JDBCコネクション

例外:

Exception

関連項目:

getController(), ActionController.getConnection()

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

リクエストを取得します。

戻り値:

リクエスト

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

レスポンスを取得します。

戻り値:

レスポンス

getSubSession

public ActionSubSession getSubSession()

サブセッションを取得します。

戻り値:

サブセッション

closeSession

public void closeSession()
                  throws Exception

セッションからサブセッションを削除します。

画面の閉じるボタンが押されたら、サブセッションを終了します。

例外:

Exception - 例外発生時

関連項目:

removeSessionAttribute(String)

isAjaxRequest

public boolean isAjaxRequest()

Ajaxリクエストかどうかを判定します。

戻り値:

Ajaxリクエスト：true、Ajaxリクエストではない：false

isAjaxRequest

public boolean isAjaxRequest(javax.servlet.http.HttpServletRequest request)

Ajaxリクエストかどうかを判定します。

パラメータ:

request - リクエスト

戻り値:

Ajaxリクエスト：true、Ajaxリクエストではない：false

showDialog

public void showDialog(String className)
                throws Exception

引数で指定されたダイアログアクションページクラスを開きます。

パラメータ:

className - ダイアログアクションページクラス名

例外:

Exception

showDialog

public void showDialog(HashMap args)
                throws Exception

引数で指定されたダイアログアクションページクラスを開きます。

パラメータ:

className - ダイアログアクションページクラス名

args - 引数、テンプレートファイルではJSONオブジェクトで指定してください

例外:

Exception

getLoadscript

public String getLoadscript()

ページがロードされる際、実行されるJavaScriptコードを取得する.

戻り値:

ページがロードされる際、実行されるのJavaScriptコード

setLoadscript

public void setLoadscript(String loadscript)

ページがロードされる際、実行されるJavaScriptコードを設定する.

パラメータ:

loadscript -

getJsessionID

public String getJsessionID()

リクエストからJSESSIONIDの値を取得する.

戻り値:

JSESSION_ID

getUploadFileManager

public UploadFileManager getUploadFileManager()

アップロードファイルマネージャーを取得する.

戻り値:

startJavaApp

public void startJavaApp(HashMap<String,?> args)

クライアント(WebBrowser)側でJavaアプリケーションを起動する.
JavaWebStartのjnlpファイルを生成し、レスポンスへ出力します.
ActionPageテンプレートに以下の様なスクリプトを記述し当メソッドを呼び出します.

ls.startJavaApp({productId:'1',fileName:'test.zip'...})

※任意のパラメータをJSONオブジェクトで設定します.この内容はHashMapに変換されActionPageのメソッド引数になります.

パラメータ:

args - クライアントから送られたパラメータ

onJavaAppCallBack

public final void onJavaAppCallBack()

クライアント(WebBrowser)側で起動されたJavaアプリケーションからのコールバック.

onJavaAppCallBack

public void onJavaAppCallBack(Attributes attributes)

クライアント(WebBrowser)側で起動されたJavaアプリケーションからのコールバック.

getVelocityEngine

protected org.apache.velocity.app.VelocityEngine getVelocityEngine()