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

Packages that use RouterLayout

Package	Description
com.vaadin.flow.component
com.vaadin.flow.component.internal
com.vaadin.flow.component.webcomponent
com.vaadin.flow.router
com.vaadin.flow.router.internal
com.vaadin.flow.server
com.vaadin.flow.server.startup

Uses of RouterLayout in com.vaadin.flow.component

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

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

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	Description
void	UIInternals.setRouterTargetChain(List<RouterLayout> layouts)	Populate the routerTargetChain with RouterLayouts, but only if the target chain is empty.
void	UIInternals.showRouteTarget(Location viewLocation, Component target, List<RouterLayout> layouts)	Shows a route target in the related UI.

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

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

Modifier and Type	Class	Description
class	WebComponentUI	Custom UI for use with WebComponents served from the server.

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	Description
List<Class<? extends RouterLayout>>	BeforeEvent.getLayouts()	Get the layout chain for the navigation target.
Class<? extends RouterLayout>	RouteBaseData.getParentLayout()	Get the parent layout of Route.
List<Class<? extends RouterLayout>>	RouteBaseData.getParentLayouts()	Return the whole parent layout chain of route target.

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

Modifier and Type	Method	Description
void	RouteConfiguration.setRoute(String path, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain)	Register a navigation target with specified path and given parent layout chain.

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

Modifier	Constructor	Description
	BeforeEnterEvent(NavigationEvent event, Class<?> navigationTarget, RouteParameters parameters, List<Class<? extends RouterLayout>> layouts)	Constructs event from a NavigationEvent.
	BeforeEnterEvent(NavigationEvent event, Class<?> navigationTarget, List<Class<? extends RouterLayout>> layouts)	Constructs event from a NavigationEvent.
	BeforeEnterEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, UI ui, List<Class<? extends RouterLayout>> layouts)	Constructs a new BeforeEnterEvent.
	BeforeEnterEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, RouteParameters parameters, UI ui, List<Class<? extends RouterLayout>> layouts)	Constructs a new BeforeEnterEvent.
	BeforeEvent(NavigationEvent event, Class<?> navigationTarget, RouteParameters parameters, List<Class<? extends RouterLayout>> layouts)	Constructs event from a NavigationEvent.
	BeforeEvent(NavigationEvent event, Class<?> navigationTarget, List<Class<? extends RouterLayout>> layouts)	Constructs event from a NavigationEvent.
	BeforeEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, UI ui, List<Class<? extends RouterLayout>> layouts)	Constructs a new BeforeEvent.
	BeforeEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, RouteParameters parameters, UI ui, List<Class<? extends RouterLayout>> layouts)	Constructs a new BeforeEvent.
	BeforeLeaveEvent(NavigationEvent event, Class<?> navigationTarget, RouteParameters parameters, List<Class<? extends RouterLayout>> layouts)	Constructs event from a NavigationEvent.
	BeforeLeaveEvent(NavigationEvent event, Class<?> navigationTarget, List<Class<? extends RouterLayout>> layouts)	Constructs event from a NavigationEvent.
	BeforeLeaveEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, UI ui, List<Class<? extends RouterLayout>> layouts)	Constructs a new BeforeLeaveEvent.
	BeforeLeaveEvent(Router router, NavigationTrigger trigger, Location location, Class<?> navigationTarget, RouteParameters parameters, UI ui, List<Class<? extends RouterLayout>> layouts)	Constructs a new BeforeLeaveEvent.
	RouteAliasData(List<Class<? extends RouterLayout>> parentLayouts, String template, List<Class<?>> parameters, Class<? extends Component> navigationTarget)	AliasData constructor.
	RouteAliasData(List<Class<? extends RouterLayout>> parentLayouts, String template, Map<String,RouteParameterData> parameters, Class<? extends Component> navigationTarget)	AliasData constructor.
	RouteBaseData(List<Class<? extends RouterLayout>> parentLayouts, String template, List<Class<?>> parameters, Class<? extends Component> navigationTarget)	RouteBaseData constructor.
	RouteBaseData(List<Class<? extends RouterLayout>> parentLayouts, String template, Map<String,RouteParameterData> parameters, Class<? extends Component> navigationTarget)	RouteBaseData constructor.
	RouteData(List<Class<? extends RouterLayout>> parentLayouts, String template, List<Class<?>> parameters, Class<? extends Component> navigationTarget, List<RouteAliasData> routeAliases)	RouteData constructor.
	RouteData(List<Class<? extends RouterLayout>> parentLayouts, String template, Map<String,RouteParameterData> parameters, Class<? extends Component> navigationTarget, List<RouteAliasData> routeAliases)	RouteData constructor.
	RouteData(List<Class<? extends RouterLayout>> parentLayouts, String template, Map<String,RouteParameterData> parameters, Class<? extends Component> navigationTarget, List<RouteAliasData> routeAliases, MenuData menuData)	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	Description
static List<Class<? extends RouterLayout>>	RouteUtil.collectRouteParentLayouts(Class<? extends RouterLayout> layout)	Collects all parent layouts for a given route layout class.
Class<? extends RouterLayout>	AbstractRouteRegistry.getLayout(String path)
List<Class<? extends RouterLayout>>	RouteTarget.getParentLayouts()	Get the parent layout chain.
static List<Class<? extends RouterLayout>>	RouteUtil.getParentLayouts(RouteRegistry handledRegistry, Class<?> component, String path)	Get parent layouts for navigation target according to the Route or RouteAlias annotation or automatically link RouterLayout annotated with the Layout annotation matching route path.
static List<Class<? extends RouterLayout>>	RouteUtil.getParentLayouts(VaadinContext context, Class<?> component, String path)	Get parent layouts for navigation target according to the Route or RouteAlias annotation.
static List<Class<? extends RouterLayout>>	RouteUtil.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 abstract List<Class<? extends RouterLayout>>	AbstractNavigationStateRenderer.getRouterLayoutTypes(Class<? extends Component> routeTargetType, 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.
List<Class<? extends RouterLayout>>	ErrorStateRenderer.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 List<Class<? extends RouterLayout>>	NavigationStateRenderer.getRouterLayoutTypes(Class<? extends Component> targetType, Router router)
protected List<Class<? extends RouterLayout>>	AbstractNavigationStateRenderer.getTargetParentLayouts(RouteTarget routeTarget, RouteRegistry registry, String path)	Get the parentLayouts for given routeTarget or use an applicable @Layout when no parentLayouts defined and target is a Route annotated target with autoLayout enabled and no layout set.
static Class<? extends RouterLayout>	RouteUtil.getTopParentLayout(VaadinContext context, 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	Description
static List<Class<? extends RouterLayout>>	RouteUtil.collectRouteParentLayouts(Class<? extends RouterLayout> layout)	Collects all parent layouts for a given route layout class.
void	AbstractRouteRegistry.setLayout(Class<? extends RouterLayout> layout)
void	AbstractRouteRegistry.setRoute(String path, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain)
void	ConfigureRoutes.setRoute(String template, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain)	Set a new RouteTarget for the given template.

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

Modifier	Constructor	Description
	RouteTarget(Class<? extends Component> target, List<Class<? extends RouterLayout>> parents)	Create a new Route target holder with the given target registered.

Uses of RouterLayout in com.vaadin.flow.server

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

Modifier and Type	Method	Description
Class<? extends RouterLayout>	RouteRegistry.getLayout(String path)	Get the layout component for the current path.
Class<? extends RouterLayout>	SessionRouteRegistry.getLayout(String path)

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

Modifier and Type	Method	Description
void	RouteRegistry.setLayout(Class<? extends RouterLayout> layout)	Set a layout component for use as automatic layout.
void	RouteRegistry.setRoute(String path, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain)	Register a navigation target with specified path and given parent layout chain.

Uses of RouterLayout in com.vaadin.flow.server.startup

Method parameters in com.vaadin.flow.server.startup with type arguments of type RouterLayout

Modifier and Type	Method	Description
void	ApplicationRouteRegistry.setRoute(String path, Class<? extends Component> navigationTarget, List<Class<? extends RouterLayout>> parentChain)