Hi Brow Bean

Incomplete Draft

Page Contents	Class at a Glance  Class Description  Properties  Methods  Events  Supporting Classes
See also	Bean Information  Using in the BDK Beanbox  Sample code  HiDemo example

Purpose

displayPage - the page the browser should display or is displaying
displayTarget - the target for the next browser displayPage

HiEvent displayPage - a display page request

Creation

Either: Brow browser = new Brow()

Or: Brow browser = new Brow("initialDisplayPage.html")

The Brow bean will typically be used as a part of a help system for a Java application. Brow will therefore usually need to be accompanied by the HelpIndex bean

The Developer usage instructions show how the HelpIndex bean could be used in a Help pane or Help Dialog, and how to provide Contents Synchronisation. Guidance on Context-sensitive Help systems is given.

displayPage() - process a HiEvent message.

Overview

The Brow bean is a simple HTML browser.

Introspection

A BeanInfo class, BrowBeanInfo, explicitly provides information for properties, events, and methods.
Customization
None provided.
Example Use
Please see the examples page.

---

Properties

Type	Name		Description		Default
Color	background	[bound]	Background colour	(rw)	white
String	displayPage	[bound]	URL String of page to display.	(rw)
String	displayTarget	[bound]	Target of page to display.	(rw)
Font	font	[bound]	Font	(rw)	Dialog, 12 pt
Color	foreground	[bound]	Foreground colour	(rw)	black

---

Methods

The standard getXXX(), setXXX() or boolean isXXX() property access routines are NOT listed here.

instantiation	Brow()
	Brow(String initialPageURL)
control	displayPage(HiEvent hie)	Display the given page in the given target
	rebuild()	requests that the Brow screen be rebuilt
adding/removing listeners	addPropertyChangeListener()	add a listener for post-notification of changes in a bound property
	removePropertyChangeListener()	remove a listener for post-notification of changes in a bound property
	addHiListener()	add a listener for Hi display page events
	removeHiListener()	remove a listener for Hi display page events

---

Events

As Source
PropertyChangeEvents events are post-notifications of a property change (bound).

HiEvent objects are sent to every registered HiListener registered using addHiListener().
A HiEvent indicates that HelpIndex is requesting that a page be displayed in a target frame.

EventListener Interfaces:	PropertyChangeListener HiListener
Event Objects:	PropertyChangeEvent HiEvent

As Listener
HelpIndex receives HiListener HiEvent displayPage() messages to synchronize the Contents with another Hi source, such as the Hi Brow browser bean.

EventListener Interfaces:	HiListener
Event Objects:	HiEvent

---

Supporting Classes

public class COM.phdcc.hi.HiEvent extends java.util.EventObject
{
	public String displayPage;
	public String displayTarget;

	HiEvent(Object source, String displayPage, String displayTarget);
}

public interface COM.phdcc.hi.HiListener extends java.util.EventListener
{
	void displayPage(HiEvent hie);
}

---

HelpIndex    PHD