Package javax.help
Class JHelpContentViewer
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.help.JHelpContentViewer
- All Implemented Interfaces:
ImageObserver
,MenuContainer
,Serializable
,Accessible
A component to represent the Help viewer that can be embedded if desired.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected class
The class used to obtain the accessible role for this object.Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
Field Summary
FieldsFields inherited from class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Fields inherited from class java.awt.Component
accessibleContext, 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
ConstructorsConstructorDescriptionCreates a JHelp with a default TextHelpModel.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
Modifier and TypeMethodDescriptionvoid
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
Adds a listener for the TExtHelpModelEvent posted after the model has changed.void
clear()
Cleans the contentCreates a handler for the given type from the registry of editor kits.Get the AccessibleContext associated with this JComponentgetModel()
boolean
getSynch()
Returns synchronization modegetUI()
void
reload()
Reloads the contentvoid
Removes any Highlights.void
Removes a listener previously added with addHelpModelListenervoid
Removes a listener previously added with addTextHelpModelListenervoid
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
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, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Field Details
-
model
-
-
Constructor Details
-
JHelpContentViewer
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
Creates a JHelp with an specific TextHelpModel as its data model.- Parameters:
model
- The TextHelpModel. A null model is valid.
-
-
Method Details
-
setModel
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
- Returns:
- The HelpModel that provides the events.
-
setUI
Sets the HelpViewerUI that provides the current look and feel.- Parameters:
ui
- Provides the ComponentUI object. A null ui is valid.
-
getUI
- Overrides:
getUI
in classJComponent
- 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 classJComponent
-
getUIClassID
- Overrides:
getUIClassID
in classJComponent
- Returns:
- "HelpViewerUI"
-
setCurrentID
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
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
Visits a given URL. Propagates down into the model.- Parameters:
url
- The URL to visit. Relative to the HS of the current model
-
getCurrentURL
- Returns:
- The URL currently being presented in the viewer.
-
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
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
Adds a listener for the TExtHelpModelEvent posted after the model has changed.- Parameters:
l
- - The listener to add.- See Also:
-
removeHelpModelListener
Removes a listener previously added with addTextHelpModelListener- Parameters:
l
- - The listener to remove.- See Also:
-
addHelpModelListener
Adds a listener for the HelpModelEvent posted after the model has changed.- Parameters:
l
- - The listener to add.- See Also:
-
removeHelpModelListener
Removes a listener previously added with addHelpModelListener- Parameters:
l
- - The listener to remove.- See Also:
-
clear
public void clear()Cleans the content -
reload
public void reload()Reloads the content -
getAccessibleContext
Get the AccessibleContext associated with this JComponent- Specified by:
getAccessibleContext
in interfaceAccessible
- Overrides:
getAccessibleContext
in classComponent
- Returns:
- the AccessibleContext of this JComponent
-