io.crysknife.ui.navigation.client.local

Class TransitionTo<P>

java.lang.Object

io.crysknife.ui.navigation.client.local.TransitionTo<P>

Type Parameters:

P - The type of the target page ("to page")

public final class TransitionTo<P>
extends Object

Represents navigability from one page to another in the application's flow. Thinking of the application flow as a directed graph, PageNodes are the nodes and PageTransitions are the edges.

Instances of this class are normally obtained via dependency injection.

Instances of this class are immutable.

Author:

Jonathan Fuerth

Constructor Summary

Constructors

Constructor and Description
TransitionTo(Class<P> toPage, Navigation navigation) Creates a new PageTransition with the given attributes.

Method Summary

Modifier and Type	Method and Description
void	go() Transitions the application's view from the current page (whatever it is) to the toPage of this transition, passing no extra state information.
void	go(Multimap<String,String> state) Transitions the application's view from the current page (whatever it is) to the toPage of this transition, passing the given extra state information.
Class<P>	toPageType() The page this transition goes to.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransitionTo

public TransitionTo(Class<P> toPage,
                    Navigation navigation)

Creates a new PageTransition with the given attributes.

Parameters:

navigation - The navigation system this page transition participates in.

toPage - The page type this transition goes to. Not null.

Throws:

NullPointerException - if any of the arguments are null.

Method Detail

toPageType

public Class<P> toPageType()

The page this transition goes to.

go

public void go()

Transitions the application's view from the current page (whatever it is) to the toPage of this transition, passing no extra state information.

Note: if the Navigation framework is being used together with ErraiIOC in asynchronous mode, the page transition may not have happened by the time this method returns.

go

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

Transitions the application's view from the current page (whatever it is) to the toPage of this transition, passing the given extra state information.

Note: if the Navigation framework is being used together with ErraiIOC in asynchronous mode, the page transition may not have happened by the time this method returns.

Parameters:

state - Extra state information that should be passed to the page before it is displayed. Must not be null.