org.opencms.gwt.client.rpc

类 CmsRpcAction<T>

java.lang.Object

org.opencms.gwt.client.rpc.CmsRpcAction<T>

类型参数:

T - The type of the expected return value

所有已实现的接口:

com.google.gwt.user.client.rpc.AsyncCallback<T>

public abstract class CmsRpcAction<T>
extends java.lang.Object
implements com.google.gwt.user.client.rpc.AsyncCallback<T>

Consistently manages RPCs errors and 'loading' state.

从以下版本开始:

8.0

构造器概要

构造器

构造器和说明
CmsRpcAction()

方法概要

方法

限定符和类型	方法和说明
abstract void	execute() Executes the current RPC call.
T	executeSync() Executes a synchronized request.
void	onFailure(java.lang.Throwable t) Handle errors.
protected abstract void	onResponse(T result) Handles the result when received from server.
void	onSuccess(T value)
void	setLoadingMessage(java.lang.String loadingMessage) Sets the loading message.
protected void	show(boolean blocking) Shows the 'loading message'.
void	start(int delay, boolean blocking) Starts the timer for showing the 'loading' state.
void	stop(boolean displayDone) Stops the timer.

从类继承的方法 java.lang.Object

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

构造器详细资料

CmsRpcAction

public CmsRpcAction()

方法详细资料

execute

public abstract void execute()

Executes the current RPC call.

Initializes client-server communication and will

executeSync

public T executeSync()

Executes a synchronized request.

返回:

the RPC result

另请参阅:

execute()

onFailure

public void onFailure(java.lang.Throwable t)

Handle errors.

指定者:

onFailure 在接口中 com.google.gwt.user.client.rpc.AsyncCallback<T>

另请参阅:

AsyncCallback.onFailure(java.lang.Throwable)

onSuccess

public void onSuccess(T value)

指定者:

onSuccess 在接口中 com.google.gwt.user.client.rpc.AsyncCallback<T>

另请参阅:

AsyncCallback.onSuccess(java.lang.Object)

setLoadingMessage

public void setLoadingMessage(java.lang.String loadingMessage)

Sets the loading message.

参数:

loadingMessage - the loading message to set

start

public void start(int delay,
         boolean blocking)

Starts the timer for showing the 'loading' state.

Note: Has to be called manually before calling the RPC service.

参数:

delay - the delay in milliseconds

blocking - shows an blocking overlay if true

stop

public void stop(boolean displayDone)

Stops the timer.

Note: Has to be called manually on success.

参数:

displayDone - true if you want to tell the user that the operation was successful

onResponse

protected abstract void onResponse(T result)

Handles the result when received from server.

参数:

result - the result from server

另请参阅:

AsyncCallback.onSuccess(Object)

show

protected void show(boolean blocking)

Shows the 'loading message'.

Overwrite to customize the message.

参数:

blocking - shows an blocking overlay if true