akasha

Class History

java.lang.Object

akasha.core.JsObject

akasha.History

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="History")
public class History
extends JsObject

The History interface allows manipulation of the browser session history, that is the pages visited in the tab or frame that the current page is loaded in.

See Also:

History - MDN, (HTML) # the-history-interface

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	scrollRestoration The scrollRestoration property of History interface allows web applications to explicitly set default scroll restoration behavior on history navigation.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	History()

Method Summary

Modifier and Type	Method and Description
void	back() The History.back() method causes the browser to move back one page in the session history.
void	forward() The History.forward() method causes the browser to move forward one page in the session history.
void	go() The History.go() method loads a specific page from the session history.
void	go(int delta) The History.go() method loads a specific page from the session history.
int	length() The History.length read-only property returns an integer representing the number of elements in the session history, including the currently loaded page.
void	pushState(java.lang.Object data, java.lang.String unused) In an HTML document, the history.pushState() method adds an entry to the browser's session history stack.
void	pushState(java.lang.Object data, java.lang.String unused, java.lang.String url) In an HTML document, the history.pushState() method adds an entry to the browser's session history stack.
void	replaceState(java.lang.Object data, java.lang.String unused) The History.replaceState() method modifies the current history entry, replacing it with the stateObj, title, and URL passed in the method parameters.
void	replaceState(java.lang.Object data, java.lang.String unused, java.lang.String url) The History.replaceState() method modifies the current history entry, replacing it with the stateObj, title, and URL passed in the method parameters.
jsinterop.base.Any	state() The History.state property returns a value representing the state at the top of the history stack.

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

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

Field Detail

scrollRestoration

@Nonnull
 @ScrollRestoration
public java.lang.String scrollRestoration

The scrollRestoration property of History interface allows web applications to explicitly set default scroll restoration behavior on history navigation.

See Also:

History.scrollRestoration - MDN, scroll restoration mode - HTML Living Standard, History.scrollRestoration - HTML5

Constructor Detail

History

protected History()

Method Detail

length

@JsProperty(name="length")
public int length()

The History.length read-only property returns an integer representing the number of elements in the session history, including the currently loaded page.

See Also:

History.length - MDN, History.length - HTML Living Standard, History.length - HTML5

state

@JsProperty(name="state")
 @Nullable
public jsinterop.base.Any state()

The History.state property returns a value representing the state at the top of the history stack.

See Also:

History.state - MDN

back

public void back()

The History.back() method causes the browser to move back one page in the session history.

See Also:

History.back - MDN, History.back() - HTML Living Standard, History.back() - HTML5

forward

public void forward()

The History.forward() method causes the browser to move forward one page in the session history. It has the same effect as calling history.go(1).

See Also:

History.forward - MDN, History - HTML Living Standard, History - HTML5

go

public void go(int delta)

The History.go() method loads a specific page from the session history. You can use it to move forwards and backwards through the history depending on the value of a parameter.

See Also:

History.go - MDN, History.go() - HTML Living Standard, History.go() - HTML5

go

public void go()

The History.go() method loads a specific page from the session history. You can use it to move forwards and backwards through the history depending on the value of a parameter.

See Also:

History.go - MDN, History.go() - HTML Living Standard, History.go() - HTML5

pushState

public void pushState(@Nullable
                      java.lang.Object data,
                      @Nonnull
                      java.lang.String unused,
                      @Nullable
                      java.lang.String url)

In an HTML document, the history.pushState() method adds an entry to the browser's session history stack.

See Also:

History.pushState - MDN, History.pushState() - HTML Living Standard, History.pushState() - HTML5

pushState

public void pushState(@Nullable
                      java.lang.Object data,
                      @Nonnull
                      java.lang.String unused)

In an HTML document, the history.pushState() method adds an entry to the browser's session history stack.

See Also:

History.pushState - MDN, History.pushState() - HTML Living Standard, History.pushState() - HTML5

replaceState

public void replaceState(@Nullable
                         java.lang.Object data,
                         @Nonnull
                         java.lang.String unused,
                         @Nullable
                         java.lang.String url)

The History.replaceState() method modifies the current history entry, replacing it with the stateObj, title, and URL passed in the method parameters. This method is particularly useful when you want to update the state object or URL of the current history entry in response to some user action.

See Also:

History.replaceState - MDN, History.replaceState() - HTML Living Standard, History.replaceState() - HTML5

replaceState

public void replaceState(@Nullable
                         java.lang.Object data,
                         @Nonnull
                         java.lang.String unused)

The History.replaceState() method modifies the current history entry, replacing it with the stateObj, title, and URL passed in the method parameters. This method is particularly useful when you want to update the state object or URL of the current history entry in response to some user action.

See Also:

History.replaceState - MDN, History.replaceState() - HTML Living Standard, History.replaceState() - HTML5