|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.help.HelpSet.DefaultHelpSetFactory
The default HelpSetFactory that processes HelpSets.
Nested Class Summary | |
static class |
HelpSetFactory.HelpAction
Internal storage of HelpAction defined in a Presentaion |
Constructor Summary | |
HelpSet.DefaultHelpSetFactory()
|
Method Summary | |
java.util.Enumeration |
listMessages()
Enumerates all the error messages. |
HelpSet |
parsingEnded(HelpSet hs)
Parsing has ended. |
void |
parsingStarted(java.net.URL source)
Parsing starts. |
void |
processDOCTYPE(java.lang.String root,
java.lang.String publicID,
java.lang.String systemID)
Process a DOCTYPE |
void |
processHomeID(HelpSet hs,
java.lang.String value)
A HomeID is found. |
void |
processMapRef(HelpSet hs,
java.util.Hashtable attributes)
process a <mapref> |
void |
processPI(HelpSet hs,
java.lang.String target,
java.lang.String data)
Processes a PI |
void |
processPresentation(HelpSet hs,
java.lang.String name,
boolean defaultPresentation,
boolean displayViews,
boolean displayViewImages,
java.awt.Dimension size,
java.awt.Point location,
java.lang.String title,
java.lang.String imageID,
boolean toolbar,
java.util.Vector helpActions)
Creates a HelpSet.Presentation from the data. |
void |
processSubHelpSet(HelpSet hs,
java.util.Hashtable attributes)
Called when a sub-HelpSet is found. |
void |
processTitle(HelpSet hs,
java.lang.String value)
A title is found |
void |
processView(HelpSet hs,
java.lang.String name,
java.lang.String label,
java.lang.String type,
java.util.Hashtable viewAttributes,
java.lang.String data,
java.util.Hashtable dataAttributes,
java.util.Locale locale)
Creates a NavigatorView from the data. |
void |
reportMessage(java.lang.String msg,
boolean validParse)
Reports an error message. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public HelpSet.DefaultHelpSetFactory()
Method Detail |
public void parsingStarted(java.net.URL source)
parsingStarted
in interface javax.help.HelpSetFactory
public void processDOCTYPE(java.lang.String root, java.lang.String publicID, java.lang.String systemID)
processDOCTYPE
in interface javax.help.HelpSetFactory
publicID
- the document. If null or is not valid a parsingError
will be generated.root
- The root tag of the documentsystemID
- SystemID from the DOCTYPEpublic void processPI(HelpSet hs, java.lang.String target, java.lang.String data)
processPI
in interface javax.help.HelpSetFactory
target
- The target of the PIdata
- A String for the data in the PIpublic void processTitle(HelpSet hs, java.lang.String value)
processTitle
in interface javax.help.HelpSetFactory
hs
- The Helpsetvalue
- The title of the HelpSetpublic void processHomeID(HelpSet hs, java.lang.String value)
processHomeID
in interface javax.help.HelpSetFactory
hs
- The Helpsetvalue
- The home ID for the helpsetpublic void processMapRef(HelpSet hs, java.util.Hashtable attributes)
processMapRef
in interface javax.help.HelpSetFactory
hs
- The HelpSetpublic void processView(HelpSet hs, java.lang.String name, java.lang.String label, java.lang.String type, java.util.Hashtable viewAttributes, java.lang.String data, java.util.Hashtable dataAttributes, java.util.Locale locale)
javax.help.HelpSetFactory
processView
in interface javax.help.HelpSetFactory
hs
- The HelpSetpublic void processPresentation(HelpSet hs, java.lang.String name, boolean defaultPresentation, boolean displayViews, boolean displayViewImages, java.awt.Dimension size, java.awt.Point location, java.lang.String title, java.lang.String imageID, boolean toolbar, java.util.Vector helpActions)
javax.help.HelpSetFactory
processPresentation
in interface javax.help.HelpSetFactory
hs
- The HelpSetname
- Name of the PresentationdisplayViews
- Display the Views in the PresentationdisplayViewImages
- Display the Views Images in the Presentationsize
- Size of the Presentationlocation
- Location of the Presentationtitle
- Title for the presentationtoolbar
- Is there a custom toolbar for the presentationhelpActions
- A Vector of HelpAction(s).public void processSubHelpSet(HelpSet hs, java.util.Hashtable attributes)
processSubHelpSet
in interface javax.help.HelpSetFactory
public void reportMessage(java.lang.String msg, boolean validParse)
reportMessage
in interface javax.help.HelpSetFactory
msg
- The message to report.validParse
- Whether the on-going parse should return a valid object.public java.util.Enumeration listMessages()
listMessages
in interface javax.help.HelpSetFactory
public HelpSet parsingEnded(HelpSet hs)
parsingEnded
in interface javax.help.HelpSetFactory
hs
- The HelpSet the parsing ended on. A null hs is valid.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |