Package com.vaadin.flow.component.internal

Class JavaScriptNavigationStateRenderer

java.lang.Object

com.vaadin.flow.router.internal.AbstractNavigationStateRenderer

com.vaadin.flow.router.internal.NavigationStateRenderer

com.vaadin.flow.component.internal.JavaScriptNavigationStateRenderer

All Implemented Interfaces:

NavigationHandler, Serializable

public class JavaScriptNavigationStateRenderer
extends NavigationStateRenderer

Handle navigation events in relation to the client side bootstrap UI.

For internal use only. May be renamed or removed in a future release.

Since:

24.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
JavaScriptNavigationStateRenderer(NavigationState navigationState)	Constructs a new NavigationStateRenderer that handles the given navigation state.

Method Summary

Modifier and Type	Method	Description
String	getClientForwardRoute()	Gets the client forward route.
int	handle(NavigationEvent event)	Handles the navigation event.
protected Optional<Integer>	handleTriggeredBeforeEvent(NavigationEvent event, BeforeEvent beforeEvent)	Handle a BeforeEvent after if has been triggered to an observer.
protected void	pushHistoryState(NavigationEvent event)
protected boolean	shouldPushHistoryState(NavigationEvent event)

Methods inherited from class com.vaadin.flow.router.internal.NavigationStateRenderer

findActiveRouteTarget, getRouterLayoutTypes, notifyNavigationTarget

Methods inherited from class com.vaadin.flow.router.internal.AbstractNavigationStateRenderer

getNavigationState, getTargetParentLayouts, purgeInactiveUIPreservedChainCache

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JavaScriptNavigationStateRenderer

public JavaScriptNavigationStateRenderer(NavigationState navigationState)

Constructs a new NavigationStateRenderer that handles the given navigation state.

Parameters:

navigationState - the navigation state handled by this instance

Method Details

getClientForwardRoute

public String getClientForwardRoute()

Gets the client forward route.

Returns:

the client forward route.

handle

public int handle(NavigationEvent event)

Description copied from interface: NavigationHandler

Handles the navigation event.

Specified by:

handle in interface NavigationHandler

Overrides:

handle in class AbstractNavigationStateRenderer

Parameters:

event - the navigation event to handle

Returns:

the HTTP status code to return to the client if handling an initial rendering request

handleTriggeredBeforeEvent

protected Optional<Integer> handleTriggeredBeforeEvent(NavigationEvent event,
 BeforeEvent beforeEvent)

Description copied from class: AbstractNavigationStateRenderer

Handle a BeforeEvent after if has been triggered to an observer.

Overrides:

handleTriggeredBeforeEvent in class AbstractNavigationStateRenderer

Parameters:

event - the navigation event being handled.

beforeEvent - the BeforeLeaveEvent or BeforeEnterEvent being triggered to an observer.

Returns:

an HTTP status code wrapped as an Optional. If the Optional is empty, the process will proceed with next observer or just move forward, otherwise the process will return immediately with the provided http code.

See Also:

• HttpStatusCode

shouldPushHistoryState

protected boolean shouldPushHistoryState(NavigationEvent event)

Overrides:

shouldPushHistoryState in class AbstractNavigationStateRenderer

pushHistoryState

protected void pushHistoryState(NavigationEvent event)

Overrides:

pushHistoryState in class AbstractNavigationStateRenderer