javax.help

Class IndexView.DefaultIndexFactory

Enclosing Class:
IndexView
Implemented Interfaces:
TreeItemFactory

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

TreeItem
createItem()
Creates a default IndexItem.
TreeItem
createItem(String tagName, Hashtable atts, HelpSet hs, Locale locale)
Creates an IndexItem with the given data.
Enumeration
listMessages()
Lists all the error messages.
DefaultMutableTreeNode
parsingEnded(DefaultMutableTreeNode node)
Parsing has ended.
void
parsingStarted(URL source)
Parsing has started
void
processDOCTYPE(String root, String publicID, String systemID)
Process a DOCTYPE
void
processPI(HelpSet hs, String target, String data)
We have found a PI; ignore it
void
reportMessage(String msg, boolean validParse)
Reports an error message.

Method Details

createItem

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

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.

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.

parsingStarted

public void parsingStarted(URL source)
Parsing has started
Specified by:
parsingStarted in interface TreeItemFactory

processDOCTYPE

public void processDOCTYPE(String root,
                           String publicID,
                           String systemID)
Process a DOCTYPE
Specified by:
processDOCTYPE in interface TreeItemFactory

processPI

public void processPI(HelpSet hs,
                      String target,
                      String data)
We have found a PI; ignore it
Specified by:
processPI in interface TreeItemFactory

reportMessage

public void reportMessage(String msg,
                          boolean validParse)
Reports an error message.
Specified by:
reportMessage in interface TreeItemFactory