Package javax.help
Class IndexView
java.lang.Object
javax.help.NavigatorView
javax.help.IndexView
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
GlossaryView
Navigational View information for an Index
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
A default TreeItemFactory that can be used to parse TOC items as used by this navigator. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateNavigator
(HelpModel model) create a navigator for a given model.Gets a DefaultMutableTreeNode representing the information in this view instance.Get the Index navigators mergeType.static DefaultMutableTreeNode
parse
(URL url, HelpSet hs, 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
-
Field Details
-
publicIDString
PublicID (known to this XML processor) to the DTD for version 1.0 of the Index- See Also:
-
publicIDString_V2
PublicID (known to this XML processor) to the DTD for version 2.0 of the Index- See Also:
-
-
Constructor Details
-
IndexView
Construct an IndexView with some given data. Locale defaults to that of the HelpSet.- Parameters:
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.
-
IndexView
Constructs an IndexView with some given data.- Parameters:
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 Details
-
getMergeType
Get the Index navigators mergeType. Overrides getMergeType in NavigatorView- Overrides:
getMergeType
in classNavigatorView
- Returns:
- The merge type of this Navigator view
-
getDataAsTree
Gets a DefaultMutableTreeNode representing the information in this view instance. The default implementation parses the data in the URL, but a subclass may override this method and provide a different implemenation. For example, it may create the tree programatically. -
parse
public static DefaultMutableTreeNode parse(URL url, HelpSet hs, Locale locale, TreeItemFactory factory) Public method for parsing an Index in a URL. It returns a DefaultMutableTreeNode and its children that correspond to the indexitems in the Index. The factory is invoked to create the TreeItems that are included in the DefaultMutableTreeNode as user data.- Parameters:
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- Returns:
- a TreeNode that represents the Index. Returns null if parsing errors were encountered.