Package org.htmlunit.javascript.host

Class History

java.lang.Object
org.htmlunit.corejs.javascript.ScriptableObject
org.htmlunit.javascript.HtmlUnitScriptable
org.htmlunit.javascript.host.History
All Implemented Interfaces:
Serializable, Cloneable, org.htmlunit.corejs.javascript.ConstProperties, org.htmlunit.corejs.javascript.debug.DebuggableObject, org.htmlunit.corejs.javascript.Scriptable, org.htmlunit.corejs.javascript.SymbolScriptable
public class History extends HtmlUnitScriptable
A JavaScript object for the client's browsing history.
See Also:

  • Nested Class Summary

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

    org.htmlunit.corejs.javascript.ScriptableObject.KeyComparator

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private static final String
    SCROLL_RESTAURATION_AUTO
     
    private static final String
    SCROLL_RESTAURATION_MANUAL
     
    private String
    scrollRestoration_
     

    Fields inherited from class org.htmlunit.corejs.javascript.ScriptableObject

    CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

    Fields inherited from interface org.htmlunit.corejs.javascript.Scriptable

    NOT_FOUND

  • Constructor Summary

    Constructors
    Constructor
    Description
    History()
    Creates an instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    back()
    JavaScript function "back".
    private static URL
    buildNewStateUrl(WebWindow webWindow, Object url)
     
    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
    jsConstructor()
    JavaScript constructor.
    void
    pushState(Object object, String title, Object url)
    Pushes a state.
    void
    replaceState(Object object, String title, Object url)
    Replaces a state.
    void
    setScrollRestoration(String scrollRestoration)
     

    Methods inherited from class org.htmlunit.javascript.HtmlUnitScriptable

    clone, equivalentValues, get, getBrowserVersion, getClassName, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getWindow, getWindow, getWithPreemption, has, hasInstance, initParentScope, makeScriptableFor, put, setClassName, setDomNode, setDomNode, setParentScope, setupPromise, setupRejectedPromise

    Methods inherited from class org.htmlunit.corejs.javascript.ScriptableObject

    applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, 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, querySlot, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setCommonDescriptorProperties, setExternalArrayData, setGetterOrSetter, setPrototype, size

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • History

      public History()
      Creates an instance.

  • Method Details

    • jsConstructor

      public void jsConstructor()
      JavaScript constructor.

    • 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, Object url)
      Replaces a state.
      Parameters:
      object - the state object
      title - the title
      url - an optional URL

    • pushState

      public void pushState(Object object, String title, Object url)
      Pushes a state.
      Parameters:
      object - the state object
      title - the title
      url - an optional URL

    • buildNewStateUrl

      private static URL buildNewStateUrl(WebWindow webWindow, Object url) throws MalformedURLException
      Throws:
      MalformedURLException

    • getScrollRestoration

      public String getScrollRestoration()
      Returns the scrollRestoration property.
      Returns:
      the scrollRestoration property

    • setScrollRestoration

      public void setScrollRestoration(String scrollRestoration)
      Parameters:
      scrollRestoration - the new value