java.awt.image.ImageObserver
, java.awt.MenuContainer
, java.io.Serializable
, javax.accessibility.Accessible
public class JHelpSearchNavigator extends JHelpNavigator
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
java.awt.Container.AccessibleAWTContainer
javax.swing.JComponent.AccessibleJComponent
JHelpNavigator.AccessibleJHelpNavigator
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
helpModel, type
Constructor | Description |
---|---|
JHelpSearchNavigator(HelpSet hs,
java.lang.String name,
java.lang.String label,
java.net.URL data) |
Creates a TOC navigator with explicit arguments.
|
JHelpSearchNavigator(NavigatorView view) |
Creates a Search navigator
|
JHelpSearchNavigator(NavigatorView view,
HelpModel model) |
Creates a Search navigator.
|
Modifier and Type | Method | Description |
---|---|---|
boolean |
canMerge(NavigatorView view) |
Determines if this instance of a JHelpNavigator can merge its data with another one.
|
protected java.lang.String |
getDefaultQueryEngine() |
Default for the search engine.
|
SearchEngine |
getSearchEngine() |
Instantiates and returns a SearchEngine class.
|
java.lang.String |
getUIClassID() |
The UID for this JComponent.
|
void |
merge(NavigatorView view) |
Merges a NavigatorView into this instance.
|
void |
remove(NavigatorView view) |
Removes a NavigatorView from this instance.
|
void |
setSearchEngine(SearchEngine search) |
Explicitly changes the default (overriding what is in the HelpSet).
|
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
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
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
addHelpModelListener, createParams, getAccessibleContext, getIcon, getModel, getNavigatorLabel, getNavigatorLabel, getNavigatorName, getNavigatorView, getSelectedItems, getUI, removeHelpModelListener, setModel, setSelectedItems, setUI, updateUI
public JHelpSearchNavigator(NavigatorView view)
view
- The NavigatorView. If view is null it creates a JHelpSearchNavigator
with a null NavigatorView.public JHelpSearchNavigator(NavigatorView view, HelpModel model)
view
- The NavigatorView. If view is null it creates a JHelpSearchNavigator
with a null NavigatorView.model
- The HelpModel this Navigator is presenting. If model is null it
creates a JHelpSearchNavigator witout a model.public JHelpSearchNavigator(HelpSet hs, java.lang.String name, java.lang.String label, java.net.URL data) throws InvalidNavigatorViewException
hs
- HelpSetname
- The name indentifying this HelpSet.label
- The label to use (for this locale).data
- The "data" part of the parameters, a URL to the location of the TOC data.InvalidNavigatorViewException
public java.lang.String getUIClassID()
getUIClassID
in class JHelpNavigator
public SearchEngine getSearchEngine()
public void setSearchEngine(SearchEngine search)
search
- A SearchEngine instantiation.protected java.lang.String getDefaultQueryEngine()
public boolean canMerge(NavigatorView view)
canMerge
in class JHelpNavigator
view
- The data to merge.merge(javax.help.NavigatorView)
,
remove(javax.help.NavigatorView)
public void merge(NavigatorView view)
merge
in class JHelpNavigator
view
- The data to merge.java.lang.IllegalArgumentException
java.lang.IllegalStateException
canMerge(javax.help.NavigatorView)
,
remove(javax.help.NavigatorView)
public void remove(NavigatorView view)
remove
in class JHelpNavigator
view
- The data to merge.java.lang.IllegalArgumentException
java.lang.IllegalStateException
canMerge(javax.help.NavigatorView)
,
merge(javax.help.NavigatorView)