javax.help
Class JHelpSearchNavigator
- Accessible
public class JHelpSearchNavigator
A JHelpNavigator for search data.
All of the tree navigation and selection has been delegated to the UI.
addHelpModelListener , canMerge , createParams , getAccessibleContext , getIcon , getModel , getNavigatorLabel , getNavigatorLabel , getNavigatorName , getNavigatorView , getSelectedItems , getUI , getUIClassID , merge , remove , removeHelpModelListener , setModel , setSelectedItems , setUI , updateUI |
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.
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.
JHelpSearchNavigator
public JHelpSearchNavigator(NavigatorView view)
Creates a Search navigator
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.
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.
canMerge
public boolean canMerge(NavigatorView view)
Determines if this instance of a JHelpNavigator can merge its data with another one.
- canMerge in interface JHelpNavigator
view
- The data to merge.
- Whether it can be merged.
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.
- The SearchEngine instantiation.
merge
public void merge(NavigatorView view)
Merges a NavigatorView into this instance.
- merge in interface JHelpNavigator
view
- The data to merge.
canMerge(NavigatorView)
, remove(NavigatorView)
remove
public void remove(NavigatorView view)
Removes a NavigatorView from this instance.
- remove in interface JHelpNavigator
view
- The data to merge.
canMerge(NavigatorView)
, merge(NavigatorView)
setSearchEngine
public void setSearchEngine(SearchEngine search)
Explicitly changes the default (overriding what is in the HelpSet).
search
- A SearchEngine instantiation.