A component to represent the Help viewer that can be embedded if desired.
addHelpModelListener
public void addHelpModelListener(HelpModelListener l)
Adds a listener for the HelpModelEvent posted after the model has
changed.
l
- - The listener to add.
addHighlight
public void addHighlight(int p0,
int p1)
Hightlights a section of the current document from p0 to p1.
p0
- Starting position.p1
- Ending position.
addTextHelpModelListener
public void addTextHelpModelListener(TextHelpModelListener l)
Adds a listener for the TExtHelpModelEvent posted after the model has
changed.
l
- - The listener to add.
clear
public void clear()
Cleans the content
createEditorKitForContentType
public EditorKit createEditorKitForContentType(String type)
Creates a handler for the given type from the registry of editor kits.
If the registered class has not yet been loaded, an attempt
is made to dynamically load the prototype of the kit for the
given type. If the type was registered with a ClassLoader,
that ClassLoader is used to load the prototype. If there
was no registered ClassLoader, the ClassLoader for the HelpSet
is used to load the prototype.
Once a prototype EditorKit instance is successfully located,
it is cloned and the clone is returned.
- the editor kit, or null if one cannot be created
getAccessibleContext
public AccessibleContext getAccessibleContext()
Get the AccessibleContext associated with this JComponent
- the AccessibleContext of this JComponent
getCurrentURL
public URL getCurrentURL()
- The URL currently being presented in the viewer.
getDocumentTitle
public String getDocumentTitle()
getModel
public TextHelpModel getModel()
- The HelpModel that provides the events.
getSynch
public boolean getSynch()
Returns synchronization mode
getUI
public HelpContentViewerUI getUI()
- The HelpViewerUI that provides the current look and feel.
getUIClassID
public String getUIClassID()
reload
public void reload()
Reloads the content
removeAllHighlights
public void removeAllHighlights()
Removes any Highlights.
removeHelpModelListener
public void removeHelpModelListener(HelpModelListener l)
Removes a listener previously added with addHelpModelListener
l
- - The listener to remove.
removeHelpModelListener
public void removeHelpModelListener(TextHelpModelListener l)
Removes a listener previously added with addTextHelpModelListener
l
- - The listener to remove.
setCurrentID
public void setCurrentID(String id)
throws BadIDException
Visits a given ID. Propagates down into the model.
id
- The String to visit. Relative to the HS of the current model.
BadIDException
- The ID is not valid for the HelpSet for the current model.
setCurrentURL
public void setCurrentURL(URL url)
Visits a given URL. Propagates down into the model.
url
- The URL to visit. Relative to the HS of the current model
setModel
public void setModel(TextHelpModel newModel)
Sets the HelpModel that provides the data.
Necessary to convert navigation action into visits...
newModel
- The new Model to provide events for this viewer.
setSynch
public void setSynch(boolean value)
Sets synchronization of this JHelpContentViewer with navigators.
If true then JHelpContentViewer will contain homeID page when comes up at first time.
False value causes blank page in this case.
setUI
public void setUI(HelpContentViewerUI ui)
Sets the HelpViewerUI that provides the current look and feel.
ui
- Provides the ComponentUI object. A null ui is valid.
updateUI
public void updateUI()
Replaces the UI with the latest version from the default
UIFactory.