Package io.jmix.flowui.sys

Class ViewSupport

java.lang.Object

io.jmix.flowui.sys.ViewSupport

@Component("flowui_ViewSupport")
public class ViewSupport
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ViewSupport.BackwardNavigationTargets

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	applicationContext
protected CurrentAuthentication	currentAuthentication
protected ViewControllerDependencyManager	dependencyManager
protected io.micrometer.core.instrument.MeterRegistry	meterRegistry
protected ViewNavigationSupport	navigationSupport
protected RouteSupport	routeSupport
protected Map<String,String>	titleCache
protected ViewRegistry	viewRegistry
protected ViewXmlLoader	viewXmlLoader

Constructor Summary

Constructors

Constructor	Description
ViewSupport(org.springframework.context.ApplicationContext applicationContext, ViewXmlLoader viewXmlLoader, ViewRegistry viewRegistry, ViewNavigationSupport navigationSupport, CurrentAuthentication currentAuthentication, ViewControllerDependencyManager dependencyManager, RouteSupport routeSupport, io.micrometer.core.instrument.MeterRegistry meterRegistry)

Method Summary

Modifier and Type	Method	Description
protected void	cacheTitle(String key, String value)
void	close(com.vaadin.flow.component.UI ui, View<?> view)
void	close(com.vaadin.flow.component.UI ui, View<?> view, com.vaadin.flow.router.QueryParameters returnParams)
void	close(View<?> view)
void	close(View<?> view, com.vaadin.flow.router.QueryParameters returnParams)
protected ComponentLoaderContext	createComponentLoaderContext()
protected void	doBackwardNavigation(com.vaadin.flow.component.UI ui, View<?> view, com.vaadin.flow.router.QueryParameters returnParams)
protected void	doBackwardNavigation(com.vaadin.flow.component.UI ui, String windowName, View<?> view, com.vaadin.flow.router.QueryParameters returnParams)
protected Optional<com.vaadin.flow.router.RouteData>	findRouteData(Class<?> target, List<com.vaadin.flow.router.RouteData> routes)
protected void	fireViewInitEvent(View<?> view)
protected String	getInferredViewId(View<?> view)
String	getLocalizedTitle(View<?> view)	Gets localized title for the view.
String	getLocalizedTitle(View<?> view, boolean cached)	Gets localized title for the view.
String	getLocalizedTitle(View<?> view, Locale locale)	Gets localized title for the view.
String	getLocalizedTitle(View<?> view, Locale locale, boolean cached)	Gets localized title for the view.
String	getLocalizedTitle(ViewInfo viewInfo)	Gets localized title for the view info.
String	getLocalizedTitle(ViewInfo viewInfo, boolean cached)	Gets localized title for the view info.
String	getLocalizedTitle(ViewInfo viewInfo, Locale locale)	Gets localized title for the view info.
String	getLocalizedTitle(ViewInfo viewInfo, Locale locale, boolean cached)	Gets localized title for the view info.
protected String	getTitleCacheKey(String id, Locale locale)
protected String	getViewMessageGroup(ViewInfo viewInfo)
protected String	getViewTitleValue(ViewInfo viewInfo)
protected boolean	hasBackwardNavigationTarget(com.vaadin.flow.component.UI ui, Class<? extends View> viewClass)
void	initView(View<?> view)
protected Optional<String>	loadMessageGroup(org.dom4j.Element element)
protected org.dom4j.Element	loadViewXml(ViewInfo viewInfo)
protected void	loadWindowFromXml(org.dom4j.Element element, View<?> view, ComponentLoaderContext context)
void	navigateToParentLayout(View<?> view, com.vaadin.flow.router.QueryParameters returnParams)
void	registerBackwardNavigation(com.vaadin.flow.component.UI ui, Class<? extends View> viewClass, URL url)
protected void	registerBackwardNavigation(com.vaadin.flow.server.VaadinSession session, String windowName, Class<? extends View> viewClass, URL url)
void	registerBackwardNavigation(Class<? extends View> viewClass, URL url)
protected void	retrieveExtendedClientDetails(com.vaadin.flow.component.UI ui, Consumer<com.vaadin.flow.component.page.ExtendedClientDetails> details)
void	unregisterBackwardNavigation(com.vaadin.flow.component.UI ui, Class<? extends View> viewClass)
protected void	unregisterBackwardNavigation(com.vaadin.flow.server.VaadinSession session, String windowName)
void	unregisterBackwardNavigation(View<?> view)
void	unregisterBackwardNavigation(Class<? extends View> viewClass)

Methods inherited from class java.lang.Object

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

Field Details

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

viewXmlLoader

protected ViewXmlLoader viewXmlLoader

viewRegistry

protected ViewRegistry viewRegistry

navigationSupport

protected ViewNavigationSupport navigationSupport

currentAuthentication

protected CurrentAuthentication currentAuthentication

dependencyManager

protected ViewControllerDependencyManager dependencyManager

routeSupport

protected RouteSupport routeSupport

meterRegistry

protected io.micrometer.core.instrument.MeterRegistry meterRegistry

titleCache

protected Map<String,String> titleCache

Constructor Details

ViewSupport

public ViewSupport(org.springframework.context.ApplicationContext applicationContext,
 ViewXmlLoader viewXmlLoader,
 ViewRegistry viewRegistry,
 ViewNavigationSupport navigationSupport,
 CurrentAuthentication currentAuthentication,
 ViewControllerDependencyManager dependencyManager,
 RouteSupport routeSupport,
 io.micrometer.core.instrument.MeterRegistry meterRegistry)

Method Details

initView

public void initView(View<?> view)

registerBackwardNavigation

public void registerBackwardNavigation(Class<? extends View> viewClass,
 URL url)

registerBackwardNavigation

public void registerBackwardNavigation(com.vaadin.flow.component.UI ui,
 Class<? extends View> viewClass,
 URL url)

registerBackwardNavigation

protected void registerBackwardNavigation(com.vaadin.flow.server.VaadinSession session,
 String windowName,
 Class<? extends View> viewClass,
 URL url)

unregisterBackwardNavigation

public void unregisterBackwardNavigation(View<?> view)

unregisterBackwardNavigation

public void unregisterBackwardNavigation(Class<? extends View> viewClass)

unregisterBackwardNavigation

public void unregisterBackwardNavigation(com.vaadin.flow.component.UI ui,
 Class<? extends View> viewClass)

unregisterBackwardNavigation

protected void unregisterBackwardNavigation(com.vaadin.flow.server.VaadinSession session,
 String windowName)

getLocalizedTitle

public String getLocalizedTitle(View<?> view)

Gets localized title for the view.

Parameters:

view - view to get localized title for

Returns:

localized page title or empty string. If possible, returns cached value.

See Also:

• PageTitle
• HasDynamicTitle

getLocalizedTitle

public String getLocalizedTitle(View<?> view,
 boolean cached)

Gets localized title for the view.

Parameters:

view - view to get localized title for

cached - whether to use the cached value

Returns:

localized page title or empty string.

See Also:

• PageTitle
• HasDynamicTitle

getLocalizedTitle

public String getLocalizedTitle(View<?> view,
 Locale locale)

Gets localized title for the view.

Parameters:

view - view to get localized title for

locale - the locale to get the title for

Returns:

localized page title or empty string. If possible, returns cached value.

See Also:

• PageTitle
• HasDynamicTitle

getLocalizedTitle

public String getLocalizedTitle(View<?> view,
 Locale locale,
 boolean cached)

Gets localized title for the view.

Parameters:

view - view to get localized title for

locale - the locale to get the title for

cached - whether to use the cached value

Returns:

localized page title or empty string.

See Also:

• PageTitle
• HasDynamicTitle

getLocalizedTitle

public String getLocalizedTitle(ViewInfo viewInfo)

Gets localized title for the view info.

Parameters:

viewInfo - view info to get localized title for

Returns:

localized page title or empty string. If possible, returns cached value.

See Also:

• PageTitle
• HasDynamicTitle

getLocalizedTitle

public String getLocalizedTitle(ViewInfo viewInfo,
 boolean cached)

Gets localized title for the view info.

Parameters:

viewInfo - view info to get localized title for

cached - whether to use the cached value

Returns:

localized page title or empty string.

See Also:

• PageTitle
• HasDynamicTitle

getLocalizedTitle

public String getLocalizedTitle(ViewInfo viewInfo,
 Locale locale)

Gets localized title for the view info.

Parameters:

viewInfo - view info to get localized title for

locale - the locale to get the title for

Returns:

localized page title or empty string. If possible, returns cached value.

See Also:

• PageTitle
• HasDynamicTitle

getLocalizedTitle

public String getLocalizedTitle(ViewInfo viewInfo,
 Locale locale,
 boolean cached)

Gets localized title for the view info.

Parameters:

viewInfo - view info to get the localized title for

locale - the locale to get the title for

cached - whether to use the cached value

Returns:

localized page title or empty string.

See Also:

• PageTitle
• HasDynamicTitle

close

public void close(View<?> view)

close

public void close(View<?> view,
 com.vaadin.flow.router.QueryParameters returnParams)

close

public void close(com.vaadin.flow.component.UI ui,
 View<?> view)

close

public void close(com.vaadin.flow.component.UI ui,
 View<?> view,
 com.vaadin.flow.router.QueryParameters returnParams)

hasBackwardNavigationTarget

protected boolean hasBackwardNavigationTarget(com.vaadin.flow.component.UI ui,
 Class<? extends View> viewClass)

doBackwardNavigation

protected void doBackwardNavigation(com.vaadin.flow.component.UI ui,
 View<?> view,
 com.vaadin.flow.router.QueryParameters returnParams)

doBackwardNavigation

protected void doBackwardNavigation(com.vaadin.flow.component.UI ui,
 String windowName,
 View<?> view,
 com.vaadin.flow.router.QueryParameters returnParams)

navigateToParentLayout

public void navigateToParentLayout(View<?> view,
 com.vaadin.flow.router.QueryParameters returnParams)

findRouteData

protected Optional<com.vaadin.flow.router.RouteData> findRouteData(Class<?> target,
 List<com.vaadin.flow.router.RouteData> routes)

retrieveExtendedClientDetails

protected void retrieveExtendedClientDetails(com.vaadin.flow.component.UI ui,
 Consumer<com.vaadin.flow.component.page.ExtendedClientDetails> details)

getInferredViewId

protected String getInferredViewId(View<?> view)

fireViewInitEvent

protected void fireViewInitEvent(View<?> view)

loadViewXml

@Nullable
protected org.dom4j.Element loadViewXml(ViewInfo viewInfo)

loadMessageGroup

protected Optional<String> loadMessageGroup(org.dom4j.Element element)

createComponentLoaderContext

protected ComponentLoaderContext createComponentLoaderContext()

loadWindowFromXml

protected void loadWindowFromXml(org.dom4j.Element element,
 View<?> view,
 ComponentLoaderContext context)

getViewTitleValue

@Nullable
protected String getViewTitleValue(ViewInfo viewInfo)

getViewMessageGroup

protected String getViewMessageGroup(ViewInfo viewInfo)

getTitleCacheKey

protected String getTitleCacheKey(String id,
 Locale locale)

cacheTitle

protected void cacheTitle(String key,
 String value)