io.crysknife.ui.navigation.client.local

Class Navigation

java.lang.Object

io.crysknife.ui.navigation.client.local.Navigation

@ApplicationScoped
public class Navigation
extends Object

Central control point for navigating between pages of the application.

Configuration is decentralized: it is based on fields and annotations present in other application classes. This configuration is gathered at compile time.

Author:

Jonathan Fuerth

See Also:

Page, PageState, PageShowing, PageShown, PageHiding, PageHidden

Constructor Summary

Constructors

Constructor and Description
Navigation()

Method Summary

Modifier and Type	Method and Description
void	cleanUp()
static String	getAppContext() Gets the application context used in pushstate URL paths.
Multimap<String,String>	getCurrentState()
Collection<PageNode<?>>	getPagesByRole(Class<? extends PageRole> pageRole) Return all PageNode instances that have specified pageRole.
<P> void	goTo(Class<P> toPage, Multimap<String,String> state) Looks up the PageNode instance that provides content for the given widget type, sets the state on that page, then makes the widget visible in the content area.
void	goTo(String toPage) Same as goTo(Class, Multimap) but then with the page name.
void	goToWithRole(Class<? extends UniquePageRole> role) Looks up the PageNode instance of the page that has the unique role set and makes the widget visible in the content area.
boolean	isNavigating() Are we in the navigation process right now.
static void	setAppContext(String path) Sets the application context used in pushstate URL paths.
void	setContentDelegation(ContentDelegation contentDelegation)
void	setErrorHandler(PageNavigationErrorHandler handler) Set an error handler that is called in case of a PageNotFoundException error during page navigation.
void	setNavigationContainer(elemental2.dom.HTMLElement navigationContainer)
void	setNavigationContainerSelector(org.jboss.elemento.By selector)
void	updateState(Multimap<String,String> state) Update the state of your existing page without performing a full navigation.

Methods inherited from class java.lang.Object

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

Constructor Detail

Navigation

public Navigation()

Method Detail

getAppContext

public static String getAppContext()

Gets the application context used in pushstate URL paths. This application context should match the deployed application context in your web.xml

Returns:

The application context. This may return the empty string (but never null). If non-empty, the return value always starts with a slash and never ends with one.

setAppContext

public static void setAppContext(String path)

Sets the application context used in pushstate URL paths. This application context should match the deployed application context in your web.xml

Parameters:

path - The context path. Never null.

cleanUp

@PreDestroy
public void cleanUp()

goTo

public <P> void goTo(Class<P> toPage,
                     Multimap<String,String> state)

Looks up the PageNode instance that provides content for the given widget type, sets the state on that page, then makes the widget visible in the content area.

Parameters:

toPage - The content type of the page node to look up and display. Normally, this is a Widget subclass that has been annotated with @Page.

state - The state information to set on the page node before showing it. Normally the map keys correspond with the names of fields annotated with @PageState in the widget class, but this is not required.

goTo

public void goTo(String toPage)

Same as goTo(Class, Multimap) but then with the page name.

Parameters:

toPage - the name of the page node to lookup and display.

goToWithRole

public void goToWithRole(Class<? extends UniquePageRole> role)

Looks up the PageNode instance of the page that has the unique role set and makes the widget visible in the content area.

Parameters:

role - The unique role of the page that needs to be displayed.

updateState

public void updateState(Multimap<String,String> state)

Update the state of your existing page without performing a full navigation.
This will perform a pseudo navigation updating the history token with the new states.

getPagesByRole

public Collection<PageNode<?>> getPagesByRole(Class<? extends PageRole> pageRole)

Return all PageNode instances that have specified pageRole.

Parameters:

pageRole - the role to find PageNodes by

Returns:

All the pageNodes of the pages that have the specific pageRole.

getCurrentState

public Multimap<String,String> getCurrentState()

Returns:

The state multimap used to show the currently displayed page. If a navigation request has been submitted this may return the state of page being navigated to before that page has actually been displayed.

isNavigating

public boolean isNavigating()

Are we in the navigation process right now.

setErrorHandler

public void setErrorHandler(PageNavigationErrorHandler handler)

Set an error handler that is called in case of a PageNotFoundException error during page navigation.

Parameters:

handler - An error handler for navigation. Setting this to null assigns the DefaultNavigationErrorHandler

setContentDelegation

public void setContentDelegation(ContentDelegation contentDelegation)

setNavigationContainerSelector

public void setNavigationContainerSelector(org.jboss.elemento.By selector)

setNavigationContainer

public void setNavigationContainer(elemental2.dom.HTMLElement navigationContainer)