com.webrenderer.swing.event

Class ProtocolEvent

java.lang.Object

java.util.EventObject

com.webrenderer.swing.event.ProtocolEvent

All Implemented Interfaces:

Serializable

public abstract class ProtocolEvent
extends EventObject

An event which indicates that the browser needs to load data through a registered protocol. Currently, a ProtocolEvent will be invoked in an IMozillaBrowserCanvas .

This event object contains callback methods to pass data back to the underlying browser about a protocol load. For an example of using ProtocolEvent see Protocol Listener.

See Also:

ProtocolListener, IMozillaBrowserCanvas.registerProtocol(java.lang.String, com.webrenderer.swing.event.ProtocolListener), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	REQUEST_FAILED The load has finished but something has failed.
static int	REQUEST_OK The load has finished and everything has been successful.

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProtocolEvent(Object source, String url) Constructor for ProtocolEvent with a source.

Method Summary

Methods

Modifier and Type	Method and Description
String	getURL() Returns the URL.
abstract void	onDataAvailable(byte[] data) Passes some data to the underlying browser.
abstract void	onStartRequest(String contentType) Tell the underlying browser that the load is about to begin.
abstract void	onStopRequest(int result) Tell the underlying browser that all the data has been sent.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

REQUEST_OK

public static final int REQUEST_OK

The load has finished and everything has been successful.

See Also:

Constant Field Values

REQUEST_FAILED

public static final int REQUEST_FAILED

The load has finished but something has failed.

See Also:

Constant Field Values

Constructor Detail

ProtocolEvent

protected ProtocolEvent(Object source,
             String url)

Constructor for ProtocolEvent with a source.

Parameters:

source -

See Also:

EventObject.EventObject(Object)

Method Detail

onStartRequest

public abstract void onStartRequest(String contentType)

Tell the underlying browser that the load is about to begin.

Parameters:

contentType - the content type of the data that is about to be sent. e.g. "text/html", or "image/gif" etc.

onStopRequest

public abstract void onStopRequest(int result)

Tell the underlying browser that all the data has been sent.

Parameters:

result - result of load. Can either be REQUEST_OK or REQUEST_FAILED

See Also:

REQUEST_OK, REQUEST_FAILED

onDataAvailable

public abstract void onDataAvailable(byte[] data)

Passes some data to the underlying browser. This can be called multiple times as data becomes available. onDataAvailable should only be called after onStartRequest and before onStopRequest.

Parameters:

data - byte array containing data.

getURL

public String getURL()

Returns the URL.

Returns:

String