javax.help

Interface HelpHistoryModel

All Superinterfaces:
java.util.EventListener, HelpModelListener, Serializable
Known Implementing Classes:
DefaultHelpHistoryModel

public interface HelpHistoryModel
extends HelpModelListener, Serializable

The interface to the history model.

Method Summary

void
addHelpHistoryModelListener(HelpHistoryModelListener l)
Adds a listener for the HelpHistoryModelEvent posted after the model has changed.
void
discard()
Discards a history
Vector
getBackwardHistory()
Returns a backward history list
Vector
getForwardHistory()
Returns a forward history list
Vector
getHistory()
Returns a history
int
getIndex()
Returns a current history position
void
goBack()
Sets a previous history entry
void
goForward()
Sets a next history entry
void
removeHelpHistoryModelListener(HelpHistoryModelListener l)
Removes a listener previously added with addHelpHistoryModelListener
void
removeHelpSet(HelpSet hs)
Removes entries related to removed HelpSet from history
void
setHelpModel(HelpModel model)
Sets the HelpModel
void
setHistoryEntry(int index)
Sets the current history entry

Methods inherited from interface javax.help.event.HelpModelListener

idChanged

Method Details

addHelpHistoryModelListener

public void addHelpHistoryModelListener(HelpHistoryModelListener l)
Adds a listener for the HelpHistoryModelEvent posted after the model has changed.
Parameters:
l - The listener to add.

discard

public void discard()
Discards a history

getBackwardHistory

public Vector getBackwardHistory()
Returns a backward history list

getForwardHistory

public Vector getForwardHistory()
Returns a forward history list

getHistory

public Vector getHistory()
Returns a history

getIndex

public int getIndex()
Returns a current history position
Returns:
The history index

goBack

public void goBack()
Sets a previous history entry

goForward

public void goForward()
Sets a next history entry

removeHelpHistoryModelListener

public void removeHelpHistoryModelListener(HelpHistoryModelListener l)
Removes a listener previously added with addHelpHistoryModelListener
Parameters:
l - The listener to remove.

removeHelpSet

public void removeHelpSet(HelpSet hs)
Removes entries related to removed HelpSet from history
Parameters:
hs - The removed HelpSet

setHelpModel

public void setHelpModel(HelpModel model)
Sets the HelpModel
Parameters:
model - The HeplModel

setHistoryEntry

public void setHistoryEntry(int index)
Sets the current history entry
Parameters:
index - The index of history entry