Package com.vaadin.ui
Interface UI.DelayedCallbackRegistration
-
- All Superinterfaces:
Serializable
- Enclosing class:
- UI
public static interface UI.DelayedCallbackRegistration extends Serializable
An interface used for keeping track of callback requests registered viaUI.runAfterRoundTrip(DelayedCallback).- Since:
- 8.18
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleancancel()Cancels the pending callback operation and stops this registration object from triggering any further round-trips.longgetId()Returns the current ID of this registration object.booleanhasExecuted()Returnstrueif the delay has been completed and the callback operation has been executed.booleanisCancelled()Returnstrueif the callback operation was cancelled successfully before it could be executed.booleanisPending()Returnstrueif the callback operation is still waiting to be executed.
-
-
-
Method Detail
-
isPending
boolean isPending()
Returnstrueif the callback operation is still waiting to be executed.- Returns:
trueif callback still waiting,falseotherwise
-
hasExecuted
boolean hasExecuted()
Returnstrueif the delay has been completed and the callback operation has been executed.- Returns:
trueif callback executed,falseotherwise
-
isCancelled
boolean isCancelled()
Returnstrueif the callback operation was cancelled successfully before it could be executed.- Returns:
trueif cancelled successfully,falseotherwise- See Also:
cancel()
-
cancel
boolean cancel()
Cancels the pending callback operation and stops this registration object from triggering any further round-trips. Does nothing if the callback operation has been executed already.Note: calling this method does not prevent round-trips getting triggered for other reasons.
- Returns:
trueif cancelling was successful,falseotherwise
-
getId
long getId()
Returns the current ID of this registration object. If the registration has been configured to wait for multiple round-trips, the ID gets updated for each round.- Returns:
- current ID
-
-