Class javax.help.JHelpContentViewer
java.lang.Object
|
+----java.awt.Component
|
+----java.awt.Container
|
+----javax.swing.JComponent
|
+----javax.help.JHelpContentViewer
- public class JHelpContentViewer
- extends javax.swing.JComponent
- implements javax.accessibility.Accessible
A component to represent the Help viewer that can be embedded if desired.
model
protected TextHelpModel model
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()
- Creates a JHelp with a default TextHelpModel.
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.
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.
getModel
public TextHelpModel getModel()
- Returns:
- The HelpModel that provides the events.
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.
getUI
public HelpContentViewerUI getUI()
- Returns:
- The HelpViewerUI that provides the current look and feel.
updateUI
public void updateUI()
- Replaces the UI with the latest version from the default
UIFactory.
- Overrides:
- updateUI in class javax.swing.JComponent
getUIClassID
public java.lang.String getUIClassID()
- Returns:
- "HelpViewerUI"
- Overrides:
- getUIClassID in class javax.swing.JComponent
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.
setCurrentID
public void setCurrentID(java.lang.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.
setCurrentURL
public void setCurrentURL(java.net.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
getCurrentURL
public java.net.URL getCurrentURL()
- Returns:
- The URL currently being presented in the viewer.
getDocumentTitle
public java.lang.String getDocumentTitle()
- Returns:
- The document title.
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.
removeAllHighlights
public void removeAllHighlights()
- Removes any Highlights.
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.
getSynch
public boolean getSynch()
- Returns synchronization mode
createEditorKitForContentType
public javax.swing.text.EditorKit createEditorKitForContentType(java.lang.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
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:
- removeHelpModelListener
removeHelpModelListener
public void removeHelpModelListener(TextHelpModelListener l)
- Removes a listener previously added with addTextHelpModelListener
- Parameters:
l
- - The listener to remove.
- See Also:
- addTextHelpModelListener
addHelpModelListener
public void addHelpModelListener(HelpModelListener l)
- Adds a listener for the HelpModelEvent posted after the model has
changed.
- Parameters:
l
- - The listener to add.
- See Also:
- removeHelpModelListener
removeHelpModelListener
public void removeHelpModelListener(HelpModelListener l)
- Removes a listener previously added with addHelpModelListener
- Parameters:
l
- - The listener to remove.
- See Also:
- addHelpModelListener
clear
public void clear()
- Cleans the content
reload
public void reload()
- Reloads the content
getAccessibleContext
public javax.accessibility.AccessibleContext getAccessibleContext()
- Get the AccessibleContext associated with this JComponent
- Implements:
- getAccessibleContext in interface javax.accessibility.Accessible
- Returns:
- the AccessibleContext of this JComponent
- Overrides:
- getAccessibleContext in class javax.swing.JComponent