Class javax.help.JHelpSearchNavigator
java.lang.Object
    |
    +----java.awt.Component
            |
            +----java.awt.Container
                    |
                    +----javax.swing.JComponent
                            |
                            +----javax.help.JHelpNavigator
                                    |
                                    +----javax.help.JHelpSearchNavigator
- public class JHelpSearchNavigator- extends JHelpNavigator
A JHelpNavigator for search data.
 All of the tree navigation and selection has been delegated to the UI.
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.
 
JHelpSearchNavigator
public JHelpSearchNavigator(HelpSet hs,
                            java.lang.String name,
                            java.lang.String label,
                            java.net.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.
 
getUIClassID
public java.lang.String getUIClassID()
- The UID for this JComponent.- 
- Overrides:
- getUIClassID in class JHelpNavigator
 
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.
 
setSearchEngine
public void setSearchEngine(SearchEngine search)
- Explicitly changes the default (overriding what is in the HelpSet).- 
- Parameters:
- 
search- A SearchEngine instantiation.
 
getDefaultQueryEngine
protected java.lang.String getDefaultQueryEngine()
- Default for the search engine.
canMerge
public boolean canMerge(NavigatorView view)
- Determines if this instance of a JHelpNavigator can merge its data with another one.- 
- Parameters:
- 
view- The data to merge.
- Returns:
- Whether it can be merged.
- Overrides:
- canMerge in class JHelpNavigator
- See Also:
- merge(NavigatorView), remove(NavigatorView)
 
merge
public void merge(NavigatorView view)
- Merges a NavigatorView into this instance.- 
- Parameters:
- 
view- The data to merge.
- Throws:
- java.lang.IllegalArgumentException - - java.lang.IllegalStateException - 
- Overrides:
- merge in class JHelpNavigator
- See Also:
- canMerge(NavigatorView), remove(NavigatorView)
 
remove
public void remove(NavigatorView view)
- Removes a NavigatorView from this instance.- 
- Parameters:
- 
view- The data to merge.
- Throws:
- java.lang.IllegalArgumentException - - java.lang.IllegalStateException - 
- Overrides:
- remove in class JHelpNavigator
- See Also:
- canMerge(NavigatorView), merge(NavigatorView)