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:
public class NavigationStateRenderer extends AbstractNavigationStateRenderer
Handles navigation events by rendering a contained NavigationState in the target UI.
See Also:
-
-
Constructor Summary
Constructors Constructor and Description NavigationStateRenderer(NavigationState navigationState)
Constructs a new NavigationStateRenderer that handles the given navigation state.
-
Method Summary
All Methods 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)
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)
Notified the navigation target about the status of the navigation.
-
Methods inherited from class com.vaadin.flow.router.internal.AbstractNavigationStateRenderer
getNavigationState, handle
-
-
-
-
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)
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 classAbstractNavigationStateRenderer
Parameters:
targetType
- component type that will be shownReturns:
a list of parent
RouterLayout
types, notnull
-
notifyNavigationTarget
protected void notifyNavigationTarget(Component componentInstance, NavigationEvent navigationEvent, BeforeEnterEvent beforeEnterEvent, LocationChangeEvent locationChangeEvent)
Description copied from class:
AbstractNavigationStateRenderer
Notified the navigation target about the status of the navigation.
Specified by:
notifyNavigationTarget
in classAbstractNavigationStateRenderer
Parameters:
componentInstance
- the navigation target instancenavigationEvent
- the low level navigation event that is being processedbeforeEnterEvent
- the before enter event that will be fired unless navigation is reroutedlocationChangeEvent
- 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 classAbstractNavigationStateRenderer
Returns:
true
to support event actions;false
otherwise.
-
-