com.google.gwt.user.client.impl

Class HistoryImpl

java.lang.Object

com.google.gwt.user.client.impl.HistoryImpl

All Implemented Interfaces:

HasValueChangeHandlers<String>, HasHandlers

public class HistoryImpl
extends Object
implements HasValueChangeHandlers<String>

Native implementation associated with History. User classes should not use this class directly.

This base version uses the HTML5 standard window.onhashchange event to determine when the URL hash identifier changes.

Constructor Summary

Constructors

Constructor and Description
HistoryImpl()

Method Summary

Modifier and Type	Method and Description
HandlerRegistration	addValueChangeHandler(ValueChangeHandler<String> handler) Adds a ValueChangeEvent handler to be informed of changes to the browser's history stack.
protected String	decodeFragment(String encodedFragment)
void	dispose()
String	encodeFragment(String fragment)
void	fireEvent(GwtEvent<?> event) Fires the given event to the handlers listening to the event's type.
void	fireHistoryChangedImpl(String newToken) Fires the ValueChangeEvent to all handlers with the given tokens.
HandlerManager	getHandlers()
static String	getToken()
boolean	init()
protected void	nativeUpdate(String historyToken) The standard updateHash implementation assigns to location.hash() with an encoded history token.
protected void	nativeUpdateOnEvent(String historyToken)
void	newItem(String historyToken, boolean issueEvent)
void	newItemOnEvent(String historyToken)
protected static void	setToken(String token)
static void	setUpdateHashOnIE6(boolean updateHash) Deprecated. This is no longer necessary, as the underlying performance problem has been solved. It is now a no-op.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Constructor Detail

HistoryImpl

public HistoryImpl()

Method Detail

getToken

public static String getToken()

setUpdateHashOnIE6

@Deprecated
public static void setUpdateHashOnIE6(boolean updateHash)

Deprecated. This is no longer necessary, as the underlying performance problem has been solved. It is now a no-op.

Sets whether the IE6 history implementation will update the URL hash when creating a new item. This should be used only for applications with large DOM structures that are suffering from performance problems when creating a new history item on IE6 and 7.

setToken

protected static void setToken(String token)

addValueChangeHandler

public HandlerRegistration addValueChangeHandler(ValueChangeHandler<String> handler)

Adds a ValueChangeEvent handler to be informed of changes to the browser's history stack.

Specified by:

addValueChangeHandler in interface HasValueChangeHandlers<String>

Parameters:

handler - the handler

Returns:

the registration for the event

dispose

public void dispose()

encodeFragment

public String encodeFragment(String fragment)

fireEvent

public void fireEvent(GwtEvent<?> event)

Description copied from interface: HasHandlers

Fires the given event to the handlers listening to the event's type.

Any exceptions thrown by handlers will be bundled into a UmbrellaException and then re-thrown after all handlers have completed. An exception thrown by a handler will not prevent other handlers from executing.

Specified by:

fireEvent in interface HasHandlers

Parameters:

event - the event

fireHistoryChangedImpl

public void fireHistoryChangedImpl(String newToken)

Fires the ValueChangeEvent to all handlers with the given tokens.

getHandlers

public HandlerManager getHandlers()

init

public boolean init()

newItem

public final void newItem(String historyToken,
                          boolean issueEvent)

newItemOnEvent

public final void newItemOnEvent(String historyToken)

decodeFragment

protected String decodeFragment(String encodedFragment)

nativeUpdate

protected void nativeUpdate(String historyToken)

The standard updateHash implementation assigns to location.hash() with an encoded history token.

nativeUpdateOnEvent

protected void nativeUpdateOnEvent(String historyToken)