org.mozilla.jrex.navigation
Class History

java.lang.Object
  |
  +--org.mozilla.jrex.navigation.History

public class History
extends Object

History data wrapper class.

Version:
1.0
Author:
C.N.Medappa

Constructor Summary
History()
           
 
Method Summary
 Collection elements()
          Called to obtain a list for all the HistoryEntry's stored in session history.
 int getCount()
          Returns the number of history entries in the History.
 HistoryEntry getEntryAtIndex(int index, boolean modifyIndex)
          Called to obtain HistoryEntry at a given index.
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

History

public History()
Method Detail

getCount

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


getSelectedIndex

public int getSelectedIndex()
Returns the selected history entry index.


getMaxLength

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


setMaxLength

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


getEntryAtIndex

public HistoryEntry 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

public 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. Note:- presently this function does nothing.

elements

public Collection elements()
Called to obtain a list for all the HistoryEntry's stored in session history.



Copyright © 2004 C.N.Medappa. All Rights Reserved.