Package com.vaadin.mpr.core

Class AbstractMprNavigatorRoute

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.mpr.core.AbstractMprNavigatorRoute
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, Serializable
@Tag("div") public abstract class AbstractMprNavigatorRoute extends com.vaadin.flow.component.Component implements com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasComponents
MPR helper class that makes it easier to handle how a legacy Navigator coexists with Flow routing.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractMprNavigatorRoute()
    Navigator route constructor.
    AbstractMprNavigatorRoute(com.vaadin.ui.ComponentContainer container)
    Navigator route constructor with componentContainer for navigator.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract void
    configureNavigator(com.vaadin.navigator.Navigator navigator)
    Initialize the navigation routes for the legacy Navigator.
    com.vaadin.navigator.Navigator
    getNavigator()
    Get the navigator registered for the current FW UI.
    protected com.vaadin.navigator.Navigator
    getNavigator(com.vaadin.ui.ComponentContainer container)
    Get the navigator registered for the current FW UI or create a new one using given container.
    protected abstract AbstractLegacyWrapper
    getWrapper(com.vaadin.ui.Component component)
     
    void
    navigateTo(String navigationState)
    Shorthand for navigating to new view.

    Methods inherited from class com.vaadin.flow.component.Component

    addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.vaadin.flow.component.AttachNotifier

    addAttachListener

    Methods inherited from interface com.vaadin.flow.component.DetachNotifier

    addDetachListener

    Methods inherited from interface com.vaadin.flow.component.HasComponents

    add, add, add, addComponentAsFirst, addComponentAtIndex, remove, remove, removeAll

    Methods inherited from interface com.vaadin.flow.component.HasElement

    getElement

    Methods inherited from interface com.vaadin.flow.component.HasEnabled

    isEnabled, setEnabled

    Methods inherited from interface com.vaadin.flow.component.HasSize

    getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

    Methods inherited from interface com.vaadin.flow.component.HasStyle

    addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

  • Constructor Details

    • AbstractMprNavigatorRoute

      public AbstractMprNavigatorRoute()
      Navigator route constructor.

    • AbstractMprNavigatorRoute

      public AbstractMprNavigatorRoute(com.vaadin.ui.ComponentContainer container)
      Navigator route constructor with componentContainer for navigator.
      Parameters:
      container - Layout component that should be used with navigator

  • Method Details

    • getWrapper

      protected abstract AbstractLegacyWrapper getWrapper(com.vaadin.ui.Component component)

    • configureNavigator

      public abstract void configureNavigator(com.vaadin.navigator.Navigator navigator)
      Initialize the navigation routes for the legacy Navigator.
      Parameters:
      navigator - navigator to configure

    • getNavigator

      public com.vaadin.navigator.Navigator getNavigator()
      Get the navigator registered for the current FW UI.
      Returns:
      Current UI Navigator instance.

    • getNavigator

      protected com.vaadin.navigator.Navigator getNavigator(com.vaadin.ui.ComponentContainer container)
      Get the navigator registered for the current FW UI or create a new one using given container.
      Parameters:
      container - The ComponentContainer to use with the Navigator
      Returns:
      Current UI Navigator instance.