Constructor Detail

• CancellationController

  public CancellationController()

• CancellationController

  public CancellationController(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Detail

• getOrCreateRef

  public static CancellationController getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

• setJavaScriptObject

  public void setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)

  Overrides:

  setJavaScriptObject in class BaseClass

• create

  public com.google.gwt.core.client.JavaScriptObject create()

  Specified by:

  create in class BaseClass

• isCreated

  public boolean isCreated()

  Overrides:

  isCreated in class BaseClass

• getJsObj

  public com.google.gwt.core.client.JavaScriptObject getJsObj()

  Overrides:

  getJsObj in class BaseClass

• getOrCreateJsObj

  public com.google.gwt.core.client.JavaScriptObject getOrCreateJsObj()

  Overrides:

  getOrCreateJsObj in class BaseClass

• getCanceled

  public java.lang.Boolean getCanceled()
                                throws java.lang.IllegalStateException

  Whether cancel() has been called.

  Note : This method should be called only after the underlying component has been created.

  Returns:

  Current canceled value. Default value is false

  Throws:

  java.lang.IllegalStateException - if the underlying component has not yet been created.

• getCancellationReason

  public java.lang.String getCancellationReason()
                                         throws java.lang.IllegalStateException

  The reason, if any, passed to the first call to cancel().

  Note : This method should be called only after the underlying component has been created.

  Returns:

  Current cancellationReason value. Default value is null

  Throws:

  java.lang.IllegalStateException - if the underlying component has not yet been created.

  See Also:

  HTMLString

• cancel

  public java.lang.Boolean cancel()

  Requests cancellation of all asynchronous operations that are polling 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.

  Returns:

  true if this was the first call to cancel(); false otherwise.

• cancel

  public java.lang.Boolean cancel(java.lang.String reason)

  Requests cancellation of all asynchronous operations that are polling 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.

  Parameters:

  reason - A reason for cancellation. See HTMLString

  Returns:

  true if this was the first call to cancel(); false otherwise.

• createSubController

  public CancellationController createSubController()

  Creates a new CancellationController which is canceled whenever this CancellationController is canceled.

  Note that the sub-CancellationController may be independently canceled before this parent CancellationController is canceled.

  Returns:

  a new CancellationController that is canceled whenever this CancellationController is canceled.