Package javax.help
Interface HelpHistoryModel
- All Superinterfaces:
EventListener,HelpModelListener,Serializable
- All Known Implementing Classes:
DefaultHelpHistoryModel
The interface to the history model.
-
Method Summary
Modifier and TypeMethodDescriptionvoidAdds a listener for the HelpHistoryModelEvent posted after the model has changed.voiddiscard()Discards a historyReturns a backward history listReturns a forward history listReturns a historyintgetIndex()Returns a current history positionvoidgoBack()Sets a previous history entryvoidSets a next history entryvoidRemoves a listener previously added with addHelpHistoryModelListenervoidremoveHelpSet(HelpSet hs) Removes entries related to removed HelpSet from historyvoidsetHelpModel(HelpModel model) Sets the HelpModelvoidsetHistoryEntry(int index) Sets the current history entryMethods inherited from interface javax.help.event.HelpModelListener
idChanged
-
Method Details
-
addHelpHistoryModelListener
Adds a listener for the HelpHistoryModelEvent posted after the model has changed.- Parameters:
l- The listener to add.- See Also:
-
removeHelpHistoryModelListener
Removes a listener previously added with addHelpHistoryModelListener- Parameters:
l- The listener to remove.- See Also:
-
discard
void discard()Discards a history -
goForward
void goForward()Sets a next history entry -
goBack
void goBack()Sets a previous history entry -
getBackwardHistory
Vector getBackwardHistory()Returns a backward history list -
getForwardHistory
Vector getForwardHistory()Returns a forward history list -
setHistoryEntry
void setHistoryEntry(int index) Sets the current history entry- Parameters:
index- The index of history entry
-
removeHelpSet
Removes entries related to removed HelpSet from history- Parameters:
hs- The removed HelpSet
-
getHistory
Vector getHistory()Returns a history -
getIndex
int getIndex()Returns a current history position- Returns:
- The history index
-
setHelpModel
Sets the HelpModel- Parameters:
model- The HeplModel
-