| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.help.JHelpContentViewer
A component to represent the Help viewer that can be embedded if desired.
| Nested Class Summary | 
| Nested classes inherited from class javax.swing.JComponent | 
| javax.swing.JComponent.AccessibleJComponent | 
| Field Summary | 
| Fields inherited from class javax.swing.JComponent | 
| TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW | 
| Fields inherited from class java.awt.Component | 
| BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT | 
| Fields inherited from interface java.awt.image.ImageObserver | 
| ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH | 
| 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 | 
|  javax.swing.text.EditorKit | createEditorKitForContentType(java.lang.String type)Creates a handler for the given type from the registry of editor kits. | 
|  javax.accessibility.AccessibleContext | getAccessibleContext()Get the AccessibleContext associated with this JComponent | 
|  java.net.URL | getCurrentURL() | 
|  java.lang.String | getDocumentTitle() | 
|  TextHelpModel | getModel() | 
|  boolean | getSynch()Returns synchronization mode | 
|  HelpContentViewerUI | getUI() | 
|  java.lang.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(Map.ID id)Visits a given ID. | 
|  void | setCurrentID(java.lang.String id)Visits a given ID. | 
|  void | setCurrentURL(java.net.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. | 
| Methods inherited from class javax.swing.JComponent | 
| addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update | 
| Methods inherited from class java.awt.Container | 
| add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate | 
| Methods inherited from class java.awt.Component | 
| action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle | 
| Methods inherited from class java.lang.Object | 
| equals, getClass, hashCode, notify, notifyAll, wait, wait, wait | 
| Constructor Detail | 
public JHelpContentViewer(HelpSet hs)
hs - The HelpSet that provides context information. A null hs is valid
 and creates a TextHelpModel with no HelpSet defined.public JHelpContentViewer()
public JHelpContentViewer(TextHelpModel model)
model - The TextHelpModel. A null model is valid.| Method Detail | 
public void setModel(TextHelpModel newModel)
newModel - The new Model to provide events for this viewer.public TextHelpModel getModel()
public void setUI(HelpContentViewerUI ui)
ui - Provides the ComponentUI object. A null ui is valid.public HelpContentViewerUI getUI()
public void updateUI()
public java.lang.String getUIClassID()
public void setCurrentID(Map.ID id)
                  throws InvalidHelpSetContextException
id - The ID to visit.
InvalidHelpSetContextException - if id.hs is not contained in the
 HelpSet of the current model.
public void setCurrentID(java.lang.String id)
                  throws BadIDException
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.public void setCurrentURL(java.net.URL url)
url - The URL to visit.  Relative to the HS of the current modelpublic java.net.URL getCurrentURL()
public java.lang.String getDocumentTitle()
public void addHighlight(int p0,
                         int p1)
p0 - Starting position.p1 - Ending position.public void removeAllHighlights()
public void setSynch(boolean value)
public boolean getSynch()
public javax.swing.text.EditorKit createEditorKitForContentType(java.lang.String type)
Once a prototype EditorKit instance is successfully located, it is cloned and the clone is returned.
type - the content type
public void addTextHelpModelListener(TextHelpModelListener l)
l - - The listener to add.HelpModel.removeHelpModelListener(javax.help.event.HelpModelListener)public void removeHelpModelListener(TextHelpModelListener l)
l - - The listener to remove.TextHelpModel.addTextHelpModelListener(javax.help.event.TextHelpModelListener)public void addHelpModelListener(HelpModelListener l)
l - - The listener to add.HelpModel.removeHelpModelListener(javax.help.event.HelpModelListener)public void removeHelpModelListener(HelpModelListener l)
l - - The listener to remove.HelpModel.addHelpModelListener(javax.help.event.HelpModelListener)public void clear()
public void reload()
public javax.accessibility.AccessibleContext getAccessibleContext()
getAccessibleContext in interface javax.accessibility.Accessible| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||