javax.help

Class JHelpIndexNavigator

Implemented Interfaces:
Accessible

public class JHelpIndexNavigator
extends JHelpNavigator

JHelpIndexNavigator is a JHelpNavigator for an Index. All the tree navigation and selection has been delegated to the UI where the JTree is created.

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

JHelpIndexNavigator(HelpSet hs, String name, String label, URL data)
Creates an Index navigator with explicit arguments.
JHelpIndexNavigator(NavigatorView view)
Creates an Index navigator.
JHelpIndexNavigator(NavigatorView view, HelpModel model)
Creates a Index navigator.

Method Summary

boolean
canMerge(NavigatorView view)
Determines if this instance of a JHelpNavigator can merge its data with another one.
void
collapseID(String target)
Sets state of navigation entry for given target to collapsed if entry is visible.
void
expandID(String target)
Sets state of navigation entry for given target to expanded.
String
getUIClassID()
Gets the UID for this JComponent.
void
merge(NavigatorView view)
Merges some NavigatorView into this instance.
void
remove(NavigatorView view)
Removes a NavigatorView from this instance.

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

JHelpIndexNavigator

public JHelpIndexNavigator(HelpSet hs,
                           String name,
                           String label,
                           URL data)
            throws InvalidNavigatorViewException
Creates an Index navigator with explicit arguments. Note that this should not throw an InvalidNavigatorViewException since we are implicitly passing the type.
Parameters:
hs - HelpSet
name - The name identifying this HelpSet.
label - The label to use (for this locale).
data - The "data" part of the parameters, a URL location of the TOC data.

JHelpIndexNavigator

public JHelpIndexNavigator(NavigatorView view)
Creates an Index navigator.
Parameters:
view - The NavigatorView

JHelpIndexNavigator

public JHelpIndexNavigator(NavigatorView view,
                           HelpModel model)
Creates a Index navigator.
Parameters:
view - The NavigatorView.
model - The model for the Navigator.

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)

collapseID

public void collapseID(String target)
Sets state of navigation entry for given target to collapsed if entry is visible. Parent is collapsed if entry is empty.
Parameters:
target - The target to collapse

expandID

public void expandID(String target)
Sets state of navigation entry for given target to expanded. Non-empty entry is expanded. Empty entry is visible.
Parameters:
target - The target to expand

getUIClassID

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

merge

public void merge(NavigatorView view)
Merges some 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)