Package com.vaadin.flow.component

Class UI.BrowserNavigateEvent

java.lang.Object

java.util.EventObject

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

com.vaadin.flow.component.UI.BrowserNavigateEvent

All Implemented Interfaces:

Serializable

Enclosing class:

UI

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

See Also:

• Serialized Form

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
BrowserNavigateEvent(UI source, boolean fromClient, String route, String query, String appShellTitle, tools.jackson.databind.JsonNode historyState, String trigger)	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

BrowserNavigateEvent

public BrowserNavigateEvent(UI source,
 boolean fromClient,
 @EventData("route")
 String route,
 @EventData("query")
 String query,
 @EventData("appShellTitle")
 String appShellTitle,
 @EventData("historyState")
 tools.jackson.databind.JsonNode historyState,
 @EventData("trigger")
 String trigger)

Creates a new event instance.

Parameters:

source - the UI that is the source of the event

fromClient - true if the event originated from the client side, false otherwise

route - flow route path that should be attached to the client element

query - flow route query string

appShellTitle - client side title of the application shell

historyState - client side history state value

trigger - navigation trigger