io.jmix.ui.navigation

Class NavigationState

java.lang.Object

io.jmix.ui.navigation.NavigationState

public class NavigationState
extends java.lang.Object

Immutable object of this class represents some navigation state determined by URL fragment.

For example, if URL is:

   http://host:port/app/#main/12/orders/view?id=a9fc2d30b51ef30b7e4b5a1c2d
 

URL fragment will be:

   main/12/orders/view?id=a9fc2d30b51ef30b7e4b5a1c2d
 

Where:

    main - root screen route (in this case route of  AppMainWindow)
    12 - URL state mark
    orders/view - route of nested screen (or screens)
    id=a9fc2d30b51ef30b7e4b5a1c2d - parameter
 

See Also:

UrlRouting

Field Summary

Fields

Modifier and Type	Field and Description
static NavigationState	EMPTY
protected java.lang.String	nestedRoute
protected java.util.Map<java.lang.String,java.lang.String>	params
protected java.lang.String	root
protected java.lang.String	stateMark

Constructor Summary

Constructors

Constructor and Description
NavigationState(java.lang.String root, java.lang.String stateMark, java.lang.String nestedRoute, java.util.Map<java.lang.String,java.lang.String> params)

Method Summary

Modifier and Type	Method and Description
java.lang.String	asRoute()
boolean	equals(java.lang.Object that)
java.lang.String	getNestedRoute()
java.util.Map<java.lang.String,java.lang.String>	getParams()
java.lang.String	getParamsString()
java.lang.String	getRoot()
java.lang.String	getStateMark()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY

public static final NavigationState EMPTY

root

protected final java.lang.String root

stateMark

protected final java.lang.String stateMark

nestedRoute

protected final java.lang.String nestedRoute

params

protected final java.util.Map<java.lang.String,java.lang.String> params

Constructor Detail

NavigationState

public NavigationState(java.lang.String root,
                       java.lang.String stateMark,
                       java.lang.String nestedRoute,
                       @Nullable
                       java.util.Map<java.lang.String,java.lang.String> params)

Method Detail

getRoot

public java.lang.String getRoot()

getStateMark

public java.lang.String getStateMark()

getNestedRoute

public java.lang.String getNestedRoute()

getParams

@Nullable
public java.util.Map<java.lang.String,java.lang.String> getParams()

getParamsString

public java.lang.String getParamsString()

Returns:

joined by "&" sign URL params, or empty string if no params for this state

asRoute

public java.lang.String asRoute()

Returns:

current state combined into URL fragment, e.g. main/0/orders?status=shipped

equals

public boolean equals(java.lang.Object that)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object