org.seasar.s2click.util
クラス AjaxUtils

java.lang.Object
  org.seasar.s2click.util.AjaxUtils

public class AjaxUtils
extends java.lang.Object

Ajax関連のユーティリティメソッドを提供します。

導入されたバージョン:

0.4.0

作成者:

Naoki Takezoe

フィールドの概要

static java.lang.String	CONTENT_TYPE_HTML
static java.lang.String	CONTENT_TYPE_JSON
static java.lang.String	ON_COMPLETE
static java.lang.String	ON_CREATE
static java.lang.String	ON_EXCEPTION
static java.lang.String	ON_FAILURE
static java.lang.String	ON_SUCCESS

コンストラクタの概要

AjaxUtils()

メソッドの概要

static java.lang.String	createAjaxJavaScript(org.apache.click.Page page) Ajaxアノテーションを指定したpublicメソッドを呼び出すためのJavaScriptを生成します。
static java.lang.String	createAjaxRequest(java.lang.String url, java.util.Map<java.lang.String,java.lang.String> options, java.util.Map<java.lang.String,java.lang.Object> parameters) prototype.jsのAjax.Requestを呼び出すJavaScriptを生成します。
static java.lang.String	createAjaxUpdater(java.lang.String id, java.lang.String url, java.util.Map<java.lang.String,java.lang.String> options, java.util.Map<java.lang.String,java.lang.Object> parameters) prototype.jsのAjax.Updaterを呼び出すJavaScriptを生成します。
static java.lang.String	getOptions(java.util.Map<java.lang.String,java.lang.String> options)
static org.apache.click.element.JsImport	getPrototypeJsImport() prototype.jsをインポートするための<script>タグを生成します。

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

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

フィールドの詳細

CONTENT_TYPE_JSON

public static final java.lang.String CONTENT_TYPE_JSON

関連項目:

定数フィールド値

CONTENT_TYPE_HTML

public static final java.lang.String CONTENT_TYPE_HTML

関連項目:

定数フィールド値

ON_CREATE

public static final java.lang.String ON_CREATE

関連項目:

定数フィールド値

ON_COMPLETE

public static final java.lang.String ON_COMPLETE

関連項目:

定数フィールド値

ON_EXCEPTION

public static final java.lang.String ON_EXCEPTION

関連項目:

定数フィールド値

ON_FAILURE

public static final java.lang.String ON_FAILURE

関連項目:

定数フィールド値

ON_SUCCESS

public static final java.lang.String ON_SUCCESS

関連項目:

定数フィールド値

コンストラクタの詳細

AjaxUtils

public AjaxUtils()

メソッドの詳細

createAjaxRequest

public static java.lang.String createAjaxRequest(java.lang.String url,
                                                 java.util.Map<java.lang.String,java.lang.String> options,
                                                 java.util.Map<java.lang.String,java.lang.Object> parameters)

prototype.jsのAjax.Requestを呼び出すJavaScriptを生成します。

パラメータ:

url - URL

options - オプション

parameters - パラメータ

戻り値:

Ajax.Requestを呼び出すJavaScript

createAjaxUpdater

public static java.lang.String createAjaxUpdater(java.lang.String id,
                                                 java.lang.String url,
                                                 java.util.Map<java.lang.String,java.lang.String> options,
                                                 java.util.Map<java.lang.String,java.lang.Object> parameters)

prototype.jsのAjax.Updaterを呼び出すJavaScriptを生成します。

パラメータ:

id - 置換するHTML要素のid属性

url - URL

options - オプション

parameters - パラメータ

戻り値:

Ajax.Updaterを呼び出すJavaScript

getOptions

public static java.lang.String getOptions(java.util.Map<java.lang.String,java.lang.String> options)

createAjaxJavaScript

public static java.lang.String createAjaxJavaScript(org.apache.click.Page page)

Ajaxアノテーションを指定したpublicメソッドを呼び出すためのJavaScriptを生成します。

メソッド毎に以下のシグネチャを持つJavaScript関数を生成します。 この関数はprototype.jsのAjax.Requestを使用してリモートメソッドの呼び出しを行います。

 function メソッド名(resultHandler, arg0, arg1 ...)
 

第一引数にはAjax呼び出しの結果を処理する関数を指定します。 第二引数以降はサーバ側のメソッドに渡す引数を指定します。

なお、エラー発生時のハンドラには以下の実装が使用されます。 このエラーハンドラは本メソッドが返却するJavaScriptに含まれています。

 function ajaxDefaultErrorHandler(transport){
   alert('通信に失敗しました。');
 }
 

パラメータ:

page - 対象のページクラス

戻り値:

Ajaxアノテーションを指定したpublicメソッドを呼び出すためのJavaScript

getPrototypeJsImport

public static org.apache.click.element.JsImport getPrototypeJsImport()

prototype.jsをインポートするための<script>タグを生成します。

戻り値:

prototype.jsをインポートするためのタグ