com.vaadin.flow.component.applayout

Class AbstractAppRouterLayout

java.lang.Object

com.vaadin.flow.component.applayout.AbstractAppRouterLayout

All Implemented Interfaces:

com.vaadin.flow.component.HasElement, com.vaadin.flow.router.RouterLayout, Serializable

public abstract class AbstractAppRouterLayout
extends Object
implements com.vaadin.flow.router.RouterLayout

Convenience class for using an AppLayout as a parent layout in a Flow application. Basic usage involves extending this class and implementing the configure method.

See Also:

configure(AppLayout, AppLayoutMenu), Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAppRouterLayout()

Method Summary

Modifier and Type	Method and Description
protected void	afterNavigate(String route, com.vaadin.flow.component.HasElement content) This hook is called after a navigation is made into a route which has this router layout as its parent layout.
protected void	beforeNavigate(String route, com.vaadin.flow.component.HasElement content) This hook is called before a navigation is being made into a route which has this router layout as its parent layout.
protected abstract void	configure(AppLayout appLayout, AppLayoutMenu appLayoutMenu) This hook is called when this router layout is being constructed and provides an opportunity to configure the AppLayout in use.
AppLayout	getAppLayout()
AppLayoutMenu	getAppLayoutMenu()
com.vaadin.flow.dom.Element	getElement()
void	showRouterLayoutContent(com.vaadin.flow.component.HasElement content)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAppRouterLayout

protected AbstractAppRouterLayout()

Method Detail

configure

protected abstract void configure(AppLayout appLayout,
                                  AppLayoutMenu appLayoutMenu)

This hook is called when this router layout is being constructed and provides an opportunity to configure the AppLayout in use.

Parameters:

appLayout - AppLayout parent layout

appLayoutMenu - AppLayoutMenu to configure.

beforeNavigate

protected void beforeNavigate(String route,
                              com.vaadin.flow.component.HasElement content)

This hook is called before a navigation is being made into a route which has this router layout as its parent layout.

Parameters:

route - route that is being navigated to

content - HasElement the content component being added

afterNavigate

protected void afterNavigate(String route,
                             com.vaadin.flow.component.HasElement content)

This hook is called after a navigation is made into a route which has this router layout as its parent layout.

Parameters:

route - route navigated to

content - HasElement the content component added

showRouterLayoutContent

public void showRouterLayoutContent(com.vaadin.flow.component.HasElement content)

Specified by:

showRouterLayoutContent in interface com.vaadin.flow.router.RouterLayout

getElement

public com.vaadin.flow.dom.Element getElement()

Specified by:

getElement in interface com.vaadin.flow.component.HasElement

getAppLayout

public AppLayout getAppLayout()

Returns:

AppLayout parent layout

getAppLayoutMenu

public AppLayoutMenu getAppLayoutMenu()

Returns:

AppLayoutMenu which will be updated on navigation.