Package com.vaadin.mpr.core

Class MprNavigator

  • All Implemented Interfaces:
    Serializable
    public class MprNavigator
extends com.vaadin.navigator.Navigator
    MPR extension of Navigator so we can handle navigation between legacy Navigator and Flow Router.
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.vaadin.navigator.Navigator

        com.vaadin.navigator.Navigator.ClassBasedViewProvider, com.vaadin.navigator.Navigator.ComponentContainerViewDisplay, com.vaadin.navigator.Navigator.EmptyView, com.vaadin.navigator.Navigator.SingleComponentContainerViewDisplay, com.vaadin.navigator.Navigator.StaticViewProvider, com.vaadin.navigator.Navigator.UriFragmentManager

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected MprNavigator​(com.vaadin.ui.UI ui, com.vaadin.ui.ComponentContainer container)
      MprNavigator override to get the used ComponentContainer for adding as a AbstractLegacyWrapper component.
      protected MprNavigator​(com.vaadin.ui.UI ui, com.vaadin.ui.SingleComponentContainer container)
      MprNavigator override to get the used SingleComponentContainer for adding as a AbstractLegacyWrapper component.
        MprNavigator​(com.vaadin.ui.UI ui, Class<? extends AbstractMprNavigatorRoute> mprNavigatorRoute)
      MprNavigator constructor.
        MprNavigator​(com.vaadin.ui.UI ui, Class<? extends AbstractMprNavigatorRoute> mprNavigatorRoute, com.vaadin.ui.ComponentContainer container)
      Constructor with given component container instance.
        MprNavigator​(com.vaadin.ui.UI ui, Class<? extends AbstractMprNavigatorRoute> mprNavigatorRoute, com.vaadin.ui.SingleComponentContainer container)
      Constructor with given single component container instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.vaadin.ui.HasComponents getViewDisplay()
      Get the view display used for showing the active view.
      void navigateTo​(String navigationState)  

      • Methods inherited from class com.vaadin.navigator.Navigator

        addProvider, addView, addView, addViewChangeListener, beforeViewChange, destroy, fireAfterViewChange, fireBeforeViewChange, getCurrentView, getDisplay, getState, getStateManager, getUI, init, navigateTo, removeProvider, removeView, removeViewChangeListener, revertNavigation, setErrorProvider, setErrorView, setErrorView, switchView, updateNavigationState

    • Constructor Detail

      • MprNavigator

        public MprNavigator​(com.vaadin.ui.UI ui,
                    Class<? extends AbstractMprNavigatorRoute> mprNavigatorRoute)
        MprNavigator constructor.
        Parameters:
        ui - legacy UI instance of this navigator
        mprNavigatorRoute - Flow view containing navigator component container

      • MprNavigator

        public MprNavigator​(com.vaadin.ui.UI ui,
                    Class<? extends AbstractMprNavigatorRoute> mprNavigatorRoute,
                    com.vaadin.ui.ComponentContainer container)
        Constructor with given component container instance.
        Parameters:
        ui - legacy UI instance of this navigator
        mprNavigatorRoute - Flow view containing navigator component container
        container - The ComponentContainer whose contents should be replaced with the active view on view change

      • MprNavigator

        public MprNavigator​(com.vaadin.ui.UI ui,
                    Class<? extends AbstractMprNavigatorRoute> mprNavigatorRoute,
                    com.vaadin.ui.SingleComponentContainer container)
        Constructor with given single component container instance.
        Parameters:
        ui - legacy UI instance of this navigator
        mprNavigatorRoute - Flow view containing navigator component container
        container - The SingleComponentContainer whose contents should be replaced with the active view on view change

      • MprNavigator

        protected MprNavigator​(com.vaadin.ui.UI ui,
                       com.vaadin.ui.ComponentContainer container)
        MprNavigator override to get the used ComponentContainer for adding as a AbstractLegacyWrapper component.
        Parameters:
        ui - legacy UI instance of this navigator
        container - The ComponentContainer whose contents should be replaced with the active view on view change

      • MprNavigator

        protected MprNavigator​(com.vaadin.ui.UI ui,
                       com.vaadin.ui.SingleComponentContainer container)
        MprNavigator override to get the used SingleComponentContainer for adding as a AbstractLegacyWrapper component.
        Parameters:
        ui - legacy UI instance of this navigator
        container - The SingleComponentContainer whose contents should be replaced with the active view on view change

    • Method Detail

      • navigateTo

        public void navigateTo​(String navigationState)
        Overrides:
        navigateTo in class com.vaadin.navigator.Navigator

      • getViewDisplay

        public com.vaadin.ui.HasComponents getViewDisplay()
        Get the view display used for showing the active view.
        Returns:
        Navigator component