Package javax.help
Class DefaultHelpModel
java.lang.Object
javax.help.DefaultHelpModel
- All Implemented Interfaces:
Serializable
,HelpModel
,TextHelpModel
This class implements the javax.help.HelpModel API and
notifies the JHelpModel listeners when changes occur.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
A default implementation of TextHelpModel.HighlightNested classes/interfaces inherited from interface javax.help.TextHelpModel
TextHelpModel.Highlight
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected PropertyChangeSupport
protected EventListenerList
protected EventListenerList
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a listener for the HelpModelEvent posted after the model has changed.void
addHighlight
(int pos0, int pos1) Highlights a range of positions in a document.void
Adds a listener to changes to the properties in this model.void
Adds a listener for the TextHelpModelEvent posted after the model has changed.protected void
fireHighlightsChanged
(Object source) protected void
fireIDChanged
(Object source, Map.ID id, URL url) protected void
fireIDChanged
(Object source, Map.ID id, URL url, String historyName, JHelpNavigator navigator) Gets the current ID.Returns the current URLGets the document title.Gets the backing HelpSet.Geta all the highlights currently active.void
Removes highlights.void
Removes a listener previously added with addHelpListenervoid
Removes a listener to changes to the properties in this model.void
Removes a listener previously added with addHelpListenervoid
setCurrentID
(Map.ID ident) Sets the current ID.void
setCurrentID
(Map.ID ident, 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
setDocumentTitle
(String title) Assigns the document title.void
setHelpSet
(HelpSet hs) Sets the HelpSet for this HelpModel.void
Set highlights.
-
Field Details
-
listenerList
-
textListenerList
-
changes
-
-
Constructor Details
-
DefaultHelpModel
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:
-
-
Method Details
-
setHelpSet
Sets the HelpSet for this HelpModel. A null hs is valid.- Specified by:
setHelpSet
in interfaceHelpModel
-
getHelpSet
Gets the backing HelpSet.- Specified by:
getHelpSet
in interfaceHelpModel
- Returns:
- the helpset. A null hs is valid.
-
setCurrentID
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.- Specified by:
setCurrentID
in interfaceHelpModel
- 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
-
getCurrentID
Gets the current ID.- Specified by:
getCurrentID
in interfaceHelpModel
- Returns:
- the current ID. A null ID is a valid id. If no ID has been set a null ID is returned.
-
setCurrentURL
Sets the current URL. The current ID changes if there is a matching ID for this URL and HelpModelListners are notified.- Specified by:
setCurrentURL
in interfaceHelpModel
- Parameters:
url
- The url to set the model to. A null URL is a valid url.
-
getCurrentURL
Returns the current URL- Specified by:
getCurrentURL
in interfaceHelpModel
- 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.- Specified by:
addHighlight
in interfaceTextHelpModel
- Parameters:
pos0
- start positionpos1
- end position
-
removeAllHighlights
public void removeAllHighlights()Removes highlights.- Specified by:
removeAllHighlights
in interfaceTextHelpModel
-
setHighlights
Set highlights. Clear the current Hightlights and set new Highlights- Specified by:
setHighlights
in interfaceTextHelpModel
- Parameters:
h
- An array of Hightlights. If h is null it is the same as setting no highlights
-
getHighlights
Geta all the highlights currently active.- Specified by:
getHighlights
in interfaceTextHelpModel
- Returns:
- An array of highlights
-
addHelpModelListener
Adds a listener for the HelpModelEvent posted after the model has changed.- Specified by:
addHelpModelListener
in interfaceHelpModel
- Parameters:
l
- - The listener to add.- Throws:
IllegalArgumentException
- if l is null.- See Also:
-
removeHelpModelListener
Removes a listener previously added with addHelpListener- Specified by:
removeHelpModelListener
in interfaceHelpModel
- Parameters:
l
- - The listener to remove. If l is not in the list of listeners it is ignored.- Throws:
IllegalArgumentException
- if l is null.- See Also:
-
addTextHelpModelListener
Adds a listener for the TextHelpModelEvent posted after the model has changed.- Specified by:
addTextHelpModelListener
in interfaceTextHelpModel
- Parameters:
l
- - The listener to add.- Throws:
IllegalArgumentException
- if l is null.- See Also:
-
removeTextHelpModelListener
Removes a listener previously added with addHelpListener- Specified by:
removeTextHelpModelListener
in interfaceTextHelpModel
- Parameters:
l
- - The listener to remove. If l is not on the list of listeners it is ignored.- Throws:
IllegalArgumentException
- if l is null.- See Also:
-
addPropertyChangeListener
Adds a listener to changes to the properties in this model.- Specified by:
addPropertyChangeListener
in interfaceHelpModel
- Parameters:
l
- the listener to add
-
removePropertyChangeListener
Removes a listener to changes to the properties in this model.- Specified by:
removePropertyChangeListener
in interfaceHelpModel
- Parameters:
l
- the listener to remove. If l is not on the list of listeners it is ignored.
-
setDocumentTitle
Assigns the document title.- Specified by:
setDocumentTitle
in interfaceTextHelpModel
- Parameters:
title
- the Title for the document currently being shown. A null title is valid.
-
getDocumentTitle
Gets the document title.- Specified by:
getDocumentTitle
in interfaceTextHelpModel
- 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
-
fireHighlightsChanged
-