javax.help

Class JHelpTOCNavigator

Implemented Interfaces:
Accessible

public class JHelpTOCNavigator
extends JHelpNavigator

A JHelpNavigator for a TOC. All of 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

JHelpTOCNavigator(HelpSet hs, String name, String label, URL data)
Creates a TOC navigator with explicit arguments.
JHelpTOCNavigator(NavigatorView view)
Create a TOC navigator
JHelpTOCNavigator(NavigatorView view, HelpModel model)
Creates a TOC 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()
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.

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

JHelpTOCNavigator

public JHelpTOCNavigator(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 implicitly passed.
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 location of the TOC data.

JHelpTOCNavigator

public JHelpTOCNavigator(NavigatorView view)
Create a TOC navigator
Parameters:
view - The NavigatorView. If view is null it creates a JHelpTOCNavigator without a HelpModel and a null NavigatorView.

JHelpTOCNavigator

public JHelpTOCNavigator(NavigatorView view,
                         HelpModel model)
Creates a TOC navigator.
Parameters:
view - The NavigatorView. If view is null it creates a JHelpTOCNavigator with a null NavigatorView.
model - The model for the Navigator. If model is null it creates a JHelpTOCNavigator 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(), remove()

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()
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. This must be a TOCView.
See Also:
canMerge(), remove()

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(), merge()