Package javax.help

Class IndexView.DefaultIndexFactory

java.lang.Object
javax.help.IndexView.DefaultIndexFactory
All Implemented Interfaces:
TreeItemFactory
Enclosing class:
IndexView

public static class IndexView.DefaultIndexFactory extends Object implements TreeItemFactory
A default TreeItemFactory that can be used to parse TOC items as used by this navigator.
  • Constructor Details

    • DefaultIndexFactory

      public DefaultIndexFactory()
  • Method Details

    • parsingStarted

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

      public void processDOCTYPE(String root, String publicID, 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, String target, 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(String tagName, Hashtable atts, HelpSet hs, 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:
      IllegalArgumentException - if tagname is null or invalid.
    • createItem

      public TreeItem createItem()
      Creates a default IndexItem.
      Specified by:
      createItem in interface TreeItemFactory
      Returns:
      A TreeItem
    • reportMessage

      public void reportMessage(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 Enumeration listMessages()
      Lists all the error messages.
      Specified by:
      listMessages in interface TreeItemFactory
    • parsingEnded

      public DefaultMutableTreeNode parsingEnded(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.