Package javax.help
Interface HelpHistoryModel
-
- All Superinterfaces:
java.util.EventListener
,HelpModelListener
,java.io.Serializable
- All Known Implementing Classes:
DefaultHelpHistoryModel
public interface HelpHistoryModel extends HelpModelListener, java.io.Serializable
The interface to the history model.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addHelpHistoryModelListener(HelpHistoryModelListener l)
Adds a listener for the HelpHistoryModelEvent posted after the model has changed.void
discard()
Discards a historyjava.util.Vector
getBackwardHistory()
Returns a backward history listjava.util.Vector
getForwardHistory()
Returns a forward history listjava.util.Vector
getHistory()
Returns a historyint
getIndex()
Returns a current history positionvoid
goBack()
Sets a previous history entryvoid
goForward()
Sets a next history entryvoid
removeHelpHistoryModelListener(HelpHistoryModelListener l)
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 entry-
Methods inherited from interface javax.help.event.HelpModelListener
idChanged
-
-
-
-
Method Detail
-
addHelpHistoryModelListener
void addHelpHistoryModelListener(HelpHistoryModelListener l)
Adds a listener for the HelpHistoryModelEvent posted after the model has changed.- Parameters:
l
- The listener to add.- See Also:
removeHelpHistoryModelListener(javax.help.event.HelpHistoryModelListener)
-
removeHelpHistoryModelListener
void removeHelpHistoryModelListener(HelpHistoryModelListener l)
Removes a listener previously added with addHelpHistoryModelListener- Parameters:
l
- The listener to remove.- See Also:
addHelpHistoryModelListener(javax.help.event.HelpHistoryModelListener)
-
discard
void discard()
Discards a history
-
goForward
void goForward()
Sets a next history entry
-
goBack
void goBack()
Sets a previous history entry
-
getBackwardHistory
java.util.Vector getBackwardHistory()
Returns a backward history list
-
getForwardHistory
java.util.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
void removeHelpSet(HelpSet hs)
Removes entries related to removed HelpSet from history- Parameters:
hs
- The removed HelpSet
-
getHistory
java.util.Vector getHistory()
Returns a history
-
getIndex
int getIndex()
Returns a current history position- Returns:
- The history index
-
setHelpModel
void setHelpModel(HelpModel model)
Sets the HelpModel- Parameters:
model
- The HeplModel
-
-