Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.help

Class JHelpSearchNavigator

Implemented Interfaces:
Accessible
public class JHelpSearchNavigator
extends JHelpNavigator
A JHelpNavigator for search data. All of the tree navigation and selection has been delegated to the UI.

Nested Class Summary

Nested classes/interfaces inherited from class javax.help.JHelpNavigator

JHelpNavigator.AccessibleJHelpNavigator

Field Summary

Fields inherited from class javax.help.JHelpNavigator

helpModel, type

Constructor Summary

JHelpSearchNavigator(HelpSet hs, String name, String label, 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.

Method Summary

boolean
canMerge(NavigatorView view)
Determines if this instance of a JHelpNavigator can merge its data with another one.
protected String
getDefaultQueryEngine()
Default for the search engine.
SearchEngine
getSearchEngine()
Instantiates and returns a SearchEngine class.
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).

Methods inherited from class javax.help.JHelpNavigator

addHelpModelListener, canMerge, createParams, getAccessibleContext, getIcon, getModel, getNavigatorLabel, getNavigatorLabel, getNavigatorName, getNavigatorView, getSelectedItems, getUI, getUIClassID, merge, remove, removeHelpModelListener, setModel, setSelectedItems, setUI, updateUI

Constructor Details

JHelpSearchNavigator

public JHelpSearchNavigator(HelpSet hs,
                            String name,
                            String label,
                            URL data)
            throws InvalidNavigatorViewException
Creates a TOC navigator with explicit arguments. Note that this should not throw an InvalidNavigatorViewException since the type is passed implicitly.
Parameters:
hs - HelpSet
name - 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.

JHelpSearchNavigator

public JHelpSearchNavigator(NavigatorView view)
Creates a Search navigator
Parameters:
view - The NavigatorView. If view is null it creates a JHelpSearchNavigator with a null NavigatorView.

JHelpSearchNavigator

public JHelpSearchNavigator(NavigatorView view,
                            HelpModel model)
Creates a Search navigator.
Parameters:
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.

Method Details

canMerge

public boolean canMerge(NavigatorView view)
Determines if this instance of a JHelpNavigator can merge its data with another one.
Overrides:
canMerge in interface JHelpNavigator
Parameters:
view - The data to merge.
Returns:
Whether it can be merged.
See Also:
merge(NavigatorView), remove(NavigatorView)

getDefaultQueryEngine

protected String getDefaultQueryEngine()
Default for the search engine.

getSearchEngine

public SearchEngine getSearchEngine()
Instantiates and returns a SearchEngine class. The default query engine to use is com.sun.java.help.search.SearchEngine, but this can be changed through the <engine></engine> attribute of the view.
Returns:
The SearchEngine instantiation.

getUIClassID

public String getUIClassID()
The UID for this JComponent.
Overrides:
getUIClassID in interface JHelpNavigator

merge

public void merge(NavigatorView view)
Merges a NavigatorView into this instance.
Overrides:
merge in interface JHelpNavigator
Parameters:
view - The data to merge.
See Also:
canMerge(NavigatorView), remove(NavigatorView)

remove

public void remove(NavigatorView view)
Removes a NavigatorView from this instance.
Overrides:
remove in interface JHelpNavigator
Parameters:
view - The data to merge.
See Also:
canMerge(NavigatorView), merge(NavigatorView)

setSearchEngine

public void setSearchEngine(SearchEngine search)
Explicitly changes the default (overriding what is in the HelpSet).
Parameters:
search - A SearchEngine instantiation.

Overview Package Class Use Tree Index Deprecated About