Uses of Interface
com.vaadin.flow.router.RouterLayout

Packages that use RouterLayout

Package	Description
com.vaadin.flow.component
com.vaadin.flow.component.applayout
com.vaadin.flow.component.internal
com.vaadin.flow.router
com.vaadin.flow.router.internal

Uses of RouterLayout in com.vaadin.flow.component

Classes in com.vaadin.flow.component that implement RouterLayout

Modifier and Type	Class and Description
class	UI The topmost component in any component hierarchy.

Uses of RouterLayout in com.vaadin.flow.component.applayout

Classes in com.vaadin.flow.component.applayout that implement RouterLayout

Modifier and Type	Class and Description
class	AbstractAppRouterLayout Convenience class for using an AppLayout as a parent layout in a Flow application.

Uses of RouterLayout in com.vaadin.flow.component.internal

Method parameters in com.vaadin.flow.component.internal with type arguments of type RouterLayout

Modifier and Type	Method and Description
void	UIInternals.showRouteTarget(Location viewLocation, String path, Component target, List<RouterLayout> layouts) Shows a route target in the related UI.

Uses of RouterLayout in com.vaadin.flow.router

Methods in com.vaadin.flow.router that return types with arguments of type RouterLayout

Modifier and Type	Method and Description
Class<? extends RouterLayout>	RouteData.getParentLayout() Get the parent layout of Route.
Class<? extends RouterLayout>	RouteData.AliasData.getParentLayout() Getter for the RouteAlias parent layout.
Map<Class<? extends RouterLayout>,List<RouteData>>	Router.getRoutesByParent() Get all available routes collected by parent layout.

Constructor parameters in com.vaadin.flow.router with type arguments of type RouterLayout

Constructor and Description
AliasData(Class<? extends RouterLayout> parentLayout, String url) Data class constructor.
RouteData(Class<? extends RouterLayout> parentLayout, String url, List<Class<?>> parameters, Class<? extends Component> navigationTarget) RouteData constructor.

Uses of RouterLayout in com.vaadin.flow.router.internal

Methods in com.vaadin.flow.router.internal that return types with arguments of type RouterLayout

Modifier and Type	Method and Description
static List<Class<? extends RouterLayout>>	RouterUtil.getParentLayouts(Class<?> component) Get parent layouts for navigation target Route annotation.
static List<Class<? extends RouterLayout>>	RouterUtil.getParentLayouts(Class<?> component, String path) Get parent layouts for navigation target according to the Route or RouteAlias annotation.
static List<Class<? extends RouterLayout>>	RouterUtil.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.
protected List<Class<? extends RouterLayout>>	NavigationStateRenderer.getRouterLayoutTypes(Class<? extends Component> targetType)
List<Class<? extends RouterLayout>>	ErrorStateRenderer.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 abstract List<Class<? extends RouterLayout>>	AbstractNavigationStateRenderer.getRouterLayoutTypes(Class<? extends Component> routeTargetType) Gets the router layout types to show for the given route target type, starting from the parent layout immediately wrapping the route target type.
static Class<? extends RouterLayout>	RouterUtil.getTopParentLayout(Class<?> component, String path) Get the top most parent layout for navigation target according to the Route or RouteAlias annotation.

Method parameters in com.vaadin.flow.router.internal with type arguments of type RouterLayout

Modifier and Type	Method and Description
static void	RouterUtil.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.