javax.help

Class HelpSet.DefaultHelpSetFactory

Enclosing Class:
HelpSet
Implemented Interfaces:
javax.help.HelpSetFactory

public static class HelpSet.DefaultHelpSetFactory
extends java.lang.Object
implements javax.help.HelpSetFactory

The default HelpSetFactory that processes HelpSets.

Method Summary

Enumeration
listMessages()
Enumerates all the error messages.
HelpSet
parsingEnded(HelpSet hs)
Parsing has ended.
void
parsingStarted(URL source)
Parsing starts.
void
processDOCTYPE(String root, String publicID, String systemID)
Process a DOCTYPE
void
processHomeID(HelpSet hs, String value)
A HomeID is found.
void
processMapRef(HelpSet hs, Hashtable attributes)
process a <mapref>
void
processPI(HelpSet hs, String target, String data)
Processes a PI
void
processPresentation(HelpSet hs, String name, boolean defaultPresentation, boolean displayViews, boolean displayViewImages, Dimension size, Point location, String title, String imageID, boolean toolbar, Vector helpActions)
void
processSubHelpSet(HelpSet hs, Hashtable attributes)
Called when a sub-HelpSet is found.
void
processTitle(HelpSet hs, String value)
A title is found
void
processView(HelpSet hs, String name, String label, String type, Hashtable viewAttributes, String data, Hashtable dataAttributes, Locale locale)
void
reportMessage(String msg, boolean validParse)
Reports an error message.

Method Details

listMessages

public Enumeration listMessages()
Enumerates all the error messages.
Specified by:
listMessages in interface javax.help.HelpSetFactory

parsingEnded

public HelpSet parsingEnded(HelpSet hs)
Parsing has ended. Last chance to do something to the HelpSet.
Specified by:
parsingEnded in interface javax.help.HelpSetFactory
Parameters:
hs - The HelpSet the parsing ended on. A null hs is valid.

parsingStarted

public void parsingStarted(URL source)
Parsing starts.
Specified by:
parsingStarted in interface javax.help.HelpSetFactory

processDOCTYPE

public void processDOCTYPE(String root,
                           String publicID,
                           String systemID)
Process a DOCTYPE
Specified by:
processDOCTYPE in interface javax.help.HelpSetFactory
Parameters:
publicID - the document. If null or is not valid a parsingError will be generated.

processHomeID

public void processHomeID(HelpSet hs,
                          String value)
A HomeID is found.
Specified by:
processHomeID in interface javax.help.HelpSetFactory

processMapRef

public void processMapRef(HelpSet hs,
                          Hashtable attributes)
process a <mapref>
Specified by:
processMapRef in interface javax.help.HelpSetFactory
Parameters:

processPI

public void processPI(HelpSet hs,
                      String target,
                      String data)
Processes a PI
Specified by:
processPI in interface javax.help.HelpSetFactory

processPresentation

public void processPresentation(HelpSet hs,
                                String name,
                                boolean defaultPresentation,
                                boolean displayViews,
                                boolean displayViewImages,
                                Dimension size,
                                Point location,
                                String title,
                                String imageID,
                                boolean toolbar,
                                Vector helpActions)
Specified by:
processPresentation in interface javax.help.HelpSetFactory

processSubHelpSet

public void processSubHelpSet(HelpSet hs,
                              Hashtable attributes)
Called when a sub-HelpSet is found.
Specified by:
processSubHelpSet in interface javax.help.HelpSetFactory

processTitle

public void processTitle(HelpSet hs,
                         String value)
A title is found
Specified by:
processTitle in interface javax.help.HelpSetFactory

processView

public void processView(HelpSet hs,
                        String name,
                        String label,
                        String type,
                        Hashtable viewAttributes,
                        String data,
                        Hashtable dataAttributes,
                        Locale locale)
Specified by:
processView in interface javax.help.HelpSetFactory

reportMessage

public void reportMessage(String msg,
                          boolean validParse)
Reports an error message.
Specified by:
reportMessage in interface javax.help.HelpSetFactory