Class javax.help.DefaultHelpModel

java.lang.Object
    |
    +----javax.help.DefaultHelpModel

public class DefaultHelpModel
extends java.lang.Object
implements TextHelpModel, java.io.Serializable
This class implements the javax.help.HelpModel API and notifies the JHelpModel listeners when changes occur.


listenerList

protected EventListenerList listenerList

textListenerList

protected EventListenerList textListenerList

changes

protected java.beans.PropertyChangeSupport changes

DefaultHelpModel

public DefaultHelpModel(HelpSet hs)
Constructs a HelpModel from a HelpSet
Parameters:
hs - The HelpSet from which to build this model. A null hs is valid creating a DefaultHelpModel without a HelpSet.
See Also:
HelpSet

setHelpSet

public void setHelpSet(HelpSet hs)
Sets the HelpSet for this HelpModel. A null hs is valid.

getHelpSet

public HelpSet getHelpSet()
Gets the backing HelpSet.
Returns:
the helpset. A null hs is valid.

setCurrentID

public void setCurrentID(Map.ID ident) throws InvalidHelpSetContextException
Sets the current ID. HelpModelListeners and HelpVisitListeners are notified. If the parameter ident is null, the homeID of the current HelpSet is used unless it is also null in which case the method returns without setting the currentID.
Parameters:
ident - The ID to set. If ident is null set the currentID to the HelpSet's HomeID. If the HomeID doesn't exist the currentID is set to null.
Throws:
InvalidHelpSetContextException - The ID is not valid for the HelpSet

setCurrentID

public void setCurrentID(Map.ID ident,
                         java.lang.String historyName,
                         JHelpNavigator navigator) throws InvalidHelpSetContextException
Sets the current ID relative to some HelpSet HelpModelListeners and HelpVisitListeners are notified
Parameters:
id - the ID used to set
historyName - the name for history storage
navigator - the name of the navigator for history
Throws:
InvalidHelpSetContextException - The HelpSet of the ID is not valid for the HelpSet currently loaded in the model

getCurrentID

public Map.ID getCurrentID()
Gets the current ID.
Returns:
the current ID. A null ID is a valid id. If no ID has been set a null ID is returned.

setCurrentURL

public void setCurrentURL(java.net.URL url)
Sets the current URL. The current ID changes if there is a matching ID for this URL and HelpModelListners are notified.
Parameters:
url - The url to set the model to. A null URL is a valid url.

setCurrentURL

public 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. HelpModelListeners are notified. The current ID changes if there is a matching id for this URL
Parameters:
url - The URL to set.
historyName - The name to set for history
navigator - The name of the navigator for history

getCurrentURL

public java.net.URL getCurrentURL()
Returns the current URL
Returns:
The current URL. A null URL is a valid URL. If no URL has been previously set a null URL will be returned.

addHighlight

public void addHighlight(int pos0,
                         int pos1)
Highlights a range of positions in a document.
Implements:
addHighlight in interface TextHelpModel
Parameters:
pos0 - start position
pos1 - end position

removeAllHighlights

public void removeAllHighlights()
Removes highlights.
Implements:
removeAllHighlights in interface TextHelpModel

setHighlights

public void setHighlights(TextHelpModel.Highlight[] h)
Set highlights. Clear the current Hightlights and set new Highlights
Implements:
setHighlights in interface TextHelpModel
Parameters:
h - An array of Hightlights. If h is null it is the same as setting no highlights

getHighlights

public TextHelpModel.Highlight[] getHighlights()
Geta all the highlights currently active.
Implements:
getHighlights in interface TextHelpModel
Returns:
An array of highlights

addHelpModelListener

public void addHelpModelListener(HelpModelListener l)
Adds a listener for the HelpModelEvent posted after the model has changed.
Parameters:
l - - The listener to add.
Throws:
java.lang.IllegalArgumentException - if l is null.
See Also:
removeHelpModelListener

removeHelpModelListener

public void removeHelpModelListener(HelpModelListener l)
Removes a listener previously added with addHelpListener
Parameters:
l - - The listener to remove. If l is not in the list of listeners it is ignored.
Throws:
java.lang.IllegalArgumentException - if l is null.
See Also:
addHelpModelListener

addTextHelpModelListener

public void addTextHelpModelListener(TextHelpModelListener l)
Adds a listener for the TextHelpModelEvent posted after the model has changed.
Implements:
addTextHelpModelListener in interface TextHelpModel
Parameters:
l - - The listener to add.
Throws:
java.lang.IllegalArgumentException - if l is null.
See Also:
removeHelpModelListener

removeTextHelpModelListener

public void removeTextHelpModelListener(TextHelpModelListener l)
Removes a listener previously added with addHelpListener
Implements:
removeTextHelpModelListener in interface TextHelpModel
Parameters:
l - - The listener to remove. If l is not on the list of listeners it is ignored.
Throws:
java.lang.IllegalArgumentException - if l is null.
See Also:
addHelpModelListener

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener l)
Adds a listener to changes to the properties in this model.
Parameters:
l - the listener to add

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener l)
Removes a listener to changes to the properties in this model.
Parameters:
l - the listener to remove. If l is not on the list of listeners it is ignored.

setDocumentTitle

public void setDocumentTitle(java.lang.String title)
Assigns the document title.
Implements:
setDocumentTitle in interface TextHelpModel
Parameters:
title - the Title for the document currently being shown. A null title is valid.

getDocumentTitle

public java.lang.String getDocumentTitle()
Gets the document title.
Implements:
getDocumentTitle in interface TextHelpModel
Returns:
The title for the current document. A null title is valid. If the title has not be previously set it will be null.

fireIDChanged

protected void fireIDChanged(java.lang.Object source,
                             Map.ID id,
                             java.net.URL url,
                             java.lang.String historyName,
                             JHelpNavigator navigator)

fireIDChanged

protected void fireIDChanged(java.lang.Object source,
                             Map.ID id,
                             java.net.URL url)

fireHighlightsChanged

protected void fireHighlightsChanged(java.lang.Object source)