io.jmix.ui.navigation.navigationhandler

Class ScreenNavigationHandler

java.lang.Object

io.jmix.ui.navigation.navigationhandler.ScreenNavigationHandler

All Implemented Interfaces:

NavigationHandler

@Component
 @Scope(value="prototype")
 @Order(value=970)
public class ScreenNavigationHandler
extends java.lang.Object
implements NavigationHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected io.jmix.core.AccessManager	accessManager
protected io.jmix.core.DataManager	dataManager
protected io.jmix.core.FetchPlanRepository	fetchPlanRepository
protected static int	MAX_SUB_ROUTES
protected io.jmix.core.Metadata	metadata
protected io.jmix.core.MetadataTools	metadataTools
protected WindowConfig	windowConfig

Constructor Summary

Constructors

Constructor and Description
ScreenNavigationHandler()

Method Summary

Modifier and Type	Method and Description
protected Screen	createEditor(WindowInfo windowInfo, java.lang.String screenRoute, NavigationState requestedState, AppUI ui)
protected java.util.Map<java.lang.String,java.lang.Object>	createEditorScreenOptions(WindowInfo windowInfo, NavigationState requestedState, AppUI ui)
protected Screen	createScreen(NavigationState requestedState, java.lang.String screenRoute, WindowInfo windowInfo, AppUI ui)
protected Screen	doCreateEditor(WindowInfo windowInfo, AppUI ui, OpenMode openMode, java.util.Map<java.lang.String,java.lang.Object> options)
boolean	doHandle(NavigationState requestedState, AppUI ui) Performs navigation corresponding the given requestedState.
protected NavigationState	getNestedScreenState(java.lang.String screenRoute, NavigationState requestedState)
protected OpenMode	getScreenOpenMode(java.lang.String requestedRoute, java.lang.String screenRoute, AppUI ui)
protected void	handle404(java.lang.String route, AppUI ui)
protected boolean	isEditor(WindowInfo windowInfo)
protected boolean	isScreenChanged(NavigationState requestedState, AppUI ui)
protected boolean	navigate(NavigationState requestedState, AppUI ui, java.util.List<io.jmix.core.common.datastruct.Pair<java.lang.String,WindowInfo>> routeWindowInfos)
protected void	openScreen(NavigationState requestedState, java.lang.String screenRoute, WindowInfo windowInfo, AppUI ui)
protected boolean	skipSubRoute(NavigationState requestedState, int subRouteIdx, NavigationState currentState, java.lang.String screenRoute)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_SUB_ROUTES

protected static final int MAX_SUB_ROUTES

See Also:

Constant Field Values

windowConfig

@Autowired
protected WindowConfig windowConfig

dataManager

@Autowired
protected io.jmix.core.DataManager dataManager

metadata

@Autowired
protected io.jmix.core.Metadata metadata

fetchPlanRepository

@Autowired
protected io.jmix.core.FetchPlanRepository fetchPlanRepository

metadataTools

@Autowired
protected io.jmix.core.MetadataTools metadataTools

accessManager

@Autowired
protected io.jmix.core.AccessManager accessManager

Constructor Detail

ScreenNavigationHandler

public ScreenNavigationHandler()

Method Detail

doHandle

public boolean doHandle(NavigationState requestedState,
                        AppUI ui)

Description copied from interface: NavigationHandler

Performs navigation corresponding the given requestedState.

Specified by:

doHandle in interface NavigationHandler

Parameters:

requestedState - requested state represented by NavigationState instance

ui - current UI

Returns:

true if requestedState is fully handled by the handler or false if requestedState should be passed through handlers chain

navigate

protected boolean navigate(NavigationState requestedState,
                           AppUI ui,
                           java.util.List<io.jmix.core.common.datastruct.Pair<java.lang.String,WindowInfo>> routeWindowInfos)

handle404

protected void handle404(java.lang.String route,
                         AppUI ui)

isScreenChanged

protected boolean isScreenChanged(NavigationState requestedState,
                                  AppUI ui)

skipSubRoute

protected boolean skipSubRoute(NavigationState requestedState,
                               int subRouteIdx,
                               NavigationState currentState,
                               java.lang.String screenRoute)

openScreen

protected void openScreen(NavigationState requestedState,
                          java.lang.String screenRoute,
                          WindowInfo windowInfo,
                          AppUI ui)

getNestedScreenState

protected NavigationState getNestedScreenState(java.lang.String screenRoute,
                                               NavigationState requestedState)

createScreen

protected Screen createScreen(NavigationState requestedState,
                              java.lang.String screenRoute,
                              WindowInfo windowInfo,
                              AppUI ui)

createEditor

protected Screen createEditor(WindowInfo windowInfo,
                              java.lang.String screenRoute,
                              NavigationState requestedState,
                              AppUI ui)

doCreateEditor

protected Screen doCreateEditor(WindowInfo windowInfo,
                                AppUI ui,
                                OpenMode openMode,
                                java.util.Map<java.lang.String,java.lang.Object> options)

getScreenOpenMode

protected OpenMode getScreenOpenMode(java.lang.String requestedRoute,
                                     java.lang.String screenRoute,
                                     AppUI ui)

createEditorScreenOptions

@Nullable
protected java.util.Map<java.lang.String,java.lang.Object> createEditorScreenOptions(WindowInfo windowInfo,
                                                                                               NavigationState requestedState,
                                                                                               AppUI ui)

isEditor

protected boolean isEditor(WindowInfo windowInfo)