com.vaadin.flow.router.internal

Class NavigationStateRenderer

java.lang.Object

com.vaadin.flow.router.internal.AbstractNavigationStateRenderer

com.vaadin.flow.router.internal.NavigationStateRenderer

All Implemented Interfaces:

NavigationHandler, Serializable

public class NavigationStateRenderer
extends AbstractNavigationStateRenderer

Handles navigation events by rendering a contained NavigationState in the target UI.

Since:

1.0

See Also:

NavigationState, Route, Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected boolean	eventActionsSupported() Checks whether this renderer should reroute or postpone navigation based on results from event listeners.
protected List<Class<? extends RouterLayout>>	getRouterLayoutTypes(Class<? extends Component> targetType, Router router) Gets the router layout types to show for the given route target type, starting from the parent layout immediately wrapping the route target type.
protected void	notifyNavigationTarget(Component componentInstance, NavigationEvent navigationEvent, BeforeEnterEvent beforeEnterEvent, LocationChangeEvent locationChangeEvent) Notify the navigation target about the status of the navigation.

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

getNavigationState, handle

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationStateRenderer

public NavigationStateRenderer(NavigationState navigationState)

Constructs a new NavigationStateRenderer that handles the given navigation state.

Parameters:

navigationState - the navigation state handled by this instance

Method Detail

getRouterLayoutTypes

protected List<Class<? extends RouterLayout>> getRouterLayoutTypes(Class<? extends Component> targetType,
                                                                   Router router)

Description copied from class: AbstractNavigationStateRenderer

Gets the router layout types to show for the given route target type, starting from the parent layout immediately wrapping the route target type.

Specified by:

getRouterLayoutTypes in class AbstractNavigationStateRenderer

Parameters:

targetType - component type that will be shown

router - used router instance

Returns:

a list of parent RouterLayout types, not null

notifyNavigationTarget

protected void notifyNavigationTarget(Component componentInstance,
                                      NavigationEvent navigationEvent,
                                      BeforeEnterEvent beforeEnterEvent,
                                      LocationChangeEvent locationChangeEvent)

Description copied from class: AbstractNavigationStateRenderer

Notify the navigation target about the status of the navigation.

Specified by:

notifyNavigationTarget in class AbstractNavigationStateRenderer

Parameters:

componentInstance - the navigation target instance

navigationEvent - the low level navigation event that is being processed

beforeEnterEvent - the before enter event that will be fired unless navigation is rerouted

locationChangeEvent - the location change event that will be fired unless navigation is rerouted

eventActionsSupported

protected boolean eventActionsSupported()

Description copied from class: AbstractNavigationStateRenderer

Checks whether this renderer should reroute or postpone navigation based on results from event listeners. Furthermore, the before leave event is not fired at all if event actions are not supported.

Specified by:

eventActionsSupported in class AbstractNavigationStateRenderer

Returns:

true to support event actions; false otherwise.