com.vaadin.flow.component.UI.BrowserRefreshEvent API 24.7.0.alpha6 | Vaadin

com.vaadin.flow.component.

java.lang.Object

java.util.EventObject

com.vaadin.flow.component.ComponentEvent<UI>

com.vaadin.flow.component.UI.BrowserRefreshEvent

All Implemented Interfaces:

Enclosing class:

@DomEvent("ui-refresh") public static class UI.BrowserRefreshEvent extends ComponentEvent<UI>

Event fired by the client to request a refresh of the user interface, by re-navigating to the current route.

The route target component is re-instantiated, as well as all layouts in the route chain if the fullRefresh event flag is active.

See Also:

Field Summary

Fields

Modifier and Type

Field

Description

static final String

EVENT_NAME

Fields inherited from class java.util.EventObject
source
Constructor Summary

Constructors

Constructor

Description

BrowserRefreshEvent(UI source, boolean fromClient, boolean refreshRouteChain)

Creates a new event instance.
Method Summary

Methods inherited from class com.vaadin.flow.component.ComponentEvent
getSource, isFromClient, unregisterListener

Methods inherited from class java.util.EventObject
toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- EVENT_NAME
  
  public static final String EVENT_NAME
  See Also:
  
  Constant Field Values
Constructor Details
- BrowserRefreshEvent
  
  public BrowserRefreshEvent(UI source, boolean fromClient, @EventData("fullRefresh") boolean refreshRouteChain)
  
  Creates a new event instance.
  
  Parameters:
  
  source - the UI for which the refresh is requested.
  
  fromClient - true if the event originated from the client side, false otherwise. NOTE: for technical reason the argument must be added to the constructor, but this event the value is always true.
  
  refreshRouteChain - true to refresh all layouts in the route chain, false to only refresh the route instance