|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.help.NavigatorView
Navigational View information
| Method Summary | |
static NavigatorView |
create(HelpSet hs,
java.lang.String name,
java.lang.String label,
java.util.Locale locale,
java.lang.String className,
java.util.Hashtable params)
Creates a NavigatorView for some given information. |
abstract java.awt.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. |
java.lang.String |
getLabel()
Gets the locale-dependent name of this View |
java.lang.String |
getLabel(java.util.Locale locale)
Gets the locale-dependent name of this View. |
java.util.Locale |
getLocale()
|
java.lang.String |
getMergeType()
Gets merge type of this Navigator view |
java.lang.String |
getName()
Gets the name of this Navigator view. |
java.util.Hashtable |
getParameters()
Gets parameters passed to this View. |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method Detail |
public static NavigatorView create(HelpSet hs,
java.lang.String name,
java.lang.String label,
java.util.Locale locale,
java.lang.String className,
java.util.Hashtable params)
throws InvalidNavigatorViewException
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.
InvalidNavigatorViewException - if hs, name,
label, locale, className, or params
are null, or if a valid NavigatorView cannot be constructed from the
parameters.public abstract java.awt.Component createNavigator(HelpModel model)
model - The model for the Navigator.public HelpSet getHelpSet()
public java.lang.String getName()
public java.lang.String getLabel(java.util.Locale locale)
public java.lang.String getLabel()
public java.util.Locale getLocale()
public java.util.Hashtable getParameters()
public java.lang.String getMergeType()
public Map.ID getImageID()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||