Package javax.help
Class JHelp
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.help.JHelp
- All Implemented Interfaces:
ImageObserver
,MenuContainer
,Serializable
,EventListener
,Accessible
,HelpSetListener
Displays HelpSet data with navigators and a content viewer.
- 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
FieldsModifier and TypeFieldDescriptionprotected JHelpContentViewer
protected TextHelpModel
protected HelpHistoryModel
protected HelpSet.Presentation
protected boolean
protected Vector
protected boolean
Fields 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
ConstructorsConstructorDescriptionJHelp()
Create a JHelp component without a TextHelpModel.Create a JHelp with a JHelpContentViewer and all Navigators requested in the HelpSet.JHelp
(TextHelpModel model) Create a JHelp using the TextHelpModel.JHelp
(TextHelpModel model, HelpHistoryModel history, HelpSet.Presentation hsPres) Create a JHelp using the TextHelpModel and HelpHistoryModel -
Method Summary
Modifier and TypeMethodDescriptionvoid
addHelpNavigator
(JHelpNavigator navigator) A JHelp can have a number of navigators.Get the AccessibleContext associated with this JComponent.Retrieves what is the current content viewer Read-Only property?Returns The HelpHistoryModelgetModel()
TreeItem[]
Returns a list of selected items from the current navigatorgetUI()
Returns the HelpUI that is providing the current look and feel.void
Adds a new HelpSet to "our" HelpSet.void
Removes a HelpSet from "our" HelpSet.boolean
Determines if the Navigators are hidden/displayed in the HelpUI.boolean
Determines if the Navigators are hidden/displayed in the HelpUI.void
removeHelpNavigator
(JHelpNavigator navigator) Removes a navigator.void
setCurrentID
(String id) Convenience version of the above.void
setCurrentID
(Map.ID id) Visits a given ID.void
setCurrentID
(Map.ID id, String historyName, JHelpNavigator navigator) Visits a given ID.void
setCurrentNavigator
(JHelpNavigator navigator) Sets the current navigator in the HelpUI.void
setCurrentURL
(URL url) Visits a given URL.void
setCurrentURL
(URL url, String historyName, JHelpNavigator navigator) Visits a given URL.void
Set the HelpSet.Presentation.void
setHelpSetSpec
(String spec) Set the URL to the HelpSet.void
setModel
(TextHelpModel newModel) Sets the HelpModel that provides the data.void
setNavigatorDisplayed
(boolean displayed) Hidess/Displays the Navigators in the HelpUI.void
setToolbarDisplayed
(boolean displayed) Hidess/Displays the Toolbar in the HelpUI.void
Sets the HelpUI that will provide the current look and feel.protected void
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
-
helpModel
-
historyModel
-
toolbarDisplayed
protected boolean toolbarDisplayed -
hsPres
-
contentViewer
-
-
Constructor Details
-
JHelp
Create a JHelp with a JHelpContentViewer and all Navigators requested in the HelpSet.- Parameters:
hs
- The HelpSet. If hs is null the JHelp is created with a TextHelpModel with no HelpSet.
-
JHelp
public JHelp()Create a JHelp component without a TextHelpModel. -
JHelp
Create a JHelp using the TextHelpModel.- Parameters:
model
- A model to use for the content and all the navigators. If model is null it is the same as creating without a TextHelpModel
-
JHelp
Create a JHelp using the TextHelpModel and HelpHistoryModel- Parameters:
model
- A model to use for the content and all the navigators. If model is null it is the same as creating without a TextHelpModelhistory
- A history model. If <history is null it is the same as creating without HelpHistoryModel
-
-
Method Details
-
setModel
Sets the HelpModel that provides the data.- Parameters:
newModel
- The new Model. If newModel is null the internal model is set to null.
-
getModel
- Returns:
- The HelpModel that is providing the data.
-
getHistoryModel
Returns The HelpHistoryModel- Returns:
- The HelpHistoryModel which provides history data
-
setHelpSetPresentation
Set the HelpSet.Presentation.- See Also:
-
getHelpSetPresentation
- Returns:
- The HelpSet.Presentation.
- See Also:
-
setHelpSetSpec
Set the URL to the HelpSet. This forces the HelpSet to be reloaded.- Parameters:
spec
- Where to locate the HelpSet. A null spec is valid
-
getHelpSetURL
- Returns:
- The URL to the HelpSet.
-
setUI
Sets the HelpUI that will provide the current look and feel.- Parameters:
ui
- The HelpUI to set for this component. A null value for ui is valid.
-
getUI
Returns the HelpUI that is providing the current look and feel.- Overrides:
getUI
in classJComponent
-
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:
- "HelpUI"
-
helpSetAdded
Adds a new HelpSet to "our" HelpSet.- Specified by:
helpSetAdded
in interfaceHelpSetListener
- Parameters:
e
- HelpSetEvent- See Also:
-
helpSetRemoved
Removes a HelpSet from "our" HelpSet.- Specified by:
helpSetRemoved
in interfaceHelpSetListener
- Parameters:
e
- The event
-
setCurrentID
Visits a given ID. Propagates down into the model.- Parameters:
id
- The ID to visit. Null id is valid for TextHelpModel.setCurrentID.- Throws:
InvalidHelpSetContextException
- if id.hs is not contained in getHelpSet()
-
setCurrentID
Convenience version of the above. The implicit HelpSet is the current HelpSet.- Parameters:
id
- The String to visit. Null id is valid for TextHelpModel.setCurrentID.- Throws:
BadIDException
- if the string is not in the map for the HelpSet.
-
setCurrentURL
Visits a given URL. Propagates down into the model.- Parameters:
url
- The URL to visit
-
getSelectedItems
Returns a list of selected items from the current navigator -
setToolbarDisplayed
public void setToolbarDisplayed(boolean displayed) Hidess/Displays the Toolbar in the HelpUI.- Since:
- 2.0
-
isToolbarDisplayed
public boolean isToolbarDisplayed()Determines if the Navigators are hidden/displayed in the HelpUI.- Returns:
- is the toolbar displayed?
- Since:
- 2.0
-
getContentViewer
Retrieves what is the current content viewer Read-Only property? -
getAccessibleContext
Get the AccessibleContext associated with this JComponent.- Specified by:
getAccessibleContext
in interfaceAccessible
- Overrides:
getAccessibleContext
in classComponent
- Returns:
- The AccessibleContext of this JComponent