Package javax.help
Class DefaultHelpHistoryModel
java.lang.Object
javax.help.DefaultHelpHistoryModel
- All Implemented Interfaces:
Serializable,EventListener,HelpModelListener,HelpHistoryModel
DefaultHelpHistoryModel is default implementation of HelpHistoryModel interface
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected JHelpprotected HelpModelprotected Vectorprotected intprotected EventListenerList -
Constructor Summary
ConstructorsConstructorDescriptionDefaultHelpHistoryModel(JHelp help) Creates new DefaultHelpHistoryModel for given JHelp -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds a listener for the HelpHistoryModelEvent posted after the model has changed.voiddiscard()Discards a historyprotected voidfireHistoryChanged(Object source, boolean previous, boolean next) Fires the history changeReturns a backward history vectorReturns a forward history vectorReturns a historyintgetIndex()Returns a current history positionprotected HelpModelgetModel()Returns HelpModelvoidgoBack()Sets the previous histroy entryvoidSets the next history entryvoidTells the listener that the current ID in the HelpModel has changed.voidRemoves a listener previously added with addHelpHistoryModelListenervoidremoveHelpSet(HelpSet hs) Removes entries related to removed HelpSet from historyvoidRemoves the last history entryvoidsetHelpModel(HelpModel model) Sets a new HelpModelvoidsetHistoryEntry(int index) Sets the current history entry
-
Field Details
-
history
-
historyIndex
protected int historyIndex -
helpModel
-
listenerList
-
help
-
-
Constructor Details
-
DefaultHelpHistoryModel
Creates new DefaultHelpHistoryModel for given JHelp- Parameters:
help- The JHelp
-
-
Method Details
-
setHelpModel
Sets a new HelpModel- Specified by:
setHelpModelin interfaceHelpHistoryModel- Parameters:
model- The new HelpModel
-
removeHelpHistoryModelListener
Removes a listener previously added with addHelpHistoryModelListener- Specified by:
removeHelpHistoryModelListenerin interfaceHelpHistoryModel- Parameters:
l- The listener to remove.- See Also:
-
addHelpHistoryModelListener
Adds a listener for the HelpHistoryModelEvent posted after the model has changed.- Specified by:
addHelpHistoryModelListenerin interfaceHelpHistoryModel- Parameters:
l- The listener to add.- See Also:
-
discard
public void discard()Discards a history- Specified by:
discardin interfaceHelpHistoryModel
-
getHistory
Returns a history- Specified by:
getHistoryin interfaceHelpHistoryModel- Returns:
- The vector of history entries
-
removeLastEntry
public void removeLastEntry()Removes the last history entry -
getIndex
public int getIndex()Returns a current history position- Specified by:
getIndexin interfaceHelpHistoryModel- Returns:
- The history index
-
goForward
public void goForward()Sets the next history entry- Specified by:
goForwardin interfaceHelpHistoryModel
-
goBack
public void goBack()Sets the previous histroy entry- Specified by:
goBackin interfaceHelpHistoryModel
-
getForwardHistory
Returns a forward history vector- Specified by:
getForwardHistoryin interfaceHelpHistoryModel- Returns:
- The vector of forward history entries
-
getBackwardHistory
Returns a backward history vector- Specified by:
getBackwardHistoryin interfaceHelpHistoryModel- Returns:
- The vector of backward history entries
-
setHistoryEntry
public void setHistoryEntry(int index) Sets the current history entry- Specified by:
setHistoryEntryin interfaceHelpHistoryModel- Parameters:
index- The index of history entry
-
fireHistoryChanged
Fires the history change -
idChanged
Tells the listener that the current ID in the HelpModel has changed. All highlights from the previous location change at this point.- Specified by:
idChangedin interfaceHelpModelListener- Parameters:
e- The event
-
removeHelpSet
Removes entries related to removed HelpSet from history- Specified by:
removeHelpSetin interfaceHelpHistoryModel- Parameters:
hs- The removed HelpSet
-
getModel
Returns HelpModel- Returns:
- The HelpModel
-