Package javax.help

Class HelpSet.DefaultHelpSetFactory

  • Enclosing class:
    HelpSet
    public static class HelpSet.DefaultHelpSetFactory
extends java.lang.Object
    The default HelpSetFactory that processes HelpSets.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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)  
      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)  
      void reportMessage​(java.lang.String msg, boolean validParse)
      Reports an error message.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • DefaultHelpSetFactory

        public DefaultHelpSetFactory()

    • Method Detail

      • parsingStarted

        public void parsingStarted​(java.net.URL source)
        Parsing starts.

      • processDOCTYPE

        public void processDOCTYPE​(java.lang.String root,
                           java.lang.String publicID,
                           java.lang.String systemID)
        Process a DOCTYPE
        Parameters:
        publicID - the document. If null or is not valid a parsingError will be generated.

      • processPI

        public void processPI​(HelpSet hs,
                      java.lang.String target,
                      java.lang.String data)
        Processes a PI

      • processTitle

        public void processTitle​(HelpSet hs,
                         java.lang.String value)
        A title is found

      • processHomeID

        public void processHomeID​(HelpSet hs,
                          java.lang.String value)
        A HomeID is found.

      • processMapRef

        public void processMapRef​(HelpSet hs,
                          java.util.Hashtable attributes)
        process a <mapref>
        Parameters:
        Spec - to the URL
        Attributes - for the tag

      • processView

        public 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)

      • processPresentation

        public 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)

      • processSubHelpSet

        public void processSubHelpSet​(HelpSet hs,
                              java.util.Hashtable attributes)
        Called when a sub-HelpSet is found.

      • reportMessage

        public void reportMessage​(java.lang.String msg,
                          boolean validParse)
        Reports an error message.

      • listMessages

        public java.util.Enumeration listMessages()
        Enumerates all the error messages.

      • parsingEnded

        public HelpSet parsingEnded​(HelpSet hs)
        Parsing has ended. Last chance to do something to the HelpSet.
        Parameters:
        hs - The HelpSet the parsing ended on. A null hs is valid.