| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.help.NavigatorView
javax.help.IndexView
Navigational View information for an Index
| Nested Class Summary | |
| static class | IndexView.DefaultIndexFactoryA default TreeItemFactory that can be used to parse TOC items as used by this navigator. | 
| Field Summary | |
| static java.lang.String | publicIDStringPublicID (known to this XML processor) to the DTD for version 1.0 of the Index | 
| static java.lang.String | publicIDString_V2PublicID (known to this XML processor) to the DTD for version 2.0 of the Index | 
| Constructor Summary | |
| IndexView(HelpSet hs,
          java.lang.String name,
          java.lang.String label,
          java.util.Hashtable params)Construct an IndexView with some given data. | |
| IndexView(HelpSet hs,
          java.lang.String name,
          java.lang.String label,
          java.util.Locale locale,
          java.util.Hashtable params)Constructs an IndexView with some given data. | |
| Method Summary | |
|  java.awt.Component | createNavigator(HelpModel model)create a navigator for a given model. | 
|  javax.swing.tree.DefaultMutableTreeNode | getDataAsTree()Gets a DefaultMutableTreeNode representing the information in this view instance. | 
|  java.lang.String | getMergeType()Get the Index navigators mergeType. | 
| static javax.swing.tree.DefaultMutableTreeNode | parse(java.net.URL url,
      HelpSet hs,
      java.util.Locale locale,
      TreeItemFactory factory)Public method for parsing an Index in a URL. | 
| Methods inherited from class javax.help.NavigatorView | 
| create, getHelpSet, getImageID, getLabel, getLabel, getLocale, getName, getParameters | 
| Methods inherited from class java.lang.Object | 
| equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
public static final java.lang.String publicIDString
public static final java.lang.String publicIDString_V2
| Constructor Detail | 
public IndexView(HelpSet hs,
                 java.lang.String name,
                 java.lang.String label,
                 java.util.Hashtable params)
hs - The HelpSet that provides context informationname - The name of the Viewlabel - The label (to show the user) of the Viewparams - A hashtable providing different key/values for this type.
 A null for params is valid.
public IndexView(HelpSet hs,
                 java.lang.String name,
                 java.lang.String label,
                 java.util.Locale locale,
                 java.util.Hashtable params)
hs - The HelpSet that provides context informationname - The name of the Viewlabel - The label (to show the user) of the Viewlocale - The default locale to interpret the data in this TOC. A
 null for locale will be interpreted as the defaultLocale.params - A Hashtable providing different key/values for this type
 A null for params is valid.| Method Detail | 
public java.awt.Component createNavigator(HelpModel model)
createNavigator in class NavigatorViewmodel - The HelpModel to create this navigator with. A null model
 is valid.
public java.lang.String getMergeType()
getMergeType in class NavigatorViewpublic javax.swing.tree.DefaultMutableTreeNode getDataAsTree()
public static javax.swing.tree.DefaultMutableTreeNode parse(java.net.URL url,
                                                            HelpSet hs,
                                                            java.util.Locale locale,
                                                            TreeItemFactory factory)
url - Location of the Index. If null, causes null value to be returned.hs - The HelpSet context for this Index. Null hs is ignored.locale - The default locale to interpret the data in this Index. Null
 locale is treated as the default locale.factory - A factory instance that is used to create the IndexItems
| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||