com.webrenderer.swing.event

Class BrowserEvent

java.lang.Object

java.util.EventObject

com.webrenderer.swing.event.BrowserEvent

All Implemented Interfaces:

Serializable

public class BrowserEvent
extends EventObject

An event which indicates that there has been a change in some areas of the browser. Currently, a BrowserEvent encapsulates:

• A change of the resource title
• A change of the current URL
• A link message has changed

To reduce the cost of multiple method invocations, the event object will record the new data pertaining to the event. The object will only contain the data required for the given event. This implies that if the event was generated due to a URL change, then the title and link information will be invalid.

If a function is not appropriate/available for the situation from which it is being called, it will return null.

To clarify the meaning of a link message, these occur when the users mouse passes over a HTML link. The message passed back is usually the url the link is pointing to, unless modified via scripting.

See Also:

BrowserListener, Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
BrowserEvent(Object source) Constructor for BrowserEvent with a source.

Method Summary

Methods

Modifier and Type	Method and Description
void	blockLoad() Set a flag to block loading.
boolean	getBlockLoad() Get the current block status.
BufferedImage	getFavicon() Get the favicon.
String	getHeaders() Gets the request headers.
String	getLink() Gets the link message.
String	getPOSTData() Gets the post data.
String	getTargetFrame() Get the target frame name.
String	getTitle() Get the title.
String	getURL() Get the URL.
boolean	isTopFrame() Return if this load is the top frame.
void	setFavicon(BufferedImage favicon)
void	setHeaders(String string) Set the request headers.
void	setLink(String link) Set the link message.
void	setPOSTData(String string)
void	setTargetFrame(String string) Set the name of the target frame.
void	setTitle(String title) Set the title.
void	setTopFrame(boolean topFrame)
void	setURL(String url) Set the URL.
void	unBlockLoad() Unblock the loading.

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

Constructor Detail

BrowserEvent

public BrowserEvent(Object source)

Constructor for BrowserEvent with a source. The URL, title, and link fields are initialized to null.

Parameters:

source -

See Also:

EventObject.EventObject(Object)

Method Detail

getURL

public String getURL()

Get the URL.

Returns:

the URL or null

see availability of return values in BrowserListener

See Also:

getURL()

setURL

public void setURL(String url)

Set the URL. This should only be used for constructing new events.

Parameters:

url - The URL.

See Also:

getURL()

getTitle

public String getTitle()

Get the title.

Returns:

the title, or null.

see availability of return values in BrowserListener

See Also:

setTitle(String)

setTitle

public void setTitle(String title)

Set the title. This should only be used for constructing new events.

Parameters:

title - The title.

getLink

public String getLink()

Gets the link message.

Returns:

the link message, or null

see availability of return values in BrowserListener

getPOSTData

public String getPOSTData()

Gets the post data.

Returns:

the post data, or null

see availability of return values in BrowserListener

getHeaders

public String getHeaders()

Gets the request headers.

Returns:

the request headers, or null

see availability of return values in BrowserListener

setLink

public void setLink(String link)

Set the link message. This should only be used for constructing new events.

Parameters:

link - The link message.

getTargetFrame

public String getTargetFrame()

Get the target frame name.

Returns:

the Target Frame Name

blockLoad

public void blockLoad()

Set a flag to block loading. When called from onLoadIntercept allows the stop of a load before it starts

See Also:

unBlockLoad()

unBlockLoad

public void unBlockLoad()

Unblock the loading.

See Also:

blockLoad()

getBlockLoad

public boolean getBlockLoad()

Get the current block status.

Returns:

the current status of load blocking.

See Also:

unBlockLoad(), blockLoad()

setHeaders

public void setHeaders(String string)

Set the request headers.

Parameters:

string - the new request headers.

setPOSTData

public void setPOSTData(String string)

Parameters:

string -

setTargetFrame

public void setTargetFrame(String string)

Set the name of the target frame.

Parameters:

string - the target frame.

getFavicon

public BufferedImage getFavicon()

Get the favicon. Only available in the onFavicon event.

Returns:

the favicon.

setFavicon

public void setFavicon(BufferedImage favicon)

isTopFrame

public boolean isTopFrame()

Return if this load is the top frame.

Returns:

if this is the top frame, false for a child.

setTopFrame

public void setTopFrame(boolean topFrame)