Logo Search packages:      
Sourcecode: javahelp2 version File versions  Download package

javax::help::HelpSet Class Reference

Inherits java::io::Serializable.

List of all members.

Detailed Description

A HelpSet is a collection of help information consisting of a HelpSet file, table of contents (TOC), index, topic files, and Map file. The HelpSet file is the portal to the HelpSet.

Roger D. Brinkley

Eduardo Pelegri-Llopart

Stepan Marek

1.108 10/30/06

Definition at line 65 of file HelpSet.java.

Public Member Functions

void add (HelpSet hs)
void addHelpSetListener (HelpSetListener l)
boolean contains (HelpSet hs)
HelpBroker createHelpBroker (String presentationName)
HelpBroker createHelpBroker ()
Map getCombinedMap ()
HelpSet.Presentation getDefaultPresentation ()
Enumeration getHelpSets ()
URL getHelpSetURL ()
ID getHomeID ()
Object getKeyData (Object context, String key)
ClassLoader getLoader ()
Locale getLocale ()
Map getLocalMap ()
NavigatorView getNavigatorView (String name)
NavigatorView[] getNavigatorViews ()
HelpSet.Presentation getPresentation (String name)
HelpSet.Presentation[] getPresentations ()
String getTitle ()
 HelpSet (ClassLoader loader, URL helpset) throws HelpSetException
 HelpSet ()
 HelpSet (ClassLoader loader)
void parseInto (URL url, HelpSetFactory factory)
boolean remove (HelpSet hs)
void removeHelpSetListener (HelpSetListener l)
void setHomeID (String homeID)
void setKeyData (Object context, String key, Object data)
void setLocalMap (Map map)
void setTitle (String title)
String toString ()

Static Public Member Functions

static URL findHelpSet (ClassLoader cl, String name)
static URL findHelpSet (ClassLoader cl, String name, Locale locale)
static URL findHelpSet (ClassLoader cl, String shortName, String extension, Locale locale)
static HelpSet parse (URL url, ClassLoader loader, HelpSetFactory factory)

Static Public Attributes

static final String helpBrokerClass = "helpBroker/class"
static final String helpBrokerLoader = "helpBroker/loader"
static final Object implRegistry
static final Object kitLoaderRegistry
static final Object kitTypeRegistry
static final String publicIDString
static final String publicIDString_V2

Protected Member Functions

void addPresentation (HelpSet.Presentation presentation, boolean defaultPres)
void addSubHelpSet (HelpSet hs)
void addView (NavigatorView view)
void fireHelpSetAdded (Object source, HelpSet helpset)
void fireHelpSetRemoved (Object source, HelpSet helpset)

Protected Attributes

EventListenerList listenerList = new EventListenerList()

Static Package Functions

 [static initializer]

Private Member Functions

void setLocale (Locale l)

Static Private Member Functions

static void debug (String str)
static void setDefaultKeyData (Object context, String key, Object data)

Private Attributes

PropertyChangeSupport changes = new PropertyChangeSupport(this)
TryMap combinedMap
HelpSet.Presentation defaultPresentation = null
URL helpset
Vector helpsets
String homeID
transient ClassLoader loader
Locale locale = Locale.getDefault()
Hashtable localKeys = new Hashtable()
Map map
Vector presentations = new Vector()
Vector subHelpSets = new Vector()
String title
Vector views = new Vector()

Static Private Attributes

static final boolean debug = false
static HelpBroker defaultHelpBroker = null
static Hashtable defaultKeys
static String errorMsg = null


class  DefaultHelpSetFactory
class  HelpSetParser
class  Presentation

The documentation for this class was generated from the following file:

Generated by  Doxygen 1.6.0   Back to index