public class JHelpNavigator
extends javax.swing.JComponent
implements javax.accessibility.Accessible
JHelpTOCNavigator
,
JHelpIndexNavigator
,
This 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 FormModifier and Type | Class and Description |
---|---|
protected class |
JHelpNavigator.AccessibleJHelpNavigator
The class used to obtain the accessible role for this object.
|
javax.swing.JComponent.AccessibleJComponent
Modifier and Type | Field and Description |
---|---|
protected HelpModel |
helpModel |
protected java.lang.String |
type |
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Constructor and Description |
---|
JHelpNavigator(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.
|
Modifier and Type | Method and Description |
---|---|
void |
addHelpModelListener(HelpModelListener l)
Adds a listener for the HelpModelEvent posted after the model has
changed.
|
boolean |
canMerge(NavigatorView view)
Determines if this instance of a JHelpNavigator can merge its data with another one.
|
protected static java.util.Hashtable |
createParams(java.net.URL data)
Creates the parameters for a Navigator from data stored in a URL.
|
javax.accessibility.AccessibleContext |
getAccessibleContext()
Get the AccessibleContext associated with this JComponent.
|
javax.swing.Icon |
getIcon()
Gets an icon to identify this Navigator.
|
HelpModel |
getModel()
Returns the HelpModel that provides the data.
|
java.lang.String |
getNavigatorLabel()
Gets the name of this navigator view.
|
java.lang.String |
getNavigatorLabel(java.util.Locale locale)
Gets locale-dependent name for this navigator view.
|
java.lang.String |
getNavigatorName()
Names this Navigator.
|
NavigatorView |
getNavigatorView()
Gets the NavigatorView that created this Navigator View.
|
TreeItem[] |
getSelectedItems()
Returns a list of selected items
|
HelpNavigatorUI |
getUI()
Returns the HelpUI that provides the current look and feel.
|
java.lang.String |
getUIClassID() |
void |
merge(NavigatorView view)
Merged a NavigatorView into this instance.
|
void |
remove(NavigatorView view)
Removes a NavigatorView from this instance.
|
void |
removeHelpModelListener(HelpModelListener l)
Removes a listener previously added with addHelpModelListener.
|
void |
setModel(HelpModel newModel)
Sets the HelpModel that provides the data.
|
void |
setSelectedItems(TreeItem[] selectedItems)
Sets the list of selected items
|
void |
setUI(HelpNavigatorUI ui)
Sets the HelpUI that provides the current look and feel.
|
void |
updateUI()
Replaces the UI with the latest version from the default
UIFactory.
|
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
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
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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
protected HelpModel helpModel
protected java.lang.String type
public JHelpNavigator(NavigatorView view)
view
- The NavigatorView to use. If view is null it creates a JHelpTOCNavigator
with a null NavigatorView.public JHelpNavigator(NavigatorView view, HelpModel model)
view
- The NavigatorView. If view is null it creates a JHelpNavigator
with a null NavigatorView.model
- The model that generates changes.
If model is null it creates a JHelpNavigator without a model.public TreeItem[] getSelectedItems()
public void setSelectedItems(TreeItem[] selectedItems)
public java.lang.String getUIClassID()
getUIClassID
in class javax.swing.JComponent
public boolean canMerge(NavigatorView view)
view
- The data to merge.merge(NavigatorView)
,
remove(NavigatorView)
public void merge(NavigatorView view)
view
- The data to mergeUnsupportedOperationException
canMerge(NavigatorView)
,
remove(NavigatorView)
public void remove(NavigatorView view)
view
- The data to mergeUnsupportedOperationException
canMerge(NavigatorView)
,
merge(NavigatorView)
public java.lang.String getNavigatorName()
public NavigatorView getNavigatorView()
public java.lang.String getNavigatorLabel()
public java.lang.String getNavigatorLabel(java.util.Locale locale)
public javax.swing.Icon getIcon()
public void setModel(HelpModel newModel)
newModel
- The HelpModel for this component. A null for newModel
is valid.public HelpModel getModel()
public void setUI(HelpNavigatorUI ui)
public HelpNavigatorUI getUI()
public void updateUI()
updateUI
in class javax.swing.JComponent
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)
protected static java.util.Hashtable createParams(java.net.URL data)
public javax.accessibility.AccessibleContext getAccessibleContext()
getAccessibleContext
in interface javax.accessibility.Accessible
getAccessibleContext
in class java.awt.Component