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

@Component("tabmod_JmixUI")
@Scope("prototype")
public class JmixUI
extends com.vaadin.flow.component.UI

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JmixUI.JmixBrowserLeaveNavigationEvent
static class	JmixUI.JmixBrowserNavigateEvent
protected static class	JmixUI.PreservedViewCache

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 final org.springframework.context.ApplicationContext	applicationContext
protected com.vaadin.flow.router.NavigationState	clientViewNavigationState
protected EventListenerDependencyInjector	eventListenerDependencyInjector
protected boolean	firstNavigation
protected String	forwardToClientUrl
protected com.vaadin.flow.component.internal.UIInternalUpdater	internalsHandler
protected String	jmixUiId
protected boolean	navigationInProgress
protected RedirectHandler	redirectHandler
static final String	STORAGE_KEY
protected View<?>	topLevelView
protected UiEventPublisher	uiEventPublisher
protected int	uiId
protected ViewNavigationSupport	viewNavigationSupport
protected final Views	views

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

CLIENT_NAVIGATE_TO, wrapperElement

Constructor Summary

Constructors

Modifier	Constructor	Description
	JmixUI(org.springframework.context.ApplicationContext context, Views views)
protected	JmixUI(org.springframework.context.ApplicationContext context, Views views, com.vaadin.flow.component.internal.UIInternalUpdater internalsHandler)

Method Summary

Modifier and Type	Method	Description
protected void	acknowledgeClient()
void	browserNavigate(JmixUI.JmixBrowserNavigateEvent event)	Connect a client with the server side UI.
protected void	cancelClient()
void	connectClient(String flowRoutePath, String flowRouteQuery, String appShellTitle, elemental.json.JsonValue historyState, String trigger)	Deprecated.
protected RedirectHandler	createRedirectHandler(Views views)
void	doInit(com.vaadin.flow.server.VaadinRequest request, int uiId, String appId)
protected EventListenerDependencyInjector	eventListenerDependencyInjector()
Optional<View<?>>	findCurrentView()	Finds the current active view within this UI context.
protected String	findCurrentViewLocationString(JmixUI ui)
static JmixUI	getCurrent()	Gets the currently used UI.
View<?>	getCurrentView()	Returns the current active View within this UI context.
protected com.vaadin.flow.router.NavigationState	getDefaultNavigationError()
String	getForwardToClientUrl()
String	getJmixUiId()	Returns the jmix id of this UI, used to link this UI with a browser tab.
protected Optional<View<?>>	getPreservedViewCache(String jmixUiId)
RedirectHandler	getRedirectHandler()	Returns the RedirectHandler associated with this instance.
com.vaadin.flow.server.VaadinSession	getSession()
protected com.vaadin.flow.server.VaadinSession	getSessionNN()
View<?>	getTopLevelView()	Returns the root view of the UI.
Optional<View<?>>	getTopLevelViewOptional()	Returns the root view of the UI if present.
int	getUIId()
protected void	handleErrorNavigation(com.vaadin.flow.router.Location location)
protected void	handleException(com.vaadin.flow.router.Location location, Exception exception)
protected void	handleNavigation(com.vaadin.flow.router.Location location, com.vaadin.flow.router.NavigationState navigationState, com.vaadin.flow.router.NavigationTrigger trigger)
protected void	handleNavigationInternal(com.vaadin.flow.router.Location location, com.vaadin.flow.router.NavigationState navigationState, com.vaadin.flow.router.NavigationTrigger trigger)
protected void	handlePageLoad(com.vaadin.flow.router.Location location, com.vaadin.flow.router.NavigationState navigationState, com.vaadin.flow.router.NavigationTrigger trigger)
protected ViewOpenMode	inferOpenMode(Class<? extends View<?>> viewClass)
protected boolean	isPostponed()
void	leaveNavigation(JmixUI.JmixBrowserLeaveNavigationEvent event)	Check that the view can be leave.
void	leaveNavigation(String route, String query)	Deprecated.
protected void	movePreservedViewCache(com.vaadin.flow.router.Location location, com.vaadin.flow.router.NavigationState navigationState, com.vaadin.flow.router.NavigationTrigger trigger, View<?> preservedView)
<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)
protected void	navigateToPlaceholder(com.vaadin.flow.router.Location location)
protected void	obtainJmixUiId(Consumer<String> resultHandler)
protected void	removePreservedViewCache(String jmixUiId)
void	removeRouterLayoutContent(com.vaadin.flow.component.HasElement oldContent)
protected void	renderTopLevelView()
protected void	renderViewForRoute(com.vaadin.flow.router.Location location, com.vaadin.flow.router.NavigationTrigger trigger)
protected void	replaceStateIfDiffersAndNoReplacePending(String route, com.vaadin.flow.router.Location location)	Do a history replaceState if the trimmed route differs from the event route and there is no pending replaceState command.
protected boolean	sameLocation(com.vaadin.flow.router.Location oldLocation, com.vaadin.flow.router.Location newLocation)
protected void	serverConnected(boolean cancel)
protected void	serverPaused()
protected void	setPreservedViewCache(String jmixUiId, View<?> topLevelView)
void	setTopLevelView(View<?> topLevelView)
protected boolean	shouldHandleNavigation(com.vaadin.flow.router.Location location)
protected boolean	shouldSkipNavigation(com.vaadin.flow.router.NavigationTrigger trigger)
void	showRouterLayoutContent(com.vaadin.flow.component.HasElement content)
protected void	skipNavigation(com.vaadin.flow.router.Location location, com.vaadin.flow.router.NavigationTrigger trigger)
protected UiEventPublisher	uiEventPublisher()
protected boolean	uiWithSameJmixUiIdExists(String jmixUiId)
protected ViewNavigationSupport	viewNavigationSupport()

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, 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

STORAGE_KEY

public static final String STORAGE_KEY

See Also:

• Constant Field Values

uiId

protected int uiId

navigationInProgress

protected boolean navigationInProgress

internalsHandler

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

jmixUiId

protected String jmixUiId

applicationContext

protected final org.springframework.context.ApplicationContext applicationContext

views

protected final Views views

redirectHandler

protected RedirectHandler redirectHandler

uiEventPublisher

protected UiEventPublisher uiEventPublisher

viewNavigationSupport

protected ViewNavigationSupport viewNavigationSupport

eventListenerDependencyInjector

protected EventListenerDependencyInjector eventListenerDependencyInjector

topLevelView

protected View<?> topLevelView

clientViewNavigationState

protected com.vaadin.flow.router.NavigationState clientViewNavigationState

forwardToClientUrl

protected String forwardToClientUrl

firstNavigation

protected boolean firstNavigation

Constructor Details

JmixUI

@Autowired
public JmixUI(org.springframework.context.ApplicationContext context,
 Views views)

JmixUI

protected JmixUI(org.springframework.context.ApplicationContext context,
 Views views,
 com.vaadin.flow.component.internal.UIInternalUpdater internalsHandler)

Method Details

createRedirectHandler

protected RedirectHandler createRedirectHandler(Views views)

getRedirectHandler

public RedirectHandler getRedirectHandler()

Returns the RedirectHandler associated with this instance.

Returns:

the RedirectHandler responsible for handling navigation redirects

getJmixUiId

@Nullable
public String getJmixUiId()

Returns the jmix id of this UI, used to link this UI with a browser tab. When this UI is initialized and a browser tab already has another UI with the same jmix id associated, the content of the previous UI is moved to this.

Returns:

the jmix id of this UI

getUIId

public int getUIId()

Overrides:

getUIId in class com.vaadin.flow.component.UI

getCurrent

@Nullable
public static JmixUI getCurrent()

Gets the currently used UI. The current UI is automatically defined when processing requests to the server. In other cases, (e.g. from background threads), the current UI is not automatically defined.

The UI is stored using a weak reference to avoid leaking memory in case it is not explicitly cleared.

Returns:

the current UI instance if available, otherwise null

See Also:

• UI.setCurrent(UI)

getSession

@Nullable
public com.vaadin.flow.server.VaadinSession getSession()

Overrides:

getSession in class com.vaadin.flow.component.UI

getSessionNN

protected com.vaadin.flow.server.VaadinSession getSessionNN()

getForwardToClientUrl

@Nullable
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

navigate

public <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)

Overrides:

navigate in class com.vaadin.flow.component.UI

navigate

public <T extends com.vaadin.flow.component.Component>
Optional<T> navigate(Class<? extends T> navigationTarget,
 com.vaadin.flow.router.QueryParameters queryParameters)

Overrides:

navigate in class com.vaadin.flow.component.UI

navigate

public <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)

Overrides:

navigate in class com.vaadin.flow.component.UI

navigate

public void navigate(String locationString,
 com.vaadin.flow.router.QueryParameters queryParameters)

Overrides:

navigate 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

replaceStateIfDiffersAndNoReplacePending

protected void replaceStateIfDiffersAndNoReplacePending(String route,
 com.vaadin.flow.router.Location location)

Do a history replaceState if the trimmed route differs from the event route and there is no pending replaceState command.

Parameters:

route - the event.route

location - the location with the trimmed route

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

acknowledgeClient

protected void acknowledgeClient()

cancelClient

protected void cancelClient()

serverPaused

protected void serverPaused()

serverConnected

protected void serverConnected(boolean cancel)

navigateToPlaceholder

protected void navigateToPlaceholder(com.vaadin.flow.router.Location location)

renderViewForRoute

protected void renderViewForRoute(com.vaadin.flow.router.Location location,
 com.vaadin.flow.router.NavigationTrigger trigger)

shouldHandleNavigation

protected boolean shouldHandleNavigation(com.vaadin.flow.router.Location location)

sameLocation

protected boolean sameLocation(com.vaadin.flow.router.Location oldLocation,
 com.vaadin.flow.router.Location newLocation)

isPostponed

protected boolean isPostponed()

handleErrorNavigation

protected void handleErrorNavigation(com.vaadin.flow.router.Location location)

getDefaultNavigationError

protected com.vaadin.flow.router.NavigationState getDefaultNavigationError()

handleNavigation

protected void handleNavigation(com.vaadin.flow.router.Location location,
 com.vaadin.flow.router.NavigationState navigationState,
 com.vaadin.flow.router.NavigationTrigger trigger)

shouldSkipNavigation

protected boolean shouldSkipNavigation(com.vaadin.flow.router.NavigationTrigger trigger)

skipNavigation

protected void skipNavigation(com.vaadin.flow.router.Location location,
 com.vaadin.flow.router.NavigationTrigger trigger)

handlePageLoad

protected void handlePageLoad(com.vaadin.flow.router.Location location,
 com.vaadin.flow.router.NavigationState navigationState,
 com.vaadin.flow.router.NavigationTrigger trigger)

movePreservedViewCache

protected void movePreservedViewCache(com.vaadin.flow.router.Location location,
 com.vaadin.flow.router.NavigationState navigationState,
 com.vaadin.flow.router.NavigationTrigger trigger,
 View<?> preservedView)

handleNavigationInternal

protected void handleNavigationInternal(com.vaadin.flow.router.Location location,
 com.vaadin.flow.router.NavigationState navigationState,
 com.vaadin.flow.router.NavigationTrigger trigger)

handleException

protected void handleException(com.vaadin.flow.router.Location location,
 Exception exception)

obtainJmixUiId

protected void obtainJmixUiId(Consumer<String> resultHandler)

uiWithSameJmixUiIdExists

protected boolean uiWithSameJmixUiIdExists(String jmixUiId)

findCurrentViewLocationString

@Nullable
protected String findCurrentViewLocationString(JmixUI ui)

inferOpenMode

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

getTopLevelView

public View<?> getTopLevelView()

Returns the root view of the UI.

Returns:

the root view of the UI

Throws:

IllegalStateException - in case there is no root view in UI

getTopLevelViewOptional

public Optional<View<?>> getTopLevelViewOptional()

Returns the root view of the UI if present.

Returns:

the root view of the UI if present

setTopLevelView

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

getCurrentView

public View<?> getCurrentView()

Returns the current active View within this UI context. This method searches for the current view using a prioritized approach:

1. Dialog windows
2. Views of the currently opened tab of a WorkArea
3. The root view

Overrides:

getCurrentView in class com.vaadin.flow.component.UI

Returns:

the current active View

Throws:

IllegalStateException - if the current View is not found

See Also:

• Views.getCurrentView(JmixUI)

findCurrentView

public Optional<View<?>> findCurrentView()

Finds the current active view within this UI context. This method searches for the current view using a prioritized approach:

1. Dialog windows
2. Views of the currently opened tab of a WorkArea
3. The root view

Returns:

an Optional containing the current view if found; otherwise, an empty Optional

See Also:

• Views.findCurrentView(JmixUI)

showRouterLayoutContent

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

removeRouterLayoutContent

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

renderTopLevelView

protected void renderTopLevelView()

getPreservedViewCache

protected Optional<View<?>> getPreservedViewCache(String jmixUiId)

setPreservedViewCache

protected void setPreservedViewCache(String jmixUiId,
 @Nullable
 View<?> topLevelView)

removePreservedViewCache

protected void removePreservedViewCache(String jmixUiId)

uiEventPublisher

protected UiEventPublisher uiEventPublisher()

viewNavigationSupport

protected ViewNavigationSupport viewNavigationSupport()

eventListenerDependencyInjector

protected EventListenerDependencyInjector eventListenerDependencyInjector()