io.jmix.ui.navigation

Interface UrlRouting

All Known Implementing Classes:

WebUrlRouting

public interface UrlRouting

Interface defining methods for reflecting app state to URL based on currently opened screen.
Passed params map enables to reflect inner screen state to URL to use it later.
Can be used only Web client.
Usage example (this - Screen controller):

     @Inject
     private UrlRouting urlRouting;

     private void changeUrl() {
         Map<String, String> params = ParamsMap.of(
                 "param1", "value1",
                 "param2", "value2");

         urlRouting.pushState(this, params);
     }
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	UrlRouting.RouteGenerator Provides API to generate routes for screens with optional URL parameters.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLastHistoryOperation()
UrlRouting.RouteGenerator	getRouteGenerator()
NavigationState	getState()
default void	pushState(Screen screen) Pushes the state corresponding to the given screen.
void	pushState(Screen screen, java.util.Map<java.lang.String,java.lang.String> urlParams) Pushes the state corresponding to the given screen.
default void	replaceState(Screen screen) Replaces current state by 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.

Method Detail

pushState

default void pushState(Screen screen)

Pushes the state corresponding to the given screen.

Creates new entry in browser history.

Parameters:

screen - screen that is used to build new navigation state

pushState

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

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.

Parameters:

screen - screen that is used to build new navigation state

urlParams - URI params map

replaceState

default void replaceState(Screen screen)

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

Doesn't create new entry in browser history.

Parameters:

screen - screen that is used to build new navigation state

replaceState

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.

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

Doesn't create new entry in browser history.

Parameters:

screen - screen that is used to build new navigation state

urlParams - URI params map

getState

NavigationState getState()

Returns:

current state parsed from URI fragment.

getRouteGenerator

UrlRouting.RouteGenerator getRouteGenerator()

Returns:

UrlRouting.RouteGenerator instance

getLastHistoryOperation

java.lang.String getLastHistoryOperation()