Class javax.help.JHelpTOCNavigator
java.lang.Object
|
+----java.awt.Component
|
+----java.awt.Container
|
+----javax.swing.JComponent
|
+----javax.help.JHelpNavigator
|
+----javax.help.JHelpTOCNavigator
- 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.
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.
JHelpTOCNavigator
public JHelpTOCNavigator(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 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.
getUIClassID
public java.lang.String getUIClassID()
- The UID for this JComponent.
- Overrides:
- getUIClassID in class JHelpNavigator
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(), remove()
merge
public void merge(NavigatorView view)
- Merges a NavigatorView into this instance.
- Parameters:
view
- The data to merge. This must be a TOCView.
- Throws:
- java.lang.IllegalArgumentException -
- java.lang.IllegalStateException -
- Overrides:
- merge in class JHelpNavigator
- See Also:
- canMerge(), remove()
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(), merge()
expandID
public void expandID(java.lang.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
collapseID
public void collapseID(java.lang.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