Package javax.help

Class IndexView.DefaultIndexFactory

  • All Implemented Interfaces:
    TreeItemFactory
    Enclosing class:
    IndexView
    public static class IndexView.DefaultIndexFactory
extends java.lang.Object
implements TreeItemFactory
    A default TreeItemFactory that can be used to parse TOC items as used by this navigator.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      TreeItem createItem()
      Creates a default IndexItem.
      TreeItem createItem​(java.lang.String tagName, java.util.Hashtable atts, HelpSet hs, java.util.Locale locale)
      Creates an IndexItem with the given data.
      java.util.Enumeration listMessages()
      Lists all the error messages.
      javax.swing.tree.DefaultMutableTreeNode parsingEnded​(javax.swing.tree.DefaultMutableTreeNode node)
      Parsing has ended.
      void parsingStarted​(java.net.URL source)
      Parsing has started
      void processDOCTYPE​(java.lang.String root, java.lang.String publicID, java.lang.String systemID)
      Process a DOCTYPE
      void processPI​(HelpSet hs, java.lang.String target, java.lang.String data)
      We have found a PI; ignore it
      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

      • DefaultIndexFactory

        public DefaultIndexFactory()

    • Method Detail

      • parsingStarted

        public void parsingStarted​(java.net.URL source)
        Parsing has started
        Specified by:
        parsingStarted in interface TreeItemFactory
        Parameters:
        source - The URL of the document being parsed.

      • processDOCTYPE

        public void processDOCTYPE​(java.lang.String root,
                           java.lang.String publicID,
                           java.lang.String systemID)
        Process a DOCTYPE
        Specified by:
        processDOCTYPE in interface TreeItemFactory
        Parameters:
        root - The root tag of the document.
        publicID - PublicID from the DOCTYPE.
        systemID - SystemID from the DOCTYPE.

      • processPI

        public void processPI​(HelpSet hs,
                      java.lang.String target,
                      java.lang.String data)
        We have found a PI; ignore it
        Specified by:
        processPI in interface TreeItemFactory
        target - The target of the PI.
        data - A String for the data in the PI.

      • createItem

        public TreeItem createItem​(java.lang.String tagName,
                           java.util.Hashtable atts,
                           HelpSet hs,
                           java.util.Locale locale)
        Creates an IndexItem with the given data.
        Specified by:
        createItem in interface TreeItemFactory
        Parameters:
        tagName - The index type to create. Valid types are "indexitem". Null or invalid types throw an IllegalArgumentException.
        atts - Attributes of the Item. Valid attributes are "target" and "text". A null atts is valid and means no attributes.
        hs - The HelpSet this item was created under.
        locale - Locale of this item. A null locale is valid.
        Returns:
        A TreeItem.
        Throws:
        java.lang.IllegalArgumentException - if tagname is null or invalid.

      • reportMessage

        public void reportMessage​(java.lang.String msg,
                          boolean validParse)
        Reports an error message.
        Specified by:
        reportMessage in interface TreeItemFactory
        Parameters:
        msg - The message to report.
        validParse - Whether the result of the parse is still valid.

      • listMessages

        public java.util.Enumeration listMessages()
        Lists all the error messages.
        Specified by:
        listMessages in interface TreeItemFactory

      • parsingEnded

        public javax.swing.tree.DefaultMutableTreeNode parsingEnded​(javax.swing.tree.DefaultMutableTreeNode node)
        Parsing has ended. The last chance to do something to the node
        Specified by:
        parsingEnded in interface TreeItemFactory
        Parameters:
        node - The DefaultMutableTreeNode that has been built during the the parsing. If node is null or there were parsing errors a null is returned.