Module jEdit

Package org.gjt.sp.jedit.help

Class HelpTOCLoader

java.lang.Object

org.gjt.sp.jedit.help.HelpTOCLoader

public class HelpTOCLoader
extends Object

Help table-of-contents loader.

Code for loading and constructing the table of contents (TOC). Doesn't refresh when plugins are (un)loaded: you'll have to call createTOC() again yourself.

Don't keep HelpTOCLoader instances between loads: use it and forget it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HelpTOCLoader.HelpNode	a TOC item: href and title.

Constructor Summary

Constructors

Constructor	Description
HelpTOCLoader(Map<String,DefaultMutableTreeNode> nodes, String baseURL)

Method Summary

Modifier and Type	Method	Description
DefaultMutableTreeNode	createTOC()	Load the table of contents.

Methods inherited from class java.lang.Object

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

Constructor Details

HelpTOCLoader

public HelpTOCLoader(Map<String,DefaultMutableTreeNode> nodes,
 String baseURL)

Method Details

createTOC

public DefaultMutableTreeNode createTOC()

Load the table of contents. Performs synchronous IO, so you don't want to call it from the GUI thread.

Returns:

the TOC tree model as a DefaultMutableTreeNode. User objects are HelpTOCLoader.HelpNode instances.