com.vaadin.ui.
Interface UI.DelayedCallbackRegistration
-
All Superinterfaces:
Enclosing class:
public static interface UI.DelayedCallbackRegistration extends Serializable
An interface used for keeping track of callback requests registered via
UI.runAfterRoundTrip(DelayedCallback)
.Since:
8.18
-
-
Method Summary
All Methods Modifier and Type Method Description boolean
cancel()
Cancels the pending callback operation and stops this registration object from triggering any further round-trips.
long
getId()
Returns the current ID of this registration object.
boolean
hasExecuted()
Returns
true
if the delay has been completed and the callback operation has been executed.boolean
isCancelled()
Returns
true
if the callback operation was cancelled successfully before it could be executed.boolean
isPending()
Returns
true
if the callback operation is still waiting to be executed.
-
-
-
Method Detail
-
isPending
boolean isPending()
Returns
true
if the callback operation is still waiting to be executed.Returns:
true
if callback still waiting,false
otherwise
-
hasExecuted
boolean hasExecuted()
Returns
true
if the delay has been completed and the callback operation has been executed.Returns:
true
if callback executed,false
otherwise
-
isCancelled
boolean isCancelled()
Returns
true
if the callback operation was cancelled successfully before it could be executed.Returns:
true
if cancelled successfully,false
otherwiseSee Also:
-
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:
true
if cancelling was successful,false
otherwise
-
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
-
-