com.webrenderer.swing

Interface IHistory

public interface IHistory

Represents the web browser history.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearHistory(int numEntries) Remove older documents from history.
int	getCount() Returns the number of documents currently available in history.
int	getIndex() Returns the index of the current document in history.
int	getMaxLength() Get the maximum number of documents that history can hold.
IHistoryPage	getPageAtIndex(int index, boolean modifyIndex) Called to obtain handle to the history page at a given index.
void	setMaxLength(int maxLength) Set the maximum number of documents that history can hold.

Method Detail

getCount

int getCount()

Returns the number of documents currently available in history.

getIndex

int getIndex()

Returns the index of the current document in history.

getMaxLength

int getMaxLength()

Get the maximum number of documents that history can hold.

setMaxLength

void setMaxLength(int maxLength)

Set the maximum number of documents that history can hold.

getPageAtIndex

IHistoryPage getPageAtIndex(int index,
                          boolean modifyIndex)

Called to obtain handle to the history page at a given index.

Parameters:

index - The index value whose entry is requested.

modifyIndex - Indicates if the current index should be modified to the passed in index.

clearHistory

void clearHistory(int numEntries)

Remove older documents from history.

Parameters:

numEntries - The number of documents to be removed from history. The oldest numEntries are removed from history.