javax.help
Class JHelpTOCNavigator
- Accessible
public class JHelpTOCNavigator
A JHelpNavigator for a TOC.
All of the tree navigation and selection has been delegated to the UI
where the JTree is created.
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.
|
addHelpModelListener , canMerge , createParams , getAccessibleContext , getIcon , getModel , getNavigatorLabel , getNavigatorLabel , getNavigatorName , getNavigatorView , getSelectedItems , getUI , getUIClassID , merge , remove , removeHelpModelListener , setModel , setSelectedItems , setUI , updateUI |
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.
hs
- HelpSetname
- 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
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.
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.
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.
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.
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.
target
- The target to expand
merge
public void merge(NavigatorView view)
Merges a NavigatorView into this instance.
- merge in interface JHelpNavigator
view
- The data to merge. This must be a TOCView.