com.pepper.guiutils.browser
Interface WebHistory


public interface WebHistory

Interface describing WebHistory for a browser


Method Summary
 int findEntry(String url)
          Find the index of a history entry based on the passed in URL
 int getCount()
          Returns the number of history entries in the History.
 WebHistoryEntry getEntryAtIndex(int index, boolean modifyIndex)
          Called to obtain HistoryEntry at a given index.
 List getHistoryEntries()
          Get the List of HistoryEntry objects stored in the history
 int getMaxLength()
          Returns the maximum number of history entries allowed.
 int getSelectedIndex()
          Returns the selected history entry index.
 void purgeHistory(int numEntries)
          Called to purge older HistoryEntry from history.
 void setMaxLength(int length)
          Sets the maximum number of history entries allowed.
 

Method Detail

getCount

int getCount()
Returns the number of history entries in the History.


getHistoryEntries

List getHistoryEntries()
Get the List of HistoryEntry objects stored in the history

Returns:
a List value

getSelectedIndex

int getSelectedIndex()
Returns the selected history entry index.


getMaxLength

int getMaxLength()
Returns the maximum number of history entries allowed.


setMaxLength

void setMaxLength(int length)
Sets the maximum number of history entries allowed.


findEntry

int findEntry(String url)
Find the index of a history entry based on the passed in URL

Parameters:
url - a String value
Returns:
an int value

getEntryAtIndex

WebHistoryEntry getEntryAtIndex(int index,
                                boolean modifyIndex)
Called to obtain HistoryEntry at a given index.

Parameters:
index - The index value whose entry is requested.
modifyIndex - If true indicates the current index of session history should be modified to the parameter index.
Returns:
HistoryEntry at a given index.

purgeHistory

void purgeHistory(int numEntries)
Called to purge older HistoryEntry from history. HistoryEntry's can be removed from session history for various reasons. For example to control memory usage of the browser, to prevent users from loading documents from history, to erase evidence of prior page loads etc...

Parameters:
numEntries - The number of toplevel HistoryEntry's to be purged from history. During purge operation, the latest HistoryEntry's are maintained and older 'numEntries' HistoryEntry's are removed from history.


Copyright © 2006-2007 Pepper Computer, Inc. All Rights Reserved.