qx.client
Class History

java.lang.Object
  qx.core.Object
      qx.core.Target
          qx.client.History

public class History
extends Target

A helper for using the browser history in JavaScript Applications without reloading the main page.

Adds entries to the browser history and fires a “request” event when one of the entries was requested by the user (e.g. by clicking on the back button).

Browser history support is currently available for Internet Explorer 6/7, Firefox, Opera 9 and WebKit. Safari 2 and older are not yet supported.

This module is based on the ideas behind the YUI Browser History Manager by Julien Lecomte (Yahoo), which is described at http://yuiblog.com/blog/2007/02/21/browser-history-manager/. The Yahoo implementation can be found at http://developer.yahoo.com/yui/history. The original code is licensed under a BSD license (http://developer.yahoo.com/yui/license.txt).

Constructor Summary

History()

Method Summary

void	_applyTimeoutInterval(java.lang.Object value) Apply the interval of the timer.
void	addToHistory(java.lang.String state, java.lang.String newTitle) Adds an entry to the browser history.
java.lang.String	getState() Get the current state of the browser history.
int	getTimeoutInterval() Returns the (computed) value of the property timeoutInterval.
void	init() This function is only there to ensure compatibility with older qooxdoo versions
void	initTimeoutInterval(int arg) Calls the apply method and dispatches the change event of the property timeoutInterval with the default value defined by the class developer.
void	navigateBack() Navigates back in the browser history.
void	navigateForward() Navigates forward in the browser history.
void	resetTimeoutInterval() Resets the user value of the property timeoutInterval.
void	setTimeoutInterval(int arg) Sets the user value of the property timeoutInterval.

Methods inherited from class qx.core.Target

_dispatchEvent, addChangeSelectionListener, addChangeValueListener, addEventListener, addExecuteListener, addJavaEventListener, createDispatchChangeEvent, createDispatchDataEvent, createDispatchEvent, dispatchEvent, hasEventListeners, removeEventListener

Methods inherited from class qx.core.Object

_disposeFields, _disposeObjectDeep, _disposeObjects, base, dispose, get, getDisposed, isDisposed, reset, self, set, toHashCode, toString_

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

_applyTimeoutInterval

public void _applyTimeoutInterval(java.lang.Object value)

Apply the interval of the timer.

addToHistory

public void addToHistory(java.lang.String state,
                         java.lang.String newTitle)

Adds an entry to the browser history.

getState

public java.lang.String getState()

Get the current state of the browser history.

getTimeoutInterval

public int getTimeoutInterval()

Returns the (computed) value of the property timeoutInterval.

For further details take a look at the property definition: timeoutInterval.

init

public void init()

This function is only there to ensure compatibility with older qooxdoo versions

initTimeoutInterval

public void initTimeoutInterval(int arg)

Calls the apply method and dispatches the change event of the property timeoutInterval with the default value defined by the class developer. This function can only be called from the constructor of a class.

For further details take a look at the property definition: timeoutInterval.

navigateBack

public void navigateBack()

Navigates back in the browser history. Simulates a back button click.

navigateForward

public void navigateForward()

Navigates forward in the browser history. Simulates a forward button click.

resetTimeoutInterval

public void resetTimeoutInterval()

Resets the user value of the property timeoutInterval.

The computed value falls back to the next available value e.g. appearance, init or inheritance value depeneding on the property configuration and value availability.

For further details take a look at the property definition: timeoutInterval.

setTimeoutInterval

public void setTimeoutInterval(int arg)

Sets the user value of the property timeoutInterval.

For further details take a look at the property definition: timeoutInterval.