Package com.smartgwt.client.util
Class AsyncOperationContext
java.lang.Object
com.smartgwt.client.core.JsObject
com.smartgwt.client.core.DataClass
com.smartgwt.client.core.RefDataClass
com.smartgwt.client.util.AsyncOperationContext
- All Implemented Interfaces:
HasHandlers
- Direct Known Subclasses:
AIContext,AsyncDataBoundOperationContext,BuildViaAIContext,SummarizeRecordsContext
Context for an asynchronous operation.
- See Also:
-
Field Summary
Fields inherited from class com.smartgwt.client.core.RefDataClass
idFields inherited from class com.smartgwt.client.core.DataClass
factoryCreated, factoryProperties -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionACancellationControllerthat the asynchronous operation should look to for whether the operation is canceled.static AsyncOperationContextgetOrCreateRef(JavaScriptObject jsObj) setCancellationController(CancellationController cancellationController) ACancellationControllerthat the asynchronous operation should look to for whether the operation is canceled.Methods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef, internalSetIDMethods inherited from class com.smartgwt.client.core.DataClass
applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated
-
Constructor Details
-
AsyncOperationContext
public AsyncOperationContext() -
AsyncOperationContext
-
-
Method Details
-
getOrCreateRef
-
setCancellationController
public AsyncOperationContext setCancellationController(CancellationController cancellationController) ACancellationControllerthat the asynchronous operation should look to for whether the operation is canceled.This may be
nullif the invoker of the asynchronous operation does not need the ability to cancel. However, note that theresult typemay still be CANCELED; for example, the asynchronous operation may be self-canceling after a timeout.Implementations of asynchronous operations must treat this
CancellationControlleras observer-only, and they cannotcancelit.- Parameters:
cancellationController- New cancellationController value. Default value is null- Returns:
AsyncOperationContextinstance, for chaining setter calls
-
getCancellationController
ACancellationControllerthat the asynchronous operation should look to for whether the operation is canceled.This may be
nullif the invoker of the asynchronous operation does not need the ability to cancel. However, note that theresult typemay still be CANCELED; for example, the asynchronous operation may be self-canceling after a timeout.Implementations of asynchronous operations must treat this
CancellationControlleras observer-only, and they cannotcancelit.- Returns:
- Current cancellationController value. Default value is null
-