javax.help

Class JHelpContentViewer

Implemented Interfaces:
Accessible

public class JHelpContentViewer
extends JComponent
implements Accessible

A component to represent the Help viewer that can be embedded if desired.

Nested Class Summary

protected class
JHelpContentViewer.AccessibleJHelpContentViewer
The class used to obtain the accessible role for this object.

Field Summary

protected TextHelpModel
model

Constructor Summary

JHelpContentViewer()
Creates a JHelp with a default TextHelpModel.
JHelpContentViewer(HelpSet hs)
Creates a JHelp with an instance of DefaultHelpModel as its data model.
JHelpContentViewer(TextHelpModel model)
Creates a JHelp with an specific TextHelpModel as its data model.

Method Summary

void
addHelpModelListener(HelpModelListener l)
Adds a listener for the HelpModelEvent posted after the model has changed.
void
addHighlight(int p0, int p1)
Hightlights a section of the current document from p0 to p1.
void
addTextHelpModelListener(TextHelpModelListener l)
Adds a listener for the TExtHelpModelEvent posted after the model has changed.
void
clear()
Cleans the content
EditorKit
createEditorKitForContentType(String type)
Creates a handler for the given type from the registry of editor kits.
AccessibleContext
getAccessibleContext()
Get the AccessibleContext associated with this JComponent
URL
getCurrentURL()
String
getDocumentTitle()
TextHelpModel
getModel()
boolean
getSynch()
Returns synchronization mode
HelpContentViewerUI
getUI()
String
getUIClassID()
void
reload()
Reloads the content
void
removeAllHighlights()
Removes any Highlights.
void
removeHelpModelListener(HelpModelListener l)
Removes a listener previously added with addHelpModelListener
void
removeHelpModelListener(TextHelpModelListener l)
Removes a listener previously added with addTextHelpModelListener
void
setCurrentID(String id)
Visits a given ID.
void
setCurrentID(Map.ID id)
Visits a given ID.
void
setCurrentURL(URL url)
Visits a given URL.
void
setModel(TextHelpModel newModel)
Sets the HelpModel that provides the data.
void
setSynch(boolean value)
Sets synchronization of this JHelpContentViewer with navigators.
void
setUI(HelpContentViewerUI ui)
Sets the HelpViewerUI that provides the current look and feel.
void
updateUI()
Replaces the UI with the latest version from the default UIFactory.

Field Details

model

protected TextHelpModel model

Constructor Details

JHelpContentViewer

public JHelpContentViewer()
Creates a JHelp with a default TextHelpModel.

JHelpContentViewer

public JHelpContentViewer(HelpSet hs)
Creates a JHelp with an instance of DefaultHelpModel as its data model.
Parameters:
hs - The HelpSet that provides context information. A null hs is valid and creates a TextHelpModel with no HelpSet defined.

JHelpContentViewer

public JHelpContentViewer(TextHelpModel model)
Creates a JHelp with an specific TextHelpModel as its data model.
Parameters:
model - The TextHelpModel. A null model is valid.

Method Details

addHelpModelListener

public void addHelpModelListener(HelpModelListener l)
Adds a listener for the HelpModelEvent posted after the model has changed.
Parameters:
l - - The listener to add.

addHighlight

public void addHighlight(int p0,
                         int p1)
Hightlights a section of the current document from p0 to p1.
Parameters:
p0 - Starting position.
p1 - Ending position.

addTextHelpModelListener

public void addTextHelpModelListener(TextHelpModelListener l)
Adds a listener for the TExtHelpModelEvent posted after the model has changed.
Parameters:
l - - The listener to add.
See Also:
TextHelpModel

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.

Parameters:
type - the content type
Returns:
the editor kit, or null if one cannot be created

getAccessibleContext

public AccessibleContext getAccessibleContext()
Get the AccessibleContext associated with this JComponent
Returns:
the AccessibleContext of this JComponent

getCurrentURL

public URL getCurrentURL()
Returns:
The URL currently being presented in the viewer.

getDocumentTitle

public String getDocumentTitle()
Returns:
The document title.

getModel

public TextHelpModel getModel()
Returns:
The HelpModel that provides the events.

getSynch

public boolean getSynch()
Returns synchronization mode

getUI

public HelpContentViewerUI getUI()
Returns:
The HelpViewerUI that provides the current look and feel.

getUIClassID

public String getUIClassID()
Returns:
"HelpViewerUI"

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
Parameters:
l - - The listener to remove.

removeHelpModelListener

public void removeHelpModelListener(TextHelpModelListener l)
Removes a listener previously added with addTextHelpModelListener
Parameters:
l - - The listener to remove.

setCurrentID

public void setCurrentID(String id)
            throws BadIDException
Visits a given ID. Propagates down into the model.
Parameters:
id - The String to visit. Relative to the HS of the current model.
Throws:
BadIDException - The ID is not valid for the HelpSet for the current model.

setCurrentID

public void setCurrentID(Map.ID id)
            throws InvalidHelpSetContextException
Visits a given ID. Propagates down into the model.
Parameters:
id - The ID to visit.
Throws:
InvalidHelpSetContextException - if id.hs is not contained in the HelpSet of the current model.

setCurrentURL

public void setCurrentURL(URL url)
Visits a given URL. Propagates down into the model.
Parameters:
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...
Parameters:
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.
Parameters:
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.