Package javax.help

Interface TreeItemFactory

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      TreeItem createItem()
      Creates a default TreeItem.
      TreeItem createItem​(java.lang.String tagName, java.util.Hashtable attributes, HelpSet hs, java.util.Locale locale)
      Creates a TreeItem from the given data.
      java.util.Enumeration listMessages()
      Lists all the error messages.
      javax.swing.tree.DefaultMutableTreeNode parsingEnded​(javax.swing.tree.DefaultMutableTreeNode node)
      Ends parsing.
      void parsingStarted​(java.net.URL source)
      Starts parsing.
      void processDOCTYPE​(java.lang.String root, java.lang.String publicID, java.lang.String systemID)
      Processes a DOCTYPE.
      void processPI​(HelpSet hs, java.lang.String target, java.lang.String data)
      A Processing Instruction.
      void reportMessage​(java.lang.String msg, boolean validParse)
      Reports a parsing error.
    • Method Detail

      • parsingStarted

        void parsingStarted​(java.net.URL source)
        Starts parsing.
        Parameters:
        source - The URL of the document being parsed.
      • processDOCTYPE

        void processDOCTYPE​(java.lang.String root,
                            java.lang.String publicID,
                            java.lang.String systemID)
        Processes a DOCTYPE.
        Parameters:
        root - The root tag of the document.
        publicID - PublicID from the DOCTYPE.
        systemID - SystemID from the DOCTYPE.
      • processPI

        void processPI​(HelpSet hs,
                       java.lang.String target,
                       java.lang.String data)
        A Processing Instruction.
        Parameters:
        target - The target of the PI.
        data - A String for the data in the PI.
      • createItem

        TreeItem createItem​(java.lang.String tagName,
                            java.util.Hashtable attributes,
                            HelpSet hs,
                            java.util.Locale locale)
        Creates a TreeItem from the given data.
        Parameters:
        tagName - The name of the tag (for example, treeItem, or tocItem)
        attributes - A hashtable with all the attributes. Null is a valid value.
        hs - A HelpSet that provides context.
        lang - The locale.
        Returns:
        A TreeItem.
      • createItem

        TreeItem createItem()
        Creates a default TreeItem.
        Returns:
        A TreeItem
      • reportMessage

        void reportMessage​(java.lang.String msg,
                           boolean validParse)
        Reports a parsing error.
        Parameters:
        msg - The message to report.
        validParse - Whether the result of the parse is still valid.
      • listMessages

        java.util.Enumeration listMessages()
        Lists all the error messages.
      • parsingEnded

        javax.swing.tree.DefaultMutableTreeNode parsingEnded​(javax.swing.tree.DefaultMutableTreeNode node)
        Ends parsing. Last chance to do something to the node. Return null to be sure the result is discarded.