Package javax.help
Class JHelpNavigator
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.help.JHelpNavigator
- All Implemented Interfaces:
ImageObserver,MenuContainer,Serializable,Accessible
- Direct Known Subclasses:
JHelpFavoritesNavigator,JHelpGlossaryNavigator,JHelpIndexNavigator,JHelpSearchNavigator,JHelpTOCNavigator
A JHelpNavigator is a control that presents navigational help data.
It is identified by a type and it interacts with a HelpModel.
There are three JHelpNavigators that most JavaHelp implementations should
support:
- See Also:
-
JHelpTOCNavigatorJHelpIndexNavigatorThis class is intended to be extended. To use this class by itself requires a platform look and feel (plaf) class that extends javax.help.plaf.HelpNavigatorUI. Additionally, the UIDefaults table requires an entry for "HelpViewerUI" that points to the plaf class.- Serialized Form
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected classThe class used to obtain the accessible role for this object.Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponentNested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainerNested 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_WINDOWFields inherited from class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH -
Constructor Summary
ConstructorsConstructorDescriptionJHelpNavigator(NavigatorView view) Returns a JHelpNavigator with an instance of DefaultHelpModel as its data model.JHelpNavigator(NavigatorView view, HelpModel model) Constructs a JHelpNavigator from some view and with a preexisting model and in default initial state of navigation entries. -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds a listener for the HelpModelEvent posted after the model has changed.booleancanMerge(NavigatorView view) Determines if this instance of a JHelpNavigator can merge its data with another one.protected static HashtablecreateParams(URL data) Creates the parameters for a Navigator from data stored in a URL.Get the AccessibleContext associated with this JComponent.getIcon()Gets an icon to identify this Navigator.getModel()Returns the HelpModel that provides the data.Gets the name of this navigator view.getNavigatorLabel(Locale locale) Gets locale-dependent name for this navigator view.Names this Navigator.Gets the NavigatorView that created this Navigator View.TreeItem[]Returns a list of selected itemsgetUI()Returns the HelpUI that provides the current look and feel.voidmerge(NavigatorView view) Merged a NavigatorView into this instance.voidremove(NavigatorView view) Removes a NavigatorView from this instance.voidRemoves a listener previously added with addHelpModelListener.voidSets the HelpModel that provides the data.voidsetSelectedItems(TreeItem[] selectedItems) Sets the list of selected itemsvoidsetUI(HelpNavigatorUI ui) Sets the HelpUI that provides the current look and feel.voidupdateUI()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, updateMethods 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, validateTreeMethods 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
-
type
-
-
Constructor Details
-
Method Details
-
getSelectedItems
Returns a list of selected items -
setSelectedItems
Sets the list of selected items -
getUIClassID
- Overrides:
getUIClassIDin classJComponent- Returns:
- "HelpNavigatorUI"
-
getIcon
Gets an icon to identify this Navigator. Currently this is a read-only property.- Returns:
- An icon to identify this navigator.
-
setModel
Sets the HelpModel that provides the data.- Parameters:
newModel- The HelpModel for this component. A null for newModel is valid.
-
getModel
Returns the HelpModel that provides the data. -
getUI
Returns the HelpUI that provides the current look and feel.- Overrides:
getUIin classJComponent
-
updateUI
public void updateUI()Replaces the UI with the latest version from the default UIFactory.- Overrides:
updateUIin classJComponent
-
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:
-
createParams
Creates the parameters for a Navigator from data stored in a URL.- Returns:
- A Hashtable of parameters
-
getAccessibleContext
Get the AccessibleContext associated with this JComponent.- Specified by:
getAccessibleContextin interfaceAccessible- Overrides:
getAccessibleContextin classComponent- Returns:
- The AccessibleContext of this JComponent
-