public class CancellationController extends BaseClass
config, configOnly, factoryCreated, factoryProperties, id, scClassName| Constructor and Description |
|---|
CancellationController() |
CancellationController(com.google.gwt.core.client.JavaScriptObject jsObj) |
| Modifier and Type | Method and Description |
|---|---|
java.lang.Boolean |
cancel()
Requests cancellation of all asynchronous operations that are polling
canceled or observing this method. |
java.lang.Boolean |
cancel(java.lang.String reason)
Requests cancellation of all asynchronous operations that are polling
canceled or observing this method. |
com.google.gwt.core.client.JavaScriptObject |
create() |
CancellationController |
createSubController()
Creates a new
CancellationController which is canceled whenever this
CancellationController is canceled. |
java.lang.Boolean |
getCanceled()
Whether
cancel() has been called. |
java.lang.String |
getCancellationReason()
The reason, if any, passed to the first call to
cancel(). |
com.google.gwt.core.client.JavaScriptObject |
getJsObj() |
com.google.gwt.core.client.JavaScriptObject |
getOrCreateJsObj() |
static CancellationController |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
boolean |
isCreated() |
void |
setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj) |
addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, asSGWTComponent, clearDynamicProperty, createJsObj, destroy, doAddHandler, doInit, error, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getClassName, getConfig, getHandlerCount, getID, getRef, getRuleScope, getScClassName, getTestInstance, hasAutoAssignedID, hasDynamicProperty, internalSetID, internalSetID, isConfigOnly, isFactoryCreated, onBind, onInit, registerID, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setFactoryCreated, setID, setProperty, setProperty, setProperty, setProperty, setRuleScope, setScClassNamepublic CancellationController()
public CancellationController(com.google.gwt.core.client.JavaScriptObject jsObj)
public static CancellationController getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public void setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)
setJavaScriptObject in class BaseClasspublic com.google.gwt.core.client.JavaScriptObject create()
public com.google.gwt.core.client.JavaScriptObject getJsObj()
public com.google.gwt.core.client.JavaScriptObject getOrCreateJsObj()
getOrCreateJsObj in class BaseClasspublic java.lang.Boolean getCanceled()
throws java.lang.IllegalStateException
cancel() has been called.
Note : This method should be called only after the underlying component has been created.
java.lang.IllegalStateException - if the underlying component has not yet been created.public java.lang.String getCancellationReason()
throws java.lang.IllegalStateException
cancel().
Note : This method should be called only after the underlying component has been created.
java.lang.IllegalStateException - if the underlying component has not yet been created.HTMLStringpublic java.lang.Boolean cancel()
canceled or observing this method. Also cancels any sub-CancellationControllers of this
CancellationController that are not already canceled. this.cancellationReason is set to the provided
reason only on the first call to cancel().
For observers of this method, the recommended practice is to
capture the returnVal and only perform the cancellation steps if the returnVal was
true. This is because it could happen that cancel() is called a second time before the observers finish.
true if this was the first call to cancel(); false otherwise.public java.lang.Boolean cancel(java.lang.String reason)
canceled or observing this method. Also cancels any sub-CancellationControllers of this
CancellationController that are not already canceled. this.cancellationReason is set to the provided
reason only on the first call to cancel().
For observers of this method, the recommended practice is to
capture the returnVal and only perform the cancellation steps if the returnVal was
true. This is because it could happen that cancel() is called a second time before the observers finish.
reason - A reason for cancellation.
See HTMLStringtrue if this was the first call to cancel(); false otherwise.public CancellationController createSubController()
CancellationController which is canceled whenever this
CancellationController is canceled. Note that the sub-CancellationController may be
independently canceled before this parent CancellationController is canceled.
CancellationController that is canceled whenever this
CancellationController is canceled.