org.cruxframework.crux.core.client.screen.history

Class History

java.lang.Object

org.cruxframework.crux.core.client.screen.history.History

public class History
extends Object

Implementation of the HTML5 History API

Author:

Thiago da Rosa de Bustamante

Constructor Summary

Constructors

Constructor and Description
History()

Method Summary

Methods

Modifier and Type	Method and Description
static com.google.gwt.event.shared.HandlerRegistration	addHistoryHandler(HistoryHandler historyHandler)
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 void	go(int delta) Goes back or forward the specified number of steps in the joint session history.
static int	length() Returns the number of entries in the joint session history.
static void	pushState(com.google.gwt.core.client.JavaScriptObject data, String title) Adds a state object entry to the history.
static void	pushState(com.google.gwt.core.client.JavaScriptObject data, String title, String url) Adds a state object entry to the history.
static void	replaceState(com.google.gwt.core.client.JavaScriptObject data, String title) Updates the state object, title of the current entry in the history.
static void	replaceState(com.google.gwt.core.client.JavaScriptObject data, String title, String url) Updates the state object, title and the URL of the current entry in the history.
static <T extends com.google.gwt.core.client.JavaScriptObject> T	state() Some structured data, such as settings or content, assigned to the history item
static String	title() The name of the item in the history drop-down shown by the browser’s back and forward buttons.
static String	url() The URL to this state that should be displayed in the address bar

Methods inherited from class java.lang.Object

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

Constructor Detail

History

public History()

Method Detail

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.

go

public static void go(int delta)

Goes back or forward the specified number of steps in the joint session history. A zero delta will reload the current page. If the delta is out of range, does nothing.

Parameters:

delta - number of steps

length

public static int length()

Returns the number of entries in the joint session history.

Returns:

history length

pushState

public static void pushState(com.google.gwt.core.client.JavaScriptObject data,
             String title,
             String url)

Adds a state object entry to the history.

Parameters:

data - Some structured data, such as settings or content, assigned to the history item.

title - The name of the item in the history drop-down shown by the browser’s back and forward buttons.

url - The URL to this state that should be displayed in the address bar.

pushState

public static void pushState(com.google.gwt.core.client.JavaScriptObject data,
             String title)

Adds a state object entry to the history.

Parameters:

data - Some structured data, such as settings or content, assigned to the history item.

title - The name of the item in the history drop-down shown by the browser’s back and forward buttons.

replaceState

public static void replaceState(com.google.gwt.core.client.JavaScriptObject data,
                String title)

Updates the state object, title of the current entry in the history.

Parameters:

data - Some structured data, such as settings or content, assigned to the history item.

title - The name of the item in the history drop-down shown by the browser’s back and forward buttons.

replaceState

public static void replaceState(com.google.gwt.core.client.JavaScriptObject data,
                String title,
                String url)

Updates the state object, title and the URL of the current entry in the history.

Parameters:

data - Some structured data, such as settings or content, assigned to the history item.

title - The name of the item in the history drop-down shown by the browser’s back and forward buttons.

url - The URL to this state that should be displayed in the address bar.

state

public static <T extends com.google.gwt.core.client.JavaScriptObject> T state()

Some structured data, such as settings or content, assigned to the history item

Returns:

item state data

url

public static String url()

The URL to this state that should be displayed in the address bar

Returns:

item state url

title

public static String title()

The name of the item in the history drop-down shown by the browser’s back and forward buttons.

Returns:

item state url

addHistoryHandler

public static com.google.gwt.event.shared.HandlerRegistration addHistoryHandler(HistoryHandler historyHandler)