| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.help.NavigatorView
javax.help.FavoritesView
Navigational View information for the Favorites
| Nested Class Summary | |
| static class | FavoritesView.DefaultFavoritesFactoryA default TreeItemFactory that can be used to parse Favorites items as used by this navigator. | 
| Field Summary | |
| static java.lang.String | publicIDStringPublicID (known to this XML processor) to the DTD for version 2.0 of the Index | 
| Constructor Summary | |
| FavoritesView(HelpSet hs,
              java.lang.String name,
              java.lang.String label,
              java.util.Hashtable params)Construct an FavoritesView with some given data. | |
| FavoritesView(HelpSet hs,
              java.lang.String name,
              java.lang.String label,
              java.util.Locale locale,
              java.util.Hashtable params)Constructs an FavoritesView with some given data. | |
| Method Summary | |
|  java.awt.Component | createNavigator(HelpModel model)create a navigator for a given model. | 
|  FavoritesNode | getDataAsTree()Gets a DefaultMutableTreeNode representing the information in this view instance. | 
|  java.lang.String | getMergeType()Get the Index navigators mergeType. | 
|  FavoritesNode | parse(HelpSet hs,
      java.util.Locale locale,
      TreeItemFactory factory)Public method for parsing the Favorites in a URL. | 
|  void | saveFavorites(FavoritesNode node)Saves favorites file | 
| 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
| Constructor Detail | 
public FavoritesView(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 FavoritesView(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 FavoritesNode getDataAsTree()
public FavoritesNode parse(HelpSet hs,
                           java.util.Locale locale,
                           TreeItemFactory factory)
hs - The HelpSet context for this Favorites. Null hs is ignored.locale - The default locale to interpret the data in this Favorites. Null
 locale is treated as the default locale.factory - A factory instance that is used to create the FavoritesItems
public void saveFavorites(FavoritesNode node)
node - The FavoritesNode| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||