javax.help
Class NavigatorView
- Serializable
public abstract class NavigatorView
extends java.lang.Object
implements Serializable
Navigational View information
NavigatorView(HelpSet hs, String name, String label, Locale locale, Hashtable params) - Constructs a Navigator with some given data.
|
static NavigatorView | create(HelpSet hs, String name, String label, Locale locale, String className, Hashtable params) - Creates a NavigatorView for some given information.
|
abstract Component | createNavigator(HelpModel model) - Creates a navigator for a given model.
|
HelpSet | getHelpSet() - Gets the HelpSet for this Navigator view.
|
Map.ID | getImageID() - Returns Map ID of icons passed to this View.
|
String | getLabel() - Gets the locale-dependent name of this View
|
String | getLabel(Locale locale) - Gets the locale-dependent name of this View.
|
Locale | getLocale()
|
String | getMergeType() - Gets merge type of this Navigator view
|
String | getName() - Gets the name of this Navigator view.
|
Hashtable | getParameters() - Gets parameters passed to this View.
|
NavigatorView
protected NavigatorView(HelpSet hs,
String name,
String label,
Locale locale,
Hashtable params)
Constructs a Navigator with some given data. This is protected
so subclasses can use it.
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.
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.
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.
- The desired NavigatorView object.
InvalidNavigatorViewException
- if hs, name,
label, locale, className, or params
are null, or if a valid NavigatorView cannot be constructed from the
parameters.
createNavigator
public abstract Component createNavigator(HelpModel model)
Creates a navigator for a given model. Really a JHelpNavigator right now.
model
- The model for the Navigator.
getHelpSet
public HelpSet getHelpSet()
Gets the HelpSet for this Navigator view.
getImageID
public Map.ID getImageID()
Returns Map ID of icons passed to this View.
- the Map ID of icons passed to this View
getLabel
public String getLabel()
Gets the locale-dependent name of this View
- The locale-dependent name of this view
getLabel
public String getLabel(Locale locale)
Gets the locale-dependent name of this View.
- The locale-dependent name of this view.
getLocale
public Locale getLocale()
getMergeType
public String getMergeType()
Gets merge type of this Navigator view
- The merge type of this Navigator view
getName
public String getName()
Gets the name of this Navigator view.
getParameters
public Hashtable getParameters()
Gets parameters passed to this View.
- The parameters passed to this View.