Package com.vaadin.mpr.core

Class AbstractMprRouteAdapter<T extends com.vaadin.navigator.View>

  • Type Parameters:
    T - View that is wrapped and shown
    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.router.AfterNavigationObserver, com.vaadin.flow.router.HasUrlParameter<String>, com.vaadin.flow.router.internal.AfterNavigationHandler, Serializable
    @Tag("div")
public abstract class AbstractMprRouteAdapter<T extends com.vaadin.navigator.View>
extends com.vaadin.flow.component.Component
implements com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasSize, com.vaadin.flow.router.AfterNavigationObserver, com.vaadin.flow.router.HasUrlParameter<String>
    Simple route adapter that wraps a FW View so it can be used as a Flow NavigationTarget using Route without any Navigator involvement.
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void afterNavigation​(com.vaadin.flow.router.AfterNavigationEvent afterNavigationEvent)  
      protected T createInstance​(Class<?> viewClass)  
      protected abstract AbstractLegacyWrapper getLegacyWrapper​(com.vaadin.ui.Component view)  
      T getViewComponent()
      Gets the View associated with this Route Adapter
      protected abstract com.vaadin.ui.Component getViewComponent​(com.vaadin.navigator.View view)
      Gets the actual component that should be rendered for the specified View.
      protected void init()  
      void setParameter​(com.vaadin.flow.router.BeforeEvent beforeEvent, String parameters)  
      protected void setViewComponent​(T viewComponent)  

      • 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, scrollIntoView, set, setElement, setId, setVisible

      • 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

    • Constructor Detail

      • AbstractMprRouteAdapter

        public AbstractMprRouteAdapter()
        Route adapter constructor.

        View will be constructed and added as a LegacyWrapper component to the Adapter element.

    • Method Detail

      • init

        protected void init()

      • setViewComponent

        protected void setViewComponent​(T viewComponent)

      • getViewComponent

        public T getViewComponent()
        Gets the View associated with this Route Adapter
        Returns:
        the view

      • createInstance

        protected T createInstance​(Class<?> viewClass)

      • getViewComponent

        protected abstract com.vaadin.ui.Component getViewComponent​(com.vaadin.navigator.View view)
        Gets the actual component that should be rendered for the specified View. The implementation varies depending on the Vaadin version used together with MPR.
        Parameters:
        view - the input view
        Returns:
        the component to be used to render the view

      • getLegacyWrapper

        protected abstract AbstractLegacyWrapper getLegacyWrapper​(com.vaadin.ui.Component view)

      • afterNavigation

        public void afterNavigation​(com.vaadin.flow.router.AfterNavigationEvent afterNavigationEvent)
        Specified by:
        afterNavigation in interface com.vaadin.flow.router.internal.AfterNavigationHandler

      • setParameter

        public void setParameter​(com.vaadin.flow.router.BeforeEvent beforeEvent,
                         @WildcardParameter
                         String parameters)
        Specified by:
        setParameter in interface com.vaadin.flow.router.HasUrlParameter<T extends com.vaadin.navigator.View>