org.xwalk.core

Class XWalkNavigationHistory

java.lang.Object

XWalkNavigationHistoryInternal

org.xwalk.core.XWalkNavigationHistory

public final class XWalkNavigationHistory
extends XWalkNavigationHistoryInternal

This class represents a navigation history for a XWalkView instance. It's not thread-safe and should be only called on UI thread.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XWalkNavigationHistory.Direction The direction for web page navigation.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canGoBack() Test whether XWalkView can go back.
boolean	canGoForward() Test whether XWalkView can go forward.
void	clear() Clear all history owned by this XWalkView.
int	getCurrentIndex() Get the index for current navigation item.
XWalkNavigationItem	getCurrentItem() Get the current item which XWalkView displays.
XWalkNavigationItem	getItemAt(int index) Get a specific item given by index.
boolean	hasItemAt(int index) Test whether there is an item at a specific index.
void	navigate(XWalkNavigationHistory.Direction direction, int steps) Navigates to the specified step from the current navigation item.
int	size() Total size of navigation history for the XWalkView.

Methods inherited from class java.lang.Object

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

Method Detail

size

public int size()

Total size of navigation history for the XWalkView.

Returns:

the size of total navigation items.

Since:

1.0

hasItemAt

public boolean hasItemAt(int index)

Test whether there is an item at a specific index.

Parameters:

index - the given index.

Returns:

true if there is an item at the specific index.

Since:

1.0

getItemAt

public XWalkNavigationItem getItemAt(int index)

Get a specific item given by index.

Parameters:

index - the given index.

Returns:

the navigation item for the given index.

Since:

1.0

getCurrentItem

public XWalkNavigationItem getCurrentItem()

Get the current item which XWalkView displays.

Returns:

the current navigation item.

Since:

1.0

canGoBack

public boolean canGoBack()

Test whether XWalkView can go back.

Returns:

true if it can go back.

Since:

1.0

canGoForward

public boolean canGoForward()

Test whether XWalkView can go forward.

Returns:

true if it can go forward.

Since:

1.0

navigate

public void navigate(XWalkNavigationHistory.Direction direction,
            int steps)

Navigates to the specified step from the current navigation item. Do nothing if the offset is out of bound.

Parameters:

direction - the direction of navigation.

steps - go back or foward with a given steps.

Since:

1.0

getCurrentIndex

public int getCurrentIndex()

Get the index for current navigation item.

Returns:

current index in the navigation history.

Since:

1.0

clear

public void clear()

Clear all history owned by this XWalkView.

Since:

1.0