openbook.client

Class SourceCodeBrowser

java.lang.Object

openbook.client.SourceCodeBrowser

public class SourceCodeBrowser
extends Object

Browses source code. The source code URI is resolved with respect to a root URI. The source code is expected to be in HTML format. The actual rendering of the source code can be either through an internal or an external browser.

Author:

Pinaki Poddar

Constructor Summary

Constructors

Constructor and Description
SourceCodeBrowser(String root, boolean useDesktop) Construct a browser.

Method Summary

Modifier and Type	Method and Description
void	addPage(String key, String path)
File	getRootDirectory() Gets the root source directory if the sources are being serverd from a local file system directory.
URI	getRootURI()
SourceCodeViewer	getViewer()
void	showPage(String key, String page) Shows the given page.
void	showPage(String key, URI uri) Shows the given page.

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceCodeBrowser

public SourceCodeBrowser(String root,
                         boolean useDesktop)

Construct a browser.

Parameters:

root - a path to be resolved as an URI to root of source tree.

useDesktop - flags to use external or internal browser.

Method Detail

getRootURI

public URI getRootURI()

getRootDirectory

public File getRootDirectory()

Gets the root source directory if the sources are being serverd from a local file system directory.

showPage

public void showPage(String key,
                     String page)

Shows the given page.

Parameters:

key - key a user visible moniker for the page.

page - the path of the page content w.r.t the root URI of this browser.

addPage

public void addPage(String key,
                    String path)

getViewer

public SourceCodeViewer getViewer()

showPage

public void showPage(String key,
                     URI uri)

Shows the given page.

Parameters:

key - a user visible moniker for the page.

uri - the URI of the page content.