io.jmix.ui.navigation

Class WebHistory

java.lang.Object

io.jmix.ui.navigation.WebHistory

All Implemented Interfaces:

History

@UIScope
 @Component(value="ui_History")
public class WebHistory
extends java.lang.Object
implements History

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<NavigationState>	history
protected int	now
protected AppUI	ui
protected UiProperties	uiProperties

Constructor Summary

Constructors

Constructor and Description
WebHistory()

Method Summary

Modifier and Type	Method and Description
NavigationState	backward() Performs "Back" transition through history.
protected boolean	checkNotNativeUrlHandlingMode()
protected void	dropFutureEntries()
void	forward(NavigationState navigationState) Adds new history entry.
NavigationState	getNext()
NavigationState	getNow()
NavigationState	getPrevious()
boolean	has(NavigationState navigationState) Checks whether history has the given entry.
boolean	replace(NavigationState navigationState) Replaces current state by the new one.
boolean	searchBackward(NavigationState navigationState) Performs search for the given history entry in the past.
boolean	searchForward(NavigationState navigationState) Performs search for the given history entry in the future.
void	setAppUi(AppUI ui)

Methods inherited from class java.lang.Object

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

Field Detail

uiProperties

@Autowired
protected UiProperties uiProperties

ui

protected AppUI ui

now

protected int now

history

protected java.util.List<NavigationState> history

Constructor Detail

WebHistory

public WebHistory()

Method Detail

setAppUi

@Autowired
public void setAppUi(AppUI ui)

forward

public void forward(NavigationState navigationState)

Description copied from interface: History

Adds new history entry. Flushes all entries coming after current entry.

Specified by:

forward in interface History

Parameters:

navigationState - new history entry

backward

public NavigationState backward()

Description copied from interface: History

Performs "Back" transition through history.

Specified by:

backward in interface History

Returns:

previous history entry

getNow

@Nullable
public NavigationState getNow()

Specified by:

getNow in interface History

Returns:

current history entry

getPrevious

@Nullable
public NavigationState getPrevious()

Specified by:

getPrevious in interface History

Returns:

previous history entry

getNext

@Nullable
public NavigationState getNext()

Specified by:

getNext in interface History

Returns:

next history entry

searchBackward

public boolean searchBackward(NavigationState navigationState)

Description copied from interface: History

Performs search for the given history entry in the past.

Specified by:

searchBackward in interface History

Parameters:

navigationState - history entry

Returns:

true if entry is found, false otherwise

searchForward

public boolean searchForward(NavigationState navigationState)

Description copied from interface: History

Performs search for the given history entry in the future.

Specified by:

searchForward in interface History

Parameters:

navigationState - history entry

Returns:

true if entry is found, false otherwise

has

public boolean has(NavigationState navigationState)

Description copied from interface: History

Checks whether history has the given entry.

Specified by:

has in interface History

Parameters:

navigationState - history entry

Returns:

true if history has an entry, false otherwise

replace

public boolean replace(NavigationState navigationState)

Description copied from interface: History

Replaces current state by the new one.

This operation is allowed when only params are changed.

Specified by:

replace in interface History

Parameters:

navigationState - new state

Returns:

true if old state is replaced, false otherwise

dropFutureEntries

protected void dropFutureEntries()

checkNotNativeUrlHandlingMode

protected boolean checkNotNativeUrlHandlingMode()