com.vaadin.flow.router.internal.ErrorStateRenderer API 24.7.0.rc2

com.vaadin.flow.router.internal.ErrorStateRenderer

All Implemented Interfaces:

NavigationHandler, Serializable

public class ErrorStateRenderer extends AbstractNavigationStateRenderer

Handles error navigation rendering in the target UI.

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

Since:

1.0

See Also:

Constructor Summary

Constructors

Constructor

Description

ErrorStateRenderer(NavigationState navigationState)

Constructs a new state renderer for the given navigation state.
Method Summary

Modifier and Type

Method

Description

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.

int

handle(NavigationEvent event)

Handles the navigation event.

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, getTargetParentLayouts, handleTriggeredBeforeEvent, purgeInactiveUIPreservedChainCache, pushHistoryState, shouldPushHistoryState

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

Constructor Details
- ErrorStateRenderer
  
  public ErrorStateRenderer(NavigationState navigationState)
  
  Constructs a new state renderer for the given navigation state.
  
  Parameters:
  
  navigationState - the navigation state handled by this instance
Method Details
- 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
- 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
- getRouterLayoutTypes
  
  public 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.
  
  Specified by:
  
  getRouterLayoutTypes in class AbstractNavigationStateRenderer
  
  Parameters:
  
  targetType - component type to show
  
  router - used router instance
  
  Returns:
  
  a list of parent RouterLayout types, not null

com.vaadin.flow.router.internal.

Class ErrorStateRenderer

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Details

ErrorStateRenderer

Method Details

handle

notifyNavigationTarget

getRouterLayoutTypes