javax.help
Interface HelpModel
- TextHelpModel
- 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.
addHelpModelListener
public void addHelpModelListener(HelpModelListener l)
Adds a listener for the HelpModelEvent posted after the model has
changed.
addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener l)
Adds a listener to monitor changes to the properties in this model
getCurrentID
public Map.ID getCurrentID()
Gets the current ID.
getCurrentURL
public URL getCurrentURL()
Returns The current URL.
getHelpSet
public HelpSet getHelpSet()
Gets the loaded (aka "top") HelpSet for this model.
removeHelpModelListener
public void removeHelpModelListener(HelpModelListener l)
Removes a listener previously added with addHelpModelListener
l
- The listener to remove.
removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener l)
Removes a listener monitoring changes to the properties in this model
l
- The listener to remove.
setCurrentID
public void setCurrentID(Map.ID id)
throws InvalidHelpSetContextException
Sets the current ID relative to some HelpSet
HelpModelListeners and HelpVisitListeners are notified
setCurrentID
public void setCurrentID(Map.ID id,
String historyName,
JHelpNavigator navigator)
throws InvalidHelpSetContextException
Sets the current ID relative to some HelpSet
HelpModelListeners and HelpVisitListeners are notified
id
- the ID used to sethistoryName
- The name for history storagenavigator
- The JHelpNavigator
setCurrentURL
public void setCurrentURL(URL url)
Sets the current URL.
HelpModelListeners are notified.
The current ID changes if there is a matching id for this URL
setCurrentURL
public void setCurrentURL(URL url,
String historyName,
JHelpNavigator navigator)
Sets the current URL and the name wich will appear in history list.
HelpModelListeners are notified.
The current ID changes if there is a matching id for this URL
url
- The URL to set.historyName
- The name to set for historynavigator
- The JHelpNavigator
setHelpSet
public void setHelpSet(HelpSet hs)
Sets the loaded (aka "top") HelpSet for this model.