Module org.bzdev.desktop

Package org.bzdev.swing

Interface UrlTocTree

All Superinterfaces:

TocTree

All Known Implementing Classes:

HtmlWithTocPane, UrlTocPane

public interface UrlTocTree
extends TocTree

Interface for Table of Contents whose values are URLs. The methods allows the TOC to be specified via XML files accessed via input streams or URLs.

Method Summary

Modifier and Type	Method	Description
void	addEntry(String title, String url)	Add an entry.
void	addEntry(String title, URL url)	Add an entry.
void	setToc(InputStream is, boolean expand, boolean validating)	Set the table of contents from a URL represented as a String.
void	setToc(String url, boolean expand, boolean validating)	Set the table of contents from a URL represented as a String.
void	setToc(URL url, boolean expand, boolean validating)	Set the table of contents from a URL.

Methods inherited from interface org.bzdev.swing.TocTree

addActionListener, addEntry, clearSelection, clearToc, collapseRow, entriesCompleted, entriesCompleted, expandRow, isCollapsed, isExpanded, nextLevel, prevLevel, removeActionListener, setSelectionWithAction

Method Details

addEntry

void addEntry(String title,
 String url)
       throws MalformedURLException,
IllegalStateException

Add an entry. This will define a new TOC entry.

Parameters:

title - A string naming the entry.

url - The URL to associate with the entry;

Throws:

MalformedURLException - if the url is malformed

IllegalStateException - if this method was called after a call to entriesCompleted.

See Also:

• ObjTocPane.entriesCompleted()
• ObjTocPane.nextLevel()
• ObjTocPane.prevLevel()

addEntry

void addEntry(String title,
 URL url)
       throws MalformedURLException,
IllegalStateException

Add an entry. This will define a new TOC entry.

Parameters:

title - A string naming the entry.

url - The URL to associate with the entry;

Throws:

IllegalStateException - if this method was called after a call to entriesCompleted.

MalformedURLException - if the url is malformed

See Also:

• ObjTocPane.entriesCompleted()
• ObjTocPane.nextLevel()
• ObjTocPane.prevLevel()

setToc

void setToc(URL url,
 boolean expand,
 boolean validating)
     throws FactoryConfigurationError,
SAXException,
IOException,
ParserConfigurationException,
MalformedURLException

Set the table of contents from a URL. This method should be used as as an alternative to addEntry, nextLevel, prevLevel and entriesCompleted

Parameters:

url - the URL containing the table of contents.

expand - True if the nodes should be expanded; false otherwise

validating - True if the parser is validating; false otherwise

Throws:

FactoryConfigurationError - the XML parser cannot be configured

SAXException - the XML data in the input stream in not well formed or is not valid.

IOException - an IO error was seen

ParserConfigurationException - the XML parser cannot be configured

MalformedURLException - if the url is malformed

setToc

void setToc(String url,
 boolean expand,
 boolean validating)
     throws FactoryConfigurationError,
SAXException,
IOException,
ParserConfigurationException

Set the table of contents from a URL represented as a String. This method should be used as as an alternative to addEntry, nextLevel, prevLevel and entriesCompleted

Parameters:

url - the URL containing the table of contents.

expand - True if the nodes should be expanded; false otherwise

validating - True if the parser is validating; false otherwise

Throws:

FactoryConfigurationError - the XML parser cannot be configured

SAXException - the XML data in the input stream in not well formed or is not valid.

IOException - an IO error was seen

ParserConfigurationException - the XML parser cannot be configured

MalformedURLException - the string representing the URL was illformed.

setToc

void setToc(InputStream is,
 boolean expand,
 boolean validating)
     throws FactoryConfigurationError,
SAXException,
IOException,
ParserConfigurationException

Set the table of contents from a URL represented as a String. This method should be used as as an alternative to addEntry, nextLevel, prevLevel and entriesCompleted

Parameters:

is - the Inputstream containing the table of contents.

expand - True if the nodes should be expanded; false otherwise

validating - True if the parser is validating; false otherwise

Throws:

FactoryConfigurationError - the XML parser cannot be configured

SAXException - the XML data in the input stream in not well formed or is not valid.

IOException - an IO error was seen

ParserConfigurationException - the XML parser cannot be configured

MalformedURLException - the string representing the URL was illformed.