history.Html5History Extends goog.events.EventTarget
An implementation compatible with goog.History that uses the HTML5 history APIs.

Inheritance

Constructor

goog.history.Html5History(opt_winopt_transformer)

Parameters

opt_win : Window=
The window to listen/dispatch history events on.
opt_transformer : goog.history.Html5History.TokenTransformer=
The token transformer that is used to create URL from the token when storing token without using hash fragment.

Instance Methods

Public Protected Private
disposeInternal()
No description.
code »
getPathPrefix() string
Gets the path prefix.
Returns: string  The path prefix.
code »
getToken() string
Returns the current token.
Returns: string  The current token.
code »
getUrl_(token) string
Gets the URL to set when calling history.pushState
Arguments:
token : string
The history token.
Returns: string  The URL.
code »
onHistoryEvent_(e)
Handles history events dispatched by the browser.
Arguments:
e : goog.events.BrowserEvent
The browser event object.
code »
replaceToken(tokenopt_title)
Replaces the current history state without affecting the rest of the history stack.
Arguments:
token : string
The history state identifier.
opt_title : string=
Optional title to associate with history entry.
code »
setEnabled(enable)
Starts or stops the History. When enabled, the History object will immediately fire an event for the current location. The caller can set up event listeners between the call to the constructor and the call to setEnabled.
Arguments:
enable : boolean
Whether to enable history.
code »
setPathPrefix(pathPrefix)
Sets the path prefix to use if storing tokens in the path. The path prefix should start and end with slash.
Arguments:
pathPrefix : string
Sets the path prefix.
code »
setToken(tokenopt_title)
Sets the history state.
Arguments:
token : string
The history state identifier.
opt_title : string=
Optional title to associate with history entry.
code »
setUseFragment(useFragment)
Sets whether to use the fragment to store tokens.
Arguments:
useFragment : boolean
Whether to use the fragment.
code »
addEventListener(typeopt_captureopt_handlerScope)
Use #listen instead, when possible. Otherwise, use goog.events.listen if you are passing Object (instead of Function) as handler. Adds an event listener to the event target. The same handler can only be added once per the type. Even if you add the same handler multiple times using the same type then it will only be called once when the event is dispatched.
Arguments:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
opt_capture : boolean=
In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope : Object=
Object in whose scope to call the listener.
code »
assertInitialized_()
Asserts that the event target instance is initialized properly.
code »
dispatchEvent()
No description.
code »
disposeInternal()
Removes listeners from this object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners.
code »
fireListeners()
No description.
code »
getListener()
No description.
code »
getListeners()
No description.
code »
getParentEventTarget() goog.events.EventTarget
Returns the parent of this event target to use for bubbling.
Returns: goog.events.EventTarget  The parent EventTarget or null if there is no parent.
code »
hasListener()
No description.
code »
listen()
No description.
code »
listenOnce()
No description.
code »
removeAllListeners()
No description.
code »
removeEventListener(typeopt_captureopt_handlerScope)
Use #unlisten instead, when possible. Otherwise, use goog.events.unlisten if you are passing Object (instead of Function) as handler. Removes an event listener from the event target. The handler must be the same object as the one added. If the handler has not been added then nothing is done.
Arguments:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
opt_capture : boolean=
In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope : Object=
Object in whose scope to call the listener.
code »
setParentEventTarget(parent)
Sets the parent of this event target to use for capture/bubble mechanism.
Arguments:
parent : goog.events.EventTarget
Parent listenable (null if none).
code »
setTargetForTesting(target)
Sets the target to be used for event.target when firing event. Mainly used for testing. For example, see goog.testing.events.mixinListenable.
Arguments:
target : !Object
The target.
code »
unlisten()
No description.
code »
unlistenByKey()
No description.
code »
addOnDisposeCallback(callbackopt_scope)
Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.
Arguments:
callback : function(this:T):?
The callback function.
opt_scope : T=
An optional scope to call the callback in.
code »
dispose() void
Disposes of the object. If the object hasn't already been disposed of, calls #disposeInternal. Classes that extend goog.Disposable should override #disposeInternal in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.
Returns: void  Nothing.
code »
disposeInternal()
Deletes or nulls out any references to COM objects, DOM nodes, or other disposable objects. Classes that extend goog.Disposable should override this method. Not reentrant. To avoid calling it twice, it must only be called from the subclass' disposeInternal method. Everywhere else the public dispose method must be used. For example:
  mypackage.MyClass = function() {
    mypackage.MyClass.base(this, 'constructor');
    // Constructor logic specific to MyClass.
    ...
  };
  goog.inherits(mypackage.MyClass, goog.Disposable);

  mypackage.MyClass.prototype.disposeInternal = function() {
    // Dispose logic specific to MyClass.
    ...
    // Call superclass's disposeInternal at the end of the subclass's, like
    // in C++, to avoid hard-to-catch issues.
    mypackage.MyClass.base(this, 'disposeInternal');
  };
code »
getDisposed() boolean
Use #isDisposed instead. No description.
Returns: boolean  Whether the object has been disposed of.
code »
isDisposed() boolean
No description.
Returns: boolean  Whether the object has been disposed of.
code »
registerDisposable(disposable)
Associates a disposable object with this object so that they will be disposed together.
Arguments:
disposable : goog.disposable.IDisposable
that will be disposed when this object is disposed.
code »

Instance Properties

constructor :
No description.
Code »
enabled_ :
Status of when the object is active and dispatching events.
Code »
pathPrefix_ :
If useFragment is false the path will be used, the path prefix will be prepended to all tokens. Defaults to '/'.
Code »
The token transformer that is used to create URL from the token when storing token without using hash fragment.
Code »
useFragment_ :
Whether to use the fragment to store the token, defaults to true.
Code »
window_ :
The window object to use for history tokens. Typically the top window.
Code »
actualEventTarget_ : goog.events.EventTarget
The object to use for event.target. Useful when mixing in an EventTarget to another object.
Code »
constructor :
No description.
Code »
eventTargetListeners_ : goog.events.ListenerMap
Maps of event type to an array of listeners.
Code »
parentEventTarget_ : goog.events.EventTarget
Parent event target, used during event bubbling. TODO(user): Change this to goog.events.Listenable. This currently breaks people who expect getParentEventTarget to return goog.events.EventTarget.
Code »
creationStack :
If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.
Code »
disposed_ :
Whether the object has been disposed of.
Code »
onDisposeCallbacks_ :
Callbacks to invoke when this object is disposed.
Code »

Static Methods

goog.history.Html5History.isSupported(opt_win) boolean
Returns whether Html5History is supported.
Arguments:
opt_win : Window=
Optional window to check.
Returns: boolean  Whether html5 history is supported.
code »

Static Properties

goog.history.Html5History.superClass_ :
No description.
Code »

Package history

Package Reference