com.gargoylesoftware.htmlunit.javascript.host

Class History

java.lang.Object

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.History

All Implemented Interfaces:

Serializable, Cloneable, net.sourceforge.htmlunit.corejs.javascript.ConstProperties, net.sourceforge.htmlunit.corejs.javascript.debug.DebuggableObject, net.sourceforge.htmlunit.corejs.javascript.Scriptable, net.sourceforge.htmlunit.corejs.javascript.SymbolScriptable

public class History
extends SimpleScriptable

A JavaScript object for the client's browsing history.

Author:

Mike Bowler, Chris Erskine, Daniel Gredler, Ahmed Ashour, Ronald Brill, Adam Afeltowicz

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject.KeyComparator

Field Summary

Fields inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface net.sourceforge.htmlunit.corejs.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
History() Creates an instance.

Method Summary

Modifier and Type	Method and Description
void	back() JavaScript function "back".
void	forward() JavaScript function "forward".
int	getLength() Returns the length property.
String	getScrollRestoration() Returns the scrollRestoration property.
Object	getState() Returns the state property.
void	go(int relativeIndex) JavaScript function "go".
void	pushState(Object object, String title, String url) Pushes a state.
void	replaceState(Object object, String title, String url) Replaces a state.
void	setScrollRestoration(String scrollRestoration)

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

clone, equivalentValues, get, getBrowserVersion, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getWindow, getWindow, getWithPreemption, has, hasInstance, initParentScope, isReadOnlySettable, makeScriptableFor, setCaseSensitive, setDomNode, setDomNode, setHtmlElement

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

defineFunctionProperties, defineProperty, getClassName, put, setClassName, setParentScope

Methods inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setPrototype, size

Methods inherited from class java.lang.Object

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

Constructor Detail

History

public History()

Creates an instance.

Method Detail

getLength

public int getLength()

Returns the length property.

Returns:

the length property

getState

public Object getState()

Returns the state property.

Returns:

the state property

back

public void back()

JavaScript function "back".

forward

public void forward()

JavaScript function "forward".

go

public void go(int relativeIndex)

JavaScript function "go".

Parameters:

relativeIndex - the relative index

replaceState

public void replaceState(Object object,
                         String title,
                         String url)

Replaces a state.

Parameters:

object - the state object

title - the title

url - an optional URL

pushState

public void pushState(Object object,
                      String title,
                      String url)

Pushes a state.

Parameters:

object - the state object

title - the title

url - an optional URL

getScrollRestoration

public String getScrollRestoration()

Returns the scrollRestoration property.

Returns:

the scrollRestoration property

setScrollRestoration

public void setScrollRestoration(String scrollRestoration)

Parameters:

scrollRestoration - the new value