Package javax.help
Interface HelpModel
- All Known Subinterfaces:
TextHelpModel
- All Known Implementing Classes:
DefaultHelpModel
public interface HelpModel
The interface to the model of a JHelp that represents the
HelpSet being presented to the user.
Note that a HelpSet can contain nested HelpSets within it; IDs
include both a String and the HelpSet to which the String applies.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a listener for the HelpModelEvent posted after the model has changed.void
Adds a listener to monitor changes to the properties in this modelGets the current ID.Returns The current URL.Gets the loaded (aka "top") HelpSet for this model.void
Removes a listener previously added with addHelpModelListenervoid
Removes a listener monitoring changes to the properties in this modelvoid
setCurrentID
(Map.ID id) Sets the current ID relative to some HelpSet HelpModelListeners and HelpVisitListeners are notifiedvoid
setCurrentID
(Map.ID id, String historyName, JHelpNavigator navigator) Sets the current ID relative to some HelpSet HelpModelListeners and HelpVisitListeners are notifiedvoid
setCurrentURL
(URL url) Sets the current URL.void
setCurrentURL
(URL url, String historyName, JHelpNavigator navigator) Sets the current URL and the name wich will appear in history list.void
setHelpSet
(HelpSet hs) Sets the loaded (aka "top") HelpSet for this model.
-
Method Details
-
setHelpSet
Sets the loaded (aka "top") HelpSet for this model. -
getHelpSet
HelpSet getHelpSet()Gets the loaded (aka "top") HelpSet for this model. -
setCurrentID
Sets the current ID relative to some HelpSet HelpModelListeners and HelpVisitListeners are notified- Parameters:
id
- the ID used to set- Throws:
InvalidHelpSetContextException
- The HelpSet of the ID is not valid for the HelpSet currently loaded in the model
-
getCurrentID
Map.ID getCurrentID()Gets the current ID.- Returns:
- The current ID.
-
setCurrentURL
Sets the current URL. HelpModelListeners are notified. The current ID changes if there is a matching id for this URL- Parameters:
The
- URL to set.
-
getCurrentURL
URL getCurrentURL()Returns The current URL.- Returns:
- The current URL.
-
addHelpModelListener
Adds a listener for the HelpModelEvent posted after the model has changed.- Parameters:
l
- The listener to add.- See Also:
-
removeHelpModelListener
Removes a listener previously added with addHelpModelListener- Parameters:
l
- The listener to remove.- See Also:
-
addPropertyChangeListener
Adds a listener to monitor changes to the properties in this model- Parameters:
l
- The listener to add.
-
removePropertyChangeListener
Removes a listener monitoring changes to the properties in this model- Parameters:
l
- The listener to remove.
-