## com.gargoylesoftware.htmlunit
Class History

    java.lang.Object
      com.gargoylesoftware.htmlunit.History

All Implemented Interfaces:
  java.io.Serializable

    public class History

extends java.lang.Object
implements java.io.Serializable

Representation of the navigation history of a single window.

Version:
  $Revision: 4877 $
Author:
  Daniel Gredler
See Also:
  Serialized Form

Constructor Summary
`History(WebWindow window)` Creates a new navigation history for the specified window.

Method Summary
`protected void` `addPage(Page page)` Adds a new page to the navigation history.
`History` `back()` Goes back one step in the navigation history, if possible.
`History` `forward()` Goes forward one step in the navigation history, if possible.
`int` `getIndex()` Returns the current (zero-based) index within the navigation history.
`int` `getLength()` Returns the length of the navigation history.
`java.net.URL` `getUrl(int index)` Returns the URL at the specified index in the navigation history, or `null` if the index is not valid.
`History` `go(int relativeIndex)` Goes forward or backwards in the navigation history, according to whether the specified relative index is positive or negative.
`java.lang.String` `toString()`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### History

    public History(WebWindow window)

  Creates a new navigation history for the specified window.

  Parameters:
    `window` - the window which owns the new navigation history

Method Detail

### getLength

    public int getLength()

  Returns the length of the navigation history.

  Returns:
    the length of the navigation history

### getIndex

    public int getIndex()

  Returns the current (zero-based) index within the navigation history.

  Returns:
    the current (zero-based) index within the navigation history

### getUrl

    public java.net.URL getUrl(int index)

  Returns the URL at the specified index in the navigation history, or `null` if the index is not valid.

  Parameters:
    `index` - the index of the URL to be returned
  Returns:
    the URL at the specified index in the navigation history, or `null` if the index is not valid

### back

    public History back()
                 throws java.io.IOException

  Goes back one step in the navigation history, if possible.

  Returns:
    this navigation history, after going back one step
  Throws:
    `java.io.IOException` - if an IO error occurs

### forward

    public History forward()
                    throws java.io.IOException

  Goes forward one step in the navigation history, if possible.

  Returns:
    this navigation history, after going forward one step
  Throws:
    `java.io.IOException` - if an IO error occurs

### go

    public History go(int relativeIndex)
               throws java.io.IOException

  Goes forward or backwards in the navigation history, according to whether the specified relative index is positive or negative. If the specified index is `0`, this method reloads the current page.

  Parameters:
    `relativeIndex` - the index to move to, relative to the current index
  Returns:
    this navigation history, after going forwards or backwards the specified number of steps
  Throws:
    `java.io.IOException` - if an IO error occurs

### toString

    public java.lang.String toString()

  Overrides:
    `toString` in class `java.lang.Object`

### addPage

    protected void addPage(Page page)

  Adds a new page to the navigation history.

  Parameters:
    `page` - the page to add to the navigation history

Copyright © 2002-2011 Gargoyle Software Inc.. All Rights Reserved.