io.jmix.ui.navigation

Class WebUrlRouting

java.lang.Object

io.jmix.ui.navigation.WebUrlRouting

All Implemented Interfaces:

UrlRouting

@UIScope
 @Component(value="ui_UrlRouting")
public class WebUrlRouting
extends java.lang.Object
implements UrlRouting

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	WebUrlRouting.RouteGeneratorImpl

Nested classes/interfaces inherited from interface io.jmix.ui.navigation.UrlRouting

UrlRouting.RouteGenerator

Field Summary

Fields

Modifier and Type	Field and Description
protected io.jmix.core.EntityStates	entityStates
protected java.lang.String	lastHistoryOperation
protected static int	MAX_NESTING
protected io.jmix.core.Metadata	metadata
static java.lang.String	NEW_ENTITY_ID
protected Screens	screens
protected AppUI	ui
protected UiProperties	uiProperties
protected UrlTools	urlTools
protected WindowConfig	windowConfig

Constructor Summary

Constructors

Constructor and Description
WebUrlRouting()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	buildDialogRoute(Screen dialog)
protected NavigationState	buildNavState(Screen screen, java.util.Map<java.lang.String,java.lang.String> urlParams)
protected java.lang.String	buildNestedRoute(Screen screen)
protected java.util.Map<java.lang.String,java.lang.String>	buildParams(Screen screen, java.util.Map<java.lang.String,java.lang.String> urlParams)
protected java.lang.String	buildScreenRoute(Screen screen)
protected java.lang.String	buildSubRoute(java.lang.String prevSubRoute, Screen screen)
protected boolean	checkConditions(Screen screen, java.util.Map<java.lang.String,java.lang.String> urlParams)
protected boolean	externalNavigation(NavigationState currentState, NavigationState newState)
protected Screen	findActiveScreenByState(NavigationState requestedState)
protected Screen	findScreenByState(java.util.Collection<Screen> screens, NavigationState requestedState)
java.lang.String	getLastHistoryOperation()
protected Screens.OpenedScreens	getOpenedScreens()
protected java.lang.String	getParentPrefix(Screen screen)
protected java.lang.String	getRoute(Screen screen)
protected RouteDefinition	getRouteDef(Screen screen)
UrlRouting.RouteGenerator	getRouteGenerator()
NavigationState	getState()
protected java.lang.String	getStateMark(Screen screen)
protected boolean	isEditor(Screen screen)
protected boolean	isNotFoundScreen(Screen screen)
protected boolean	notAttachedToUi(Screen screen)
protected boolean	omitParams(Screen screen)
void	pushState(Screen screen, java.util.Map<java.lang.String,java.lang.String> urlParams) Pushes the state corresponding to the given screen.
void	replaceState(Screen screen, java.util.Map<java.lang.String,java.lang.String> urlParams) Replaces current state by the state corresponding to the given screen.
void	setAppUi(AppUI ui)
protected void	updateState(Screen screen, java.util.Map<java.lang.String,java.lang.String> urlParams, boolean pushState)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.ui.navigation.UrlRouting

pushState, replaceState

Field Detail

NEW_ENTITY_ID

public static final java.lang.String NEW_ENTITY_ID

See Also:

Constant Field Values

MAX_NESTING

protected static final int MAX_NESTING

See Also:

Constant Field Values

uiProperties

@Autowired
protected UiProperties uiProperties

windowConfig

@Autowired
protected WindowConfig windowConfig

metadata

@Autowired
protected io.jmix.core.Metadata metadata

urlTools

@Autowired
protected UrlTools urlTools

entityStates

@Autowired
protected io.jmix.core.EntityStates entityStates

screens

@Autowired
protected Screens screens

ui

protected AppUI ui

lastHistoryOperation

protected java.lang.String lastHistoryOperation

Constructor Detail

WebUrlRouting

public WebUrlRouting()

Method Detail

setAppUi

@Autowired
public void setAppUi(AppUI ui)

pushState

public void pushState(Screen screen,
                      java.util.Map<java.lang.String,java.lang.String> urlParams)

Description copied from interface: UrlRouting

Pushes the state corresponding to the given screen.

The given urlParams will be reflected in URI as GET request params.

Creates new entry in browser history.

Specified by:

pushState in interface UrlRouting

Parameters:

screen - screen that is used to build new navigation state

urlParams - URI params map

replaceState

public void replaceState(Screen screen,
                         java.util.Map<java.lang.String,java.lang.String> urlParams)

Description copied from interface: UrlRouting

Replaces current state by the state corresponding to the given screen.

The given urlParams will be reflected in URI as GET request params.

Doesn't create new entry in browser history.

Specified by:

replaceState in interface UrlRouting

Parameters:

screen - screen that is used to build new navigation state

urlParams - URI params map

getState

public NavigationState getState()

Specified by:

getState in interface UrlRouting

Returns:

current state parsed from URI fragment.

getRouteGenerator

public UrlRouting.RouteGenerator getRouteGenerator()

Specified by:

getRouteGenerator in interface UrlRouting

Returns:

UrlRouting.RouteGenerator instance

updateState

protected void updateState(Screen screen,
                           java.util.Map<java.lang.String,java.lang.String> urlParams,
                           boolean pushState)

buildNavState

protected NavigationState buildNavState(Screen screen,
                                        java.util.Map<java.lang.String,java.lang.String> urlParams)

buildNestedRoute

protected java.lang.String buildNestedRoute(Screen screen)

buildDialogRoute

protected java.lang.String buildDialogRoute(Screen dialog)

buildScreenRoute

protected java.lang.String buildScreenRoute(Screen screen)

buildSubRoute

protected java.lang.String buildSubRoute(@Nullable
                                         java.lang.String prevSubRoute,
                                         Screen screen)

buildParams

protected java.util.Map<java.lang.String,java.lang.String> buildParams(Screen screen,
                                                                       java.util.Map<java.lang.String,java.lang.String> urlParams)

getParentPrefix

@Nullable
protected java.lang.String getParentPrefix(Screen screen)

omitParams

protected boolean omitParams(Screen screen)

isEditor

protected boolean isEditor(Screen screen)

getRoute

protected java.lang.String getRoute(Screen screen)

getRouteDef

@Nullable
protected RouteDefinition getRouteDef(@Nullable
                                                Screen screen)

getStateMark

protected java.lang.String getStateMark(Screen screen)

externalNavigation

protected boolean externalNavigation(@Nullable
                                     NavigationState currentState,
                                     NavigationState newState)

findActiveScreenByState

@Nullable
protected Screen findActiveScreenByState(NavigationState requestedState)

getOpenedScreens

protected Screens.OpenedScreens getOpenedScreens()

findScreenByState

@Nullable
protected Screen findScreenByState(java.util.Collection<Screen> screens,
                                             NavigationState requestedState)

checkConditions

protected boolean checkConditions(Screen screen,
                                  java.util.Map<java.lang.String,java.lang.String> urlParams)

notAttachedToUi

protected boolean notAttachedToUi(Screen screen)

getLastHistoryOperation

public java.lang.String getLastHistoryOperation()

Specified by:

getLastHistoryOperation in interface UrlRouting

isNotFoundScreen

protected boolean isNotFoundScreen(Screen screen)