javax.help
Class FavoritesView
- Serializable
public class FavoritesView
Navigational View information for the Favorites
static String | publicIDString - PublicID (known to this XML processor) to the DTD for version 2.0 of the Index
|
FavoritesView(HelpSet hs, String name, String label, Hashtable params) - Construct an FavoritesView with some given data.
|
FavoritesView(HelpSet hs, String name, String label, Locale locale, Hashtable params) - Constructs an FavoritesView with some given data.
|
publicIDString
public static final String publicIDString
PublicID (known to this XML processor) to the DTD for version 2.0 of the Index
FavoritesView
public FavoritesView(HelpSet hs,
String name,
String label,
Hashtable params)
Construct an FavoritesView with some given data. Locale defaults to that
of the HelpSet.
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.
FavoritesView
public FavoritesView(HelpSet hs,
String name,
String label,
Locale locale,
Hashtable params)
Constructs an FavoritesView with some given data.
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.
createNavigator
public Component createNavigator(HelpModel model)
create a navigator for a given model.
- createNavigator in interface NavigatorView
model
- The HelpModel to create this navigator with. A null model
is valid.
- The appropriate Component for this view.
getDataAsTree
public FavoritesNode 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.
getMergeType
public String getMergeType()
Get the Index navigators mergeType. Overrides getMergeType in NavigatorView
- getMergeType in interface NavigatorView
parse
public FavoritesNode parse(HelpSet hs,
Locale locale,
TreeItemFactory factory)
Public method for parsing the Favorites in a URL.
It returns a DefaultMutableTreeNode and its children
that correspond to the favoritesItems in the Favorites. The factory is invoked to create
the TreeItems that are included in the DefaultMutableTreeNode as user
data.
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
- a TreeNode that represents the Favorites. Returns null if parsing errors
were encountered.
saveFavorites
public void saveFavorites(FavoritesNode node)
Saves favorites file