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 TypeMethodDescriptionvoid
Adds a listener for the HelpHistoryModelEvent posted after the model has changed.void
discard()
Discards a historyReturns a backward history listReturns a forward history listReturns a historyint
getIndex()
Returns a current history positionvoid
goBack()
Sets a previous history entryvoid
Sets a next history entryvoid
Removes a listener previously added with addHelpHistoryModelListenervoid
removeHelpSet
(HelpSet hs) Removes entries related to removed HelpSet from historyvoid
setHelpModel
(HelpModel model) Sets the HelpModelvoid
setHistoryEntry
(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
-