com.google.gwt.user.client
Class History

java.lang.Object
  extended bycom.google.gwt.user.client.History

public class History
extends Object

This class allows you to interact with the browser's history stack. Each "item" on the stack is represented by a single string, referred to as a "token". You can create new history items (which have a token associated with them when they are created), and you can programmatically force the current history to move back or forward.

In order to receive notification of user-directed changes to the current history item, implement the HistoryListener interface and attach it via addHistoryListener(com.google.gwt.user.client.HistoryListener).

Example: code


Field Summary
 
Fields inherited from class java.lang.Object
typeId, typeName
 
Constructor Summary
History()
           
 
Method Summary
static void addHistoryListener(HistoryListener listener)
          Adds a listener to be informed of changes to the browser's history stack.
static void back()
          Programmatic equivalent to the user pressing the browser's 'back' button.
static void forward()
          Programmatic equivalent to the user pressing the browser's 'forward' button.
static String getToken()
          Gets the current history token.
static void newItem(String historyToken)
          Adds a new browser history entry.
static void onHistoryChanged(String historyToken)
           
static void removeHistoryListener(HistoryListener listener)
          Removes a history listener.
 
Methods inherited from class java.lang.Object
equals, finalize, hashCode, toString
 

Constructor Detail

History

public History()
Method Detail

addHistoryListener

public static void addHistoryListener(HistoryListener listener)
Adds a listener to be informed of changes to the browser's history stack.

Parameters:
listener - the listener to be added

back

public static void back()
Programmatic equivalent to the user pressing the browser's 'back' button.


forward

public static void forward()
Programmatic equivalent to the user pressing the browser's 'forward' button.


getToken

public static String getToken()
Gets the current history token. The listener will not receive an onHistoryChanged() event for the initial token; requiring that an application request the token explicitly on startup gives it an opportunity to run different initialization code in the presence or absence of an initial token.

Returns:
the initial token, or the empty string if none is present.

newItem

public static void newItem(String historyToken)
Adds a new browser history entry. In hosted mode, the 'back' and 'forward' actions are accessible via the standard Alt-Left and Alt-Right keystrokes. Calling this method will cause onHistoryChanged(java.lang.String) to be called as well.


onHistoryChanged

public static void onHistoryChanged(String historyToken)

removeHistoryListener

public static void removeHistoryListener(HistoryListener listener)
Removes a history listener.

Parameters:
listener - the listener to be removed


This javadoc distribution was not produced by Google. The official documentation is here.