java.io.Serializable
public class HelpSet
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Class | Description |
---|---|---|
static class |
HelpSet.DefaultHelpSetFactory |
The default HelpSetFactory that processes HelpSets.
|
static class |
HelpSet.Presentation |
HelpSet Presentation class.
|
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
helpBrokerClass |
|
static java.lang.String |
helpBrokerLoader |
|
static java.lang.Object |
implRegistry |
Information for implementation customization.
|
static java.lang.Object |
kitLoaderRegistry |
|
static java.lang.Object |
kitTypeRegistry |
HelpSet context information.
|
protected EventListenerList |
listenerList |
|
static java.lang.String |
publicIDString |
PublicID (known to this XML processor) to the DTD for version 1.0 of the HelpSet
|
static java.lang.String |
publicIDString_V2 |
PublicID (known to this XML processor) to the DTD for version 2.0 of the HelpSet
|
Constructor | Description |
---|---|
HelpSet() |
Creates an empty HelpSet.
|
HelpSet(java.lang.ClassLoader loader) |
Creates an empty HelpSet that one can parse into.
|
HelpSet(java.lang.ClassLoader loader,
java.net.URL helpset) |
Creates a HelpSet.
|
Modifier and Type | Method | Description |
---|---|---|
void |
add(HelpSet hs) |
Adds a HelpSet, HelpSetEvents are generated.
|
void |
addHelpSetListener(HelpSetListener l) |
Adds a listener for the HelpSetEvent posted after the model has
changed.
|
protected void |
addPresentation(HelpSet.Presentation presentation,
boolean defaultPres) |
Adds a HelpSet.Presentation to the current list.
|
protected void |
addSubHelpSet(HelpSet hs) |
Adds a SubHelpSet to the current list.
|
protected void |
addView(NavigatorView view) |
Adds a NavigatorView to the current list.
|
boolean |
contains(HelpSet hs) |
Determines if a HelpSet is a sub-HelpSet of this object.
|
HelpBroker |
createHelpBroker() |
Creates a presentation object for this HelpSet.
|
HelpBroker |
createHelpBroker(java.lang.String presentationName) |
Creates a presentation object for this HelpSet.
|
static java.net.URL |
findHelpSet(java.lang.ClassLoader cl,
java.lang.String name) |
As above but default on locale to Locale.getDefault()
|
static java.net.URL |
findHelpSet(java.lang.ClassLoader cl,
java.lang.String shortName,
java.lang.String extension,
java.util.Locale locale) |
Locates a HelpSet file and return its URL.
|
static java.net.URL |
findHelpSet(java.lang.ClassLoader cl,
java.lang.String name,
java.util.Locale locale) |
Locates a HelpSet file and return its URL.
|
protected void |
fireHelpSetAdded(java.lang.Object source,
HelpSet helpset) |
Fires a helpSetAdded event.
|
protected void |
fireHelpSetRemoved(java.lang.Object source,
HelpSet helpset) |
Fires a helpSetRemoved event.
|
Map |
getCombinedMap() |
The map for this HelpSet.
|
HelpSet.Presentation |
getDefaultPresentation() |
|
java.util.Enumeration |
getHelpSets() |
Enumerates all the HelpSets that have been added to this one.
|
java.net.URL |
getHelpSetURL() |
The URL that is the base for this HelpSet.
|
Map.ID |
getHomeID() |
Returns
the ID to visit when the user makes a "go home" gesture.
|
java.lang.Object |
getKeyData(java.lang.Object context,
java.lang.String key) |
Gets some Data for a Key in a given context.
|
java.lang.ClassLoader |
getLoader() |
A classloader to use when locating classes.
|
java.util.Locale |
getLocale() |
Gets the locale for this HelpSet.
|
Map |
getLocalMap() |
Get the local (i.e. non-recursive) Map for this HelpSet.
|
NavigatorView |
getNavigatorView(java.lang.String name) |
Gets the NavigatorView with a specific name.
|
NavigatorView[] |
getNavigatorViews() |
NavigatorView describes the navigator views that are requested
by this HelpSet.
|
HelpSet.Presentation |
getPresentation(java.lang.String name) |
Gets the HelpSet.Presentation with a specific name.
|
HelpSet.Presentation[] |
getPresentations() |
HelpSet.Presentation describes the presentations that are defined
by this HelpSet.
|
java.lang.String |
getTitle() |
Gets the title of this HelpSet.
|
static HelpSet |
parse(java.net.URL url,
java.lang.ClassLoader loader,
javax.help.HelpSetFactory factory) |
Parsed a HelpSet file.
|
void |
parseInto(java.net.URL url,
javax.help.HelpSetFactory factory) |
Parses into this HelpSet.
|
boolean |
remove(HelpSet hs) |
Removes a HelpSet from this HelpSet; HelpSetEvents are generated
Return True if it is found, otherwise false.
|
void |
removeHelpSetListener(HelpSetListener l) |
Removes a listener previously added with addHelpSetListener
|
void |
setHomeID(java.lang.String homeID) |
Sets the Home ID for a HelpSet.
|
void |
setKeyData(java.lang.Object context,
java.lang.String key,
java.lang.Object data) |
Sets some local KeyData on a given context.
|
void |
setLocalMap(Map map) |
Set the Map for this HelpSet.
|
void |
setTitle(java.lang.String title) |
Sest the title for this HelpSet.
|
java.lang.String |
toString() |
Prints Name for this HelpSet.
|
protected EventListenerList listenerList
public static final java.lang.String publicIDString
public static final java.lang.String publicIDString_V2
public static final java.lang.Object implRegistry
public static final java.lang.String helpBrokerClass
public static final java.lang.String helpBrokerLoader
public static final java.lang.Object kitTypeRegistry
public static final java.lang.Object kitLoaderRegistry
public HelpSet(java.lang.ClassLoader loader)
loader
- The ClassLoader to use. If loader is null, the default
ClassLoader is used.public HelpSet()
public HelpSet(java.lang.ClassLoader loader, java.net.URL helpset) throws HelpSetException
loader
- The class loader to use to locate any classes
required by the navigators in the Helpset
If loader is null, the default ClassLoader is used.helpset
- The URL to the HelpSet "file"HelpSetException
- if there are problems parsing the helpsetpublic static java.net.URL findHelpSet(java.lang.ClassLoader cl, java.lang.String shortName, java.lang.String extension, java.util.Locale locale)
cl
- The classloader to use when searching for the resource
with the appropriate name. If cl is null the default
ClassLoader is used.shortName
- The shortname of the resource.extension
- The extension of the resource.locale
- The desired LocaleHelpUtilities
public static java.net.URL findHelpSet(java.lang.ClassLoader cl, java.lang.String name, java.util.Locale locale)
cl
- The classloader to use. If cl is null the default
ClassLoader is used.name
- The name of the resource.locale
- The desired locale.public static java.net.URL findHelpSet(java.lang.ClassLoader cl, java.lang.String name)
cl
- The ClassLoader to use. If cl is null the default
ClassLoader is used.name
- The name of the resource.public HelpBroker createHelpBroker()
createHelpBroker(java.lang.String)
public HelpBroker createHelpBroker(java.lang.String presentationName)
presenationName
- A presentation name defined in the HelpSet
that will dictate the presentation.createHelpBroker()
public void add(HelpSet hs)
hs
- The HelpSet to add.public boolean remove(HelpSet hs)
hs
- The HelpSet to remove.public java.util.Enumeration getHelpSets()
public boolean contains(HelpSet hs)
hs
- The HelpSet to checkpublic void addHelpSetListener(HelpSetListener l)
l
- - The listener to add.java.lang.IllegalArgumentException
- if l is null.public void removeHelpSetListener(HelpSetListener l)
l
- - The listener to remove.java.lang.IllegalArgumentException
- if l is null.protected void fireHelpSetAdded(java.lang.Object source, HelpSet helpset)
protected void fireHelpSetRemoved(java.lang.Object source, HelpSet helpset)
public java.lang.String getTitle()
public void setTitle(java.lang.String title)
title
- The title to set.public java.util.Locale getLocale()
public Map.ID getHomeID()
public void setHomeID(java.lang.String homeID)
The
- ID (in the Map) that identifies the default topic for this HelpSet. Null is valid homeID.public Map getCombinedMap()
public Map getLocalMap()
public void setLocalMap(Map map)
The
- Map object that associates ID->URL. A null map is a valid.public java.net.URL getHelpSetURL()
public java.lang.ClassLoader getLoader()
public NavigatorView[] getNavigatorViews()
public NavigatorView getNavigatorView(java.lang.String name)
The
- name of the desired navigator view.public HelpSet.Presentation[] getPresentations()
public HelpSet.Presentation getPresentation(java.lang.String name)
The
- name of the desired HelpSet.Presentation.public HelpSet.Presentation getDefaultPresentation()
public java.lang.String toString()
toString
in class java.lang.Object
public static HelpSet parse(java.net.URL url, java.lang.ClassLoader loader, javax.help.HelpSetFactory factory)
public void parseInto(java.net.URL url, javax.help.HelpSetFactory factory)
protected void addView(NavigatorView view)
protected void addSubHelpSet(HelpSet hs)
protected void addPresentation(HelpSet.Presentation presentation, boolean defaultPres)
public java.lang.Object getKeyData(java.lang.Object context, java.lang.String key)
public void setKeyData(java.lang.Object context, java.lang.String key, java.lang.Object data)