com.vaadin.flow.router.internal

Class RouterUtil

java.lang.Object

com.vaadin.flow.router.internal.RouterUtil

public final class RouterUtil
extends Object

Utility class with methods for router layout handling.

Method Summary

Modifier and Type	Method and Description
static void	checkForDuplicates(Class<? extends Component> routeTargetType, Collection<Class<? extends RouterLayout>> routeLayoutTypes) Checks that the same component type is not used in multiple parts of a route chain.
static LocationChangeEvent	createEvent(NavigationEvent event, List<HasElement> routeTargetChain) Create a new location change event for given navigation event and chain.
static List<Class<? extends RouterLayout>>	getParentLayouts(Class<?> component) Get parent layouts for navigation target Route annotation.
static List<Class<? extends RouterLayout>>	getParentLayouts(Class<?> component, String path) Get parent layouts for navigation target according to the Route or RouteAlias annotation.
static List<Class<? extends RouterLayout>>	getParentLayoutsForNonRouteTarget(Class<?> navigationTarget) Collect possible route parent layouts for a navigation target that is not annotated with Route nor RouteAlias, but may still contain ParentLayout.
static String	getRouteAliasPath(Class<?> component, RouteAlias alias) Get the actual route path including all parent layout RoutePrefix.
static String	getRoutePath(Class<?> component, Route route) Get the actual route path including all parent layout RoutePrefix.
static Class<? extends RouterLayout>	getTopParentLayout(Class<?> component, String path) Get the top most parent layout for navigation target according to the Route or RouteAlias annotation.
static void	updatePageTitle(NavigationEvent navigationEvent, Component routeTarget) Updates the page title according to the currently visible component.

Methods inherited from class java.lang.Object

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

Method Detail

getParentLayouts

public static List<Class<? extends RouterLayout>> getParentLayouts(Class<?> component)

Get parent layouts for navigation target Route annotation.

Parameters:

component - navigation target to get parents for

Returns:

parent layouts for target

getParentLayouts

public static List<Class<? extends RouterLayout>> getParentLayouts(Class<?> component,
                                                                   String path)

Get parent layouts for navigation target according to the Route or RouteAlias annotation.

Parameters:

component - navigation target to get parents for

path - path used to get navigation target so we know which annotation to handle

Returns:

parent layouts for target

getRoutePath

public static String getRoutePath(Class<?> component,
                                  Route route)

Get the actual route path including all parent layout RoutePrefix.

Parameters:

component - navigation target component to get route path for

route - route annotation to check

Returns:

actual path for given route target

getRouteAliasPath

public static String getRouteAliasPath(Class<?> component,
                                       RouteAlias alias)

Get the actual route path including all parent layout RoutePrefix.

Parameters:

component - navigation target component to get route path for

alias - route alias annotation to check

Returns:

actual path for given route alias target

getParentLayoutsForNonRouteTarget

public static List<Class<? extends RouterLayout>> getParentLayoutsForNonRouteTarget(Class<?> navigationTarget)

Collect possible route parent layouts for a navigation target that is not annotated with Route nor RouteAlias, but may still contain ParentLayout. Mainly error navigation targets.

Parameters:

navigationTarget - route to check parent layouts for

Returns:

list of parent layouts

getTopParentLayout

public static Class<? extends RouterLayout> getTopParentLayout(Class<?> component,
                                                               String path)

Get the top most parent layout for navigation target according to the Route or RouteAlias annotation. Also handles non route targets with ParentLayout.

Parameters:

component - navigation target to get top most parent for

path - path used to get navigation target so we know which annotation to handle or null for error views.

Returns:

top parent layout for target or null if none found

updatePageTitle

public static void updatePageTitle(NavigationEvent navigationEvent,
                                   Component routeTarget)

Updates the page title according to the currently visible component.

Uses HasDynamicTitle.getPageTitle() if implemented, or else the PageTitle annotation, to resolve the title.

Parameters:

navigationEvent - the event object about the navigation

routeTarget - the currently visible component

checkForDuplicates

public static void checkForDuplicates(Class<? extends Component> routeTargetType,
                                      Collection<Class<? extends RouterLayout>> routeLayoutTypes)

Checks that the same component type is not used in multiple parts of a route chain.

Parameters:

routeTargetType - the actual component in the route chain

routeLayoutTypes - the parent types in the route chain

createEvent

public static LocationChangeEvent createEvent(NavigationEvent event,
                                              List<HasElement> routeTargetChain)

Create a new location change event for given navigation event and chain.

Parameters:

event - current navigation event

routeTargetChain - chain of route targets

Returns:

new LocationChangeEvent