Package docking.help
Class CustomTOCView
- java.lang.Object
-
- javax.help.NavigatorView
-
- javax.help.TOCView
-
- docking.help.CustomTOCView
-
- All Implemented Interfaces:
java.io.Serializable
public class CustomTOCView extends javax.help.TOCView
A custom Table of Contents view that we specify in our JavaHelp xml documents. This view lets us install custom renderers and custom tree items for use by those renderers. These renderers let us display custom text defined by the TOC_Source.xml files. We also add some utility like: tooltips in development mode, node selection when pressing F1.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CustomTOCView.CustomDefaultTOCFactory
Our custom factory that knows how to look for extra XML attributes and how to create our custom tree itemsstatic class
CustomTOCView.CustomTreeItemDecorator
A custom tree item that allows us to store and retrieve custom attributes that we parsed from the TOC xml document.
-
Constructor Summary
Constructors Constructor Description CustomTOCView(javax.help.HelpSet hs, java.lang.String name, java.lang.String label, java.util.Hashtable params)
CustomTOCView(javax.help.HelpSet hs, java.lang.String name, java.lang.String label, java.util.Locale locale, java.util.Hashtable params)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.awt.Component
createNavigator(javax.help.HelpModel model)
javax.swing.tree.DefaultMutableTreeNode
getDataAsTree()
javax.help.HelpModel
getHelpModel()
-
Methods inherited from class javax.help.TOCView
getCategoryClosedImageID, getCategoryOpenImageID, getMergeType, getTopicImageID, parse, parse, setCategoryClosedImageID, setCategoryOpenImageID, setTopicImageID
-
-
-
-
Constructor Detail
-
CustomTOCView
public CustomTOCView(javax.help.HelpSet hs, java.lang.String name, java.lang.String label, java.util.Hashtable params)
-
CustomTOCView
public CustomTOCView(javax.help.HelpSet hs, java.lang.String name, java.lang.String label, java.util.Locale locale, java.util.Hashtable params)
-
-
Method Detail
-
createNavigator
public java.awt.Component createNavigator(javax.help.HelpModel model)
- Overrides:
createNavigator
in classjavax.help.TOCView
-
getHelpModel
public javax.help.HelpModel getHelpModel()
-
getDataAsTree
public javax.swing.tree.DefaultMutableTreeNode getDataAsTree()
- Overrides:
getDataAsTree
in classjavax.help.TOCView
-
-