Package io.jmix.tabbedmode

Class JmixUI

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.UI
io.jmix.tabbedmode.JmixUI
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.HasStyle, com.vaadin.flow.component.PollNotifier, com.vaadin.flow.router.RouterLayout, Serializable
@SpringComponent @Scope("prototype") public class JmixUI extends com.vaadin.flow.component.UI
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    JmixUI.JmixBrowserLeaveNavigationEvent
     
    static class 
    JmixUI.JmixBrowserNavigateEvent
     

    Nested classes/interfaces inherited from class com.vaadin.flow.component.UI

    com.vaadin.flow.component.UI.BrowserLeaveNavigationEvent, com.vaadin.flow.component.UI.BrowserNavigateEvent, com.vaadin.flow.component.UI.BrowserRefreshEvent, com.vaadin.flow.component.UI.ClientViewPlaceholder

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected com.vaadin.flow.component.internal.UIInternalUpdater
    internalsHandler
     
    protected RedirectHandler
    redirectHandler
     
    protected View<?>
    topLevelView
     
    protected final Views
    views
     

    Fields inherited from class com.vaadin.flow.component.UI

    CLIENT_NAVIGATE_TO, wrapperElement

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    JmixUI(Views views)
     
    protected
    JmixUI(Views views, com.vaadin.flow.component.internal.UIInternalUpdater internalsHandler)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    browserNavigate(JmixUI.JmixBrowserNavigateEvent event)
    Connect a client with the server side UI.
    void
    connectClient(String flowRoutePath, String flowRouteQuery, String appShellTitle, elemental.json.JsonValue historyState, String trigger)
    Deprecated.
    void
    doInit(com.vaadin.flow.server.VaadinRequest request, int uiId, String appId)
     
    static JmixUI
    getCurrent()
     
    com.vaadin.flow.component.Component
    getCurrentView()
     
    String
    getForwardToClientUrl()
     
    RedirectHandler
    getRedirectHandler()
     
    View<?>
    getTopLevelView()
     
    Optional<View<?>>
    getTopLevelViewOptional()
     
    int
    getUIId()
     
    protected ViewOpenMode
    inferOpenMode(Class<? extends View<?>> viewClass)
     
    protected String
    inferTopLevelWindowId()
     
    protected boolean
    isAnonymousAuthentication()
     
    void
    leaveNavigation(JmixUI.JmixBrowserLeaveNavigationEvent event)
    Check that the view can be leave.
    void
    leaveNavigation(String route, String query)
    Deprecated.
    <C extends com.vaadin.flow.component.Component>
    Optional<C>
    navigate(Class<? extends C> navigationTarget, com.vaadin.flow.router.RouteParameters routeParameter, com.vaadin.flow.router.QueryParameters queryParameters)
     
    <T, C extends com.vaadin.flow.component.Component & com.vaadin.flow.router.HasUrlParameter<T>>
    Optional<C>
    navigate(Class<? extends C> navigationTarget, T parameter, com.vaadin.flow.router.QueryParameters queryParameters)
     
    <T extends com.vaadin.flow.component.Component>
    Optional<T>
    navigate(Class<? extends T> navigationTarget, com.vaadin.flow.router.QueryParameters queryParameters)
     
    void
    navigate(String locationString, com.vaadin.flow.router.QueryParameters queryParameters)
     
    void
    removeRouterLayoutContent(com.vaadin.flow.component.HasElement oldContent)
     
    protected void
    renderTopLevelView()
     
    void
    setTopLevelView(View<?> topLevelView)
     
    void
    showRouterLayoutContent(com.vaadin.flow.component.HasElement content)
     

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

    access, accessLater, accessLater, accessSynchronously, add, addAfterNavigationListener, addBeforeEnterListener, addBeforeLeaveListener, addHeartbeatListener, addModal, addShortcutListener, addShortcutListener, addToModalComponent, beforeClientResponse, browserNavigate, close, doInit, getActiveDragSourceComponent, getActiveRouterTargetsChain, getActiveViewLocation, getChildren, getCsrfToken, getElement, getInternals, getLoadingIndicatorConfiguration, getLocale, getNavigationListeners, getPage, getPollInterval, getPushConfiguration, getReconnectDialogConfiguration, getRouter, getSession, getUI, hasModalComponent, init, isClosing, isNavigationSupported, leaveNavigation, navigate, navigate, navigate, navigate, navigate, navigateToClient, onAttach, onDetach, push, refreshCurrentRoute, setChildComponentModal, setCurrent, setDirection, setLocale, setPollInterval

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

    addListener, findAncestor, fireEvent, from, get, getEventBus, getId, getListeners, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, hasListener, isAttached, isTemplateMapped, isVisible, 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, addComponentAsFirst, addComponentAtIndex, remove, remove, removeAll

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

    isEnabled, setEnabled

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

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

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

    addPollListener

  • Field Details

    • views

      protected final Views views

    • topLevelView

      protected View<?> topLevelView

    • internalsHandler

      protected com.vaadin.flow.component.internal.UIInternalUpdater internalsHandler

    • redirectHandler

      protected RedirectHandler redirectHandler

  • Constructor Details

    • JmixUI

      @Autowired public JmixUI(Views views)

    • JmixUI

      protected JmixUI(Views views, com.vaadin.flow.component.internal.UIInternalUpdater internalsHandler)

  • Method Details

    • getUIId

      public int getUIId()
      Overrides:
      getUIId in class com.vaadin.flow.component.UI

    • getCurrent

      @Nullable public static JmixUI getCurrent()

    • getForwardToClientUrl

      public String getForwardToClientUrl()
      Overrides:
      getForwardToClientUrl in class com.vaadin.flow.component.UI

    • doInit

      public void doInit(com.vaadin.flow.server.VaadinRequest request, int uiId, String appId)
      Overrides:
      doInit in class com.vaadin.flow.component.UI

    • connectClient

      @Deprecated public void connectClient(String flowRoutePath, String flowRouteQuery, String appShellTitle, elemental.json.JsonValue historyState, String trigger)
      Deprecated.
      Overrides:
      connectClient in class com.vaadin.flow.component.UI

    • browserNavigate

      public void browserNavigate(JmixUI.JmixBrowserNavigateEvent event)
      Connect a client with the server side UI. This method is invoked each time client router navigates to a server route.
      Parameters:
      event - the event from the browser

    • leaveNavigation

      @Deprecated public void leaveNavigation(String route, String query)
      Deprecated.
      Overrides:
      leaveNavigation in class com.vaadin.flow.component.UI

    • leaveNavigation

      public void leaveNavigation(JmixUI.JmixBrowserLeaveNavigationEvent event)
      Check that the view can be leave. This method is invoked when the client router tries to navigate to a client route while the current route is a server route.

      This is only called when client route navigates from a server to a client view.

      Parameters:
      event - the event from the browser

    • inferOpenMode

      protected ViewOpenMode inferOpenMode(Class<? extends View<?>> viewClass)

    • getRedirectHandler

      public RedirectHandler getRedirectHandler()

    • getTopLevelView

      public View<?> getTopLevelView()

    • getTopLevelViewOptional

      public Optional<View<?>> getTopLevelViewOptional()

    • setTopLevelView

      public void setTopLevelView(@Nullable View<?> topLevelView)

    • getCurrentView

      public com.vaadin.flow.component.Component getCurrentView()
      Overrides:
      getCurrentView in class com.vaadin.flow.component.UI

    • showRouterLayoutContent

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

    • removeRouterLayoutContent

      public void removeRouterLayoutContent(com.vaadin.flow.component.HasElement oldContent)

    • renderTopLevelView

      protected void renderTopLevelView()

    • inferTopLevelWindowId

      protected String inferTopLevelWindowId()

    • isAnonymousAuthentication

      protected boolean isAnonymousAuthentication()