Package javax.help
Class NavigatorView
java.lang.Object
javax.help.NavigatorView
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
FavoritesView
,IndexView
,SearchView
,TOCView
Navigational View information
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic NavigatorView
Creates a NavigatorView for some given information.abstract Component
createNavigator
(HelpModel model) Creates a navigator for a given model.Gets the HelpSet for this Navigator view.Returns Map ID of icons passed to this View.getLabel()
Gets the locale-dependent name of this ViewGets the locale-dependent name of this View.Gets merge type of this Navigator viewgetName()
Gets the name of this Navigator view.Gets parameters passed to this View.
-
Constructor Details
-
NavigatorView
Constructs a Navigator with some given data. This is protected so subclasses can use it.- Parameters:
hs
- The HelpSet that provides context information.name
- The name of the View.label
- The label (to show the user) of the View.locale
- The default locale to interpret the data in this View.params
- A hashtable that provides different key/values for this type.
-
-
Method Details
-
create
public static NavigatorView create(HelpSet hs, String name, String label, Locale locale, String className, Hashtable params) throws InvalidNavigatorViewException Creates a NavigatorView for some given information. The type is used to determine a NavigatorView class within the ClassLoader.- Parameters:
hs
- The HelpSet that provides context information.name
- The name of the View.label
- The label (to show the user) of the View.className
- The type for the View (its class name).params
- A hashtable that provides different key/values for this type.- Returns:
- The desired NavigatorView object.
- Throws:
InvalidNavigatorViewException
- if hs, name, label, locale, className, or params are null, or if a valid NavigatorView cannot be constructed from the parameters.
-
getHelpSet
Gets the HelpSet for this Navigator view.- Returns:
- the HelpSet
-
getName
Gets the name of this Navigator view.- Returns:
- the Name of the view
-
getLabel
Gets the locale-dependent name of this View.- Returns:
- The locale-dependent name of this view.
-
getLabel
Gets the locale-dependent name of this View- Returns:
- The locale-dependent name of this view
-
getLocale
- Returns:
- The locale.
-
getParameters
Gets parameters passed to this View.- Returns:
- The parameters passed to this View.
-
getMergeType
Gets merge type of this Navigator view- Returns:
- The merge type of this Navigator view
-
getImageID
Returns Map ID of icons passed to this View.- Returns:
- the Map ID of icons passed to this View
-