io.jmix.ui.navigation

Class UrlTools

java.lang.Object

io.jmix.ui.navigation.UrlTools

@Component(value="ui_UrlTools")
public class UrlTools
extends java.lang.Object

Helper for working with URL.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	NESTED_ROUTE Nested screens route regexp.
protected static java.util.regex.Pattern	NESTED_ROUTE_PATTERN
protected static java.util.regex.Pattern	PARAMS_PATTERN
protected static java.lang.String	PARAMS_REGEX URL params regexp.
protected static java.lang.String	PARAMS_ROUTE Params route regexp.
protected static java.util.regex.Pattern	PARAMS_ROUTE_PATTERN
protected static java.lang.String	ROOT_ROUTE Root route regexp.
protected static java.util.regex.Pattern	ROOT_ROUTE_PATTERN

Constructor Summary

Constructors

Constructor and Description
UrlTools()

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.String>	extractParams(java.lang.String paramsString)
protected java.net.URI	getEmptyFragmentUri(com.vaadin.server.Page page)
static boolean	headless() INTERNAL
protected NavigationState	parseNestedRoute(java.lang.String uriFragment)
protected NavigationState	parseParamsRoute(java.lang.String uriFragment)
protected NavigationState	parseRootRoute(java.lang.String uriFragment)
NavigationState	parseState(java.lang.String uriFragment)
void	pushState(java.lang.String navigationState, com.vaadin.ui.UI ui)
void	replaceState(java.lang.String navigationState, com.vaadin.ui.UI ui)

Methods inherited from class java.lang.Object

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

Field Detail

ROOT_ROUTE

protected static final java.lang.String ROOT_ROUTE

Root route regexp. Intended to match first part of a fragment:

    /#<root_route>
 

See Also:

Constant Field Values

ROOT_ROUTE_PATTERN

protected static final java.util.regex.Pattern ROOT_ROUTE_PATTERN

NESTED_ROUTE

protected static final java.lang.String NESTED_ROUTE

Nested screens route regexp. Intended to match a fragment that contains root and nested screen routes

    /#<root_route>/[<url_state_mark>/]<nested_screen_route>[/<nested_screen_route>]
 

See Also:

Constant Field Values

NESTED_ROUTE_PATTERN

protected static final java.util.regex.Pattern NESTED_ROUTE_PATTERN

PARAMS_ROUTE

protected static final java.lang.String PARAMS_ROUTE

Params route regexp. Intended to match a fragment that contains root and nested screen routes and URL params part:

    /#<root_route>/[<url_state_mark>/]<nested_screen_route>?<params_part>
 

See Also:

Constant Field Values

PARAMS_ROUTE_PATTERN

protected static final java.util.regex.Pattern PARAMS_ROUTE_PATTERN

PARAMS_REGEX

protected static final java.lang.String PARAMS_REGEX

URL params regexp. Intended to match param pairs:

    p1=v2[&p2=v2]...
 

See Also:

Constant Field Values

PARAMS_PATTERN

protected static final java.util.regex.Pattern PARAMS_PATTERN

Constructor Detail

UrlTools

public UrlTools()

Method Detail

pushState

public void pushState(java.lang.String navigationState,
                      com.vaadin.ui.UI ui)

replaceState

public void replaceState(java.lang.String navigationState,
                         com.vaadin.ui.UI ui)

parseState

public NavigationState parseState(@Nullable
                                  java.lang.String uriFragment)

getEmptyFragmentUri

protected java.net.URI getEmptyFragmentUri(com.vaadin.server.Page page)

parseRootRoute

@Nullable
protected NavigationState parseRootRoute(java.lang.String uriFragment)

parseNestedRoute

@Nullable
protected NavigationState parseNestedRoute(java.lang.String uriFragment)

parseParamsRoute

@Nullable
protected NavigationState parseParamsRoute(java.lang.String uriFragment)

extractParams

protected java.util.Map<java.lang.String,java.lang.String> extractParams(java.lang.String paramsString)

headless

public static boolean headless()

INTERNAL

Returns:

whether application is running in headless mode