io.crysknife.ui.navigation.client.local.spi

Class NavigationGraph

java.lang.Object

io.crysknife.ui.navigation.client.local.spi.NavigationGraph

Direct Known Subclasses:

NavigationGraphImpl

public abstract class NavigationGraph
extends Object

The NavigationGraph is responsible for creating or retrieving instances of Page and PageTransition objects. It is also the central repository for structural information about the interpage navigation in the app (this information is defined in a decentralized way, by classes that implement PageNode and contain injected TransitionTo fields.

The concrete implementation of this class is usually generated at compile-time by scanning for page classes. It is expected to fill in the pagesByName map in its constructor.

Author:

Jonathan Fuerth

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	NavigationGraph.PageNodeCreationalCallback<W extends org.jboss.elemento.IsElement>

Field Summary

Fields

Modifier and Type	Field and Description
protected BeanManager	beanManager
protected Event<NavigationEvent>	event
protected Map<String,PageNode<?>>	pagesByName Maps page names to the classes that implement them.
protected Multimap<Class<? extends PageRole>,PageNode<?>>	pagesByRole

Constructor Summary

Constructors

Constructor and Description
NavigationGraph()

Method Summary

Modifier and Type	Method and Description
Collection<PageNode<?>>	getAllPages()
<C> PageNode<C>	getPage(Class<C> type) Returns an instance of the given page type.
<C> PageNode<C>	getPage(String name) Returns an instance of the given page type.
PageNode	getPageByRole(Class<? extends UniquePageRole> role)
Collection<PageNode<?>>	getPagesByRole(Class<? extends PageRole> role) Returns all pages that have the specified role.
boolean	isEmpty() Returns true if and only if there are no pages in this nagivation graph.

Methods inherited from class java.lang.Object

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

Field Detail

beanManager

@Inject
protected BeanManager beanManager

event

@Inject
protected Event<NavigationEvent> event

pagesByName

protected final Map<String,PageNode<?>> pagesByName

Maps page names to the classes that implement them. The subclass's constructor is responsible for populating this map.

pagesByRole

protected final Multimap<Class<? extends PageRole>,PageNode<?>> pagesByRole

Constructor Detail

NavigationGraph

public NavigationGraph()

Method Detail

getPage

public <C> PageNode<C> getPage(String name)

Returns an instance of the given page type. If the page is an ApplicationScoped bean, the singleton instance of the page will be returned; otherwise (for Dependent-scoped beans) a new instance will be returned.

Parameters:

name - The page name, as defined by the implementation of page.

Returns:

The appropriate instance of the page.

getPage

public <C> PageNode<C> getPage(Class<C> type)

Returns an instance of the given page type. If the page is an ApplicationScoped bean, the singleton instance of the page will be returned; otherwise (for Dependent-scoped beans) a new instance will be returned.

Parameters:

type - The Class object for the bean that implements the page.

Returns:

The appropriate instance of the page.

getPagesByRole

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

Returns all pages that have the specified role. In the add page annotation one can specify multiple roles for a page. getPage(Class) PageRole

Parameters:

role - the role used to lookup the pages

Returns:

all pages that have the role set.

getPageByRole

public PageNode getPageByRole(Class<? extends UniquePageRole> role)

isEmpty

public boolean isEmpty()

Returns true if and only if there are no pages in this nagivation graph.

getAllPages

public Collection<PageNode<?>> getAllPages()

Returns:

Returns a collection of all PageNodes in the navigation graph.