ch.aplu.util

Class HtmlPane

java.lang.Object

ch.aplu.util.HtmlPane

All Implemented Interfaces:

LinkListener, java.util.EventListener

public class HtmlPane
extends java.lang.Object
implements LinkListener

Simple graphics window similar to GPanel to be used for displaying HTML formatted text. Only a subset of HTML is supported. Image loading from image tag is supported as follows:
insertUrl(): subdir/pict.gif: loading from internet, subdir of html
http://...: loading from internet, absolute URL
insertFile(): subdir/pict.gif: loading from subdir of html on disk
file://path: fully qualified path to disk image file
http://.,. . loading from internet, absolute URL
insertResource: subdir/pict.gif: loading from subdir of html from JAR archive
http://.,. : loading from internet, absolute URL
insertText(): http://...: loading from internet, absolute URL
file://path: fully qualified path to disk image file

Constructor Summary

Constructors

Constructor and Description
HtmlPane() Construct a HtmlPane with default size and position.
HtmlPane(Position position, Size size) Construct a HtmlPane with given position and size.

Method Summary

Methods

Modifier and Type	Method and Description
void	addExitListener(ExitListener exitListener) Register an ExitListener to get a notification when the close button is clicked.
void	addLinkListener(LinkListener listener) Registers a LinkListener to get events when clicked on a hyperlink.
static void	browse(java.lang.String url) Calls the standard system browser
void	clear() Erase all text.
void	dispose()
static void	disposeAll() Release all used system resources of all currently openend HtmlPane windows.
static int	getInstanceCount() Returns the number of HtmlPane instances.
void	hide() Hide the console window.
void	insertFile(java.lang.String filename) Insert HTML formatted text from the given file.
void	insertResource(java.lang.String filename) Insert HTML formatted text from the given file in a JAR resource.
void	insertText(java.lang.String text) Insert HTML formatted text.
void	insertUrl(java.lang.String htmlUrl) Insert HTML from given URL.
boolean	isDisposed() Return true, if the HtmlPane window was disposed.
void	linkClicked(java.lang.String url) Invoked when a link is clicked in a HtmlPane.
void	setTitle(java.lang.String title) Show the given title in the title bar.

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlPane

public HtmlPane()

Construct a HtmlPane with default size and position.

HtmlPane

public HtmlPane(Position position,
        Size size)

Construct a HtmlPane with given position and size. The default position and size is selected from packagedoc.properties.

Parameters:

position - a reference to a Position object

size - a reference to a Size object

Method Detail

insertText

public void insertText(java.lang.String text)

Insert HTML formatted text. The old text is erased. A relative path in html images tags are assumed to start from the current working directory.

Parameters:

text - the html text to show

insertResource

public void insertResource(java.lang.String filename)

Insert HTML formatted text from the given file in a JAR resource. The old text is erased.

Parameters:

filename - the path of the JAR resource text file relative to the application root

insertFile

public void insertFile(java.lang.String filename)

Insert HTML formatted text from the given file. The old text is erased.

Parameters:

filename - the qualified or relative path to the html text file

insertUrl

public void insertUrl(java.lang.String htmlUrl)

Insert HTML from given URL. The old text is erased.

Parameters:

htmlUrl - an URL string like http://www.aplu.ch/index.html" to the html text file

setTitle

public void setTitle(java.lang.String title)

Show the given title in the title bar. The default title is selected from packagedoc.properties.

Parameters:

title - the new title to show

clear

public void clear()

Erase all text.

addExitListener

public void addExitListener(ExitListener exitListener)

Register an ExitListener to get a notification when the close button is clicked. After registering the automatic termination of the application is disabled. To terminate the application, System.exit() should be called.

Parameters:

exitListener - the ExitListener to register

hide

public void hide()

Hide the console window.

isDisposed

public boolean isDisposed()

Return true, if the HtmlPane window was disposed.

browse

public static void browse(java.lang.String url)

Calls the standard system browser

Parameters:

url - the URL of the WEB site, prefixed with http:// or not

addLinkListener

public void addLinkListener(LinkListener listener)

Registers a LinkListener to get events when clicked on a hyperlink.

Parameters:

listener - the LinkListener to register

linkClicked

public void linkClicked(java.lang.String url)

Description copied from interface: LinkListener

Invoked when a link is clicked in a HtmlPane.

Specified by:

linkClicked in interface LinkListener

dispose

public void dispose()

getInstanceCount

public static int getInstanceCount()

Returns the number of HtmlPane instances.

Returns:

current number of HtmlPane windows

disposeAll

public static void disposeAll()

Release all used system resources of all currently openend HtmlPane windows.