|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 | |
---|---|
void |
addHelpModelListener(HelpModelListener l)
Adds a listener for the HelpModelEvent posted after the model has changed. |
void |
addPropertyChangeListener(java.beans.PropertyChangeListener l)
Adds a listener to monitor changes to the properties in this model |
Map.ID |
getCurrentID()
Gets the current ID. |
java.net.URL |
getCurrentURL()
Returns The current URL. |
HelpSet |
getHelpSet()
Gets the loaded (aka "top") HelpSet for this model. |
void |
removeHelpModelListener(HelpModelListener l)
Removes a listener previously added with addHelpModelListener |
void |
removePropertyChangeListener(java.beans.PropertyChangeListener l)
Removes a listener monitoring changes to the properties in this model |
void |
setCurrentID(Map.ID id)
Sets the current ID relative to some HelpSet HelpModelListeners and HelpVisitListeners are notified |
void |
setCurrentID(Map.ID id,
java.lang.String historyName,
JHelpNavigator navigator)
Sets the current ID relative to some HelpSet HelpModelListeners and HelpVisitListeners are notified |
void |
setCurrentURL(java.net.URL url)
Sets the current URL. |
void |
setCurrentURL(java.net.URL url,
java.lang.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 Detail |
---|
void setHelpSet(HelpSet hs)
HelpSet getHelpSet()
void setCurrentID(Map.ID id) throws InvalidHelpSetContextException
id
- the ID used to set
InvalidHelpSetContextException
- The HelpSet of the ID is not
valid for the HelpSet currently loaded in the modelvoid setCurrentID(Map.ID id, java.lang.String historyName, JHelpNavigator navigator) throws InvalidHelpSetContextException
id
- the ID used to sethistoryName
- The name for history storagenavigator
- The JHelpNavigator
InvalidHelpSetContextException
- The HelpSet of the ID is not
valid for the HelpSet currently loaded in the modelMap.ID getCurrentID()
void setCurrentURL(java.net.URL url)
The
- URL to set.void setCurrentURL(java.net.URL url, java.lang.String historyName, JHelpNavigator navigator)
url
- The URL to set.historyName
- The name to set for historynavigator
- The JHelpNavigatorjava.net.URL getCurrentURL()
void addHelpModelListener(HelpModelListener l)
l
- The listener to add.removeHelpModelListener(javax.help.event.HelpModelListener)
void removeHelpModelListener(HelpModelListener l)
l
- The listener to remove.addHelpModelListener(javax.help.event.HelpModelListener)
void addPropertyChangeListener(java.beans.PropertyChangeListener l)
l
- The listener to add.void removePropertyChangeListener(java.beans.PropertyChangeListener l)
l
- The listener to remove.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |