javax.help
public class FavoritesView extends NavigatorView
Modifier and Type | Class and Description |
---|---|
static class |
FavoritesView.DefaultFavoritesFactory
A default TreeItemFactory that can be used to parse Favorites items as used
by this navigator.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
publicIDString
PublicID (known to this XML processor) to the DTD for version 2.0 of the Index
|
Constructor and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
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
|
create, getHelpSet, getImageID, getLabel, getLabel, getLocale, getName, getParameters
public static final java.lang.String publicIDString
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.public java.awt.Component createNavigator(HelpModel model)
createNavigator
in class NavigatorView
model
- The HelpModel to create this navigator with. A null model
is valid.public java.lang.String getMergeType()
getMergeType
in class NavigatorView
public FavoritesNode getDataAsTree()
public FavoritesNode parse(HelpSet hs, java.util.Locale locale, TreeItemFactory factory)
url
- Location of the Favorites. If null, causes null value to be returned.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 FavoritesItemspublic void saveFavorites(FavoritesNode node)
node
- The FavoritesNode