Errai 3.0.1-SNAPSHOT

org.jboss.errai.ui.nav.client.local
Class TransitionTo<P extends com.google.gwt.user.client.ui.IsWidget>

java.lang.Object
  extended by org.jboss.errai.ui.nav.client.local.TransitionTo<P>
Type Parameters:
P - The type of the target page ("to page")

public final class TransitionTo<P extends com.google.gwt.user.client.ui.IsWidget>
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

Method Summary
 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(com.google.common.collect.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
 

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(com.google.common.collect.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.

Errai 3.0.1-SNAPSHOT

Copyright © 2013-2014 JBoss, a division of Red Hat. All Rights Reserved.