JDIC API V0.9 Release 4

org.jdesktop.jdic.browser
Class WebBrowserEvent

java.lang.Object
  extended by java.util.EventObject
      extended by org.jdesktop.jdic.browser.WebBrowserEvent
All Implemented Interfaces:
java.io.Serializable

public class WebBrowserEvent
extends java.util.EventObject

A WebBrowserEvent is dispatched by a WebBrowser object to indicate a defined WebBrowser event occured. The event is passed to every WebBrowserListener object that was registered to receive such events using WebBrowser's addWebBrowserListener method.

The object that implements the WebBrowserListener interface or inherits the WebBrowserAdapter class gets this WebBrowserEvent when the event occurs. The listener is therefore spared the details of processing individual WebBrowser events.

See Also:
WebBrowserListener, WebBrowser, Serialized Form

Field Summary
static int WEBBROWSER_CLOSE
          Event fired in response to JavaScript window.close().
static int WEBBROWSER_DOCUMENT_COMPLETED
          Event fired when the document has loaded completely.
static int WEBBROWSER_DOWNLOAD_COMPLETED
          Event fired when a navigation operation finishes, is halted, or fails.
static int WEBBROWSER_DOWNLOAD_ERROR
          Event fired when an error occurs during a navigation operation.
static int WEBBROWSER_DOWNLOAD_PROGRESS
          Event fired when the progress of a navigation operation is updated on the object.
static int WEBBROWSER_DOWNLOAD_STARTED
          Event fired when a navigation operation is beginning.
static int WEBBROWSER_STATUSTEXT_CHANGE
          Event fired when the status bar text changes.
static int WEBBROWSER_TITLE_CHANGE
          Event fired when the title of a document changes.
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
WebBrowserEvent(WebBrowser source, int id)
          Constructs a WebBrowserEvent object with source and event id.
WebBrowserEvent(WebBrowser source, int id, java.lang.String data)
          Constructs a WebBrowserEvent object with source, event id and event data.
 
Method Summary
 java.lang.String getData()
          Returns the event data.
 int getID()
          Returns the event ID.
 
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

WEBBROWSER_DOWNLOAD_STARTED

public static final int WEBBROWSER_DOWNLOAD_STARTED
Event fired when a navigation operation is beginning.

See Also:
Constant Field Values

WEBBROWSER_DOWNLOAD_COMPLETED

public static final int WEBBROWSER_DOWNLOAD_COMPLETED
Event fired when a navigation operation finishes, is halted, or fails. This may be fired multiple times if a document has pop-up windows or frames.

See Also:
Constant Field Values

WEBBROWSER_DOWNLOAD_PROGRESS

public static final int WEBBROWSER_DOWNLOAD_PROGRESS
Event fired when the progress of a navigation operation is updated on the object.

See Also:
Constant Field Values

WEBBROWSER_DOWNLOAD_ERROR

public static final int WEBBROWSER_DOWNLOAD_ERROR
Event fired when an error occurs during a navigation operation.

See Also:
Constant Field Values

WEBBROWSER_DOCUMENT_COMPLETED

public static final int WEBBROWSER_DOCUMENT_COMPLETED
Event fired when the document has loaded completely.

Since:
0.9
See Also:
Constant Field Values

WEBBROWSER_TITLE_CHANGE

public static final int WEBBROWSER_TITLE_CHANGE
Event fired when the title of a document changes.

See Also:
Constant Field Values

WEBBROWSER_STATUSTEXT_CHANGE

public static final int WEBBROWSER_STATUSTEXT_CHANGE
Event fired when the status bar text changes.

See Also:
Constant Field Values

WEBBROWSER_CLOSE

public static final int WEBBROWSER_CLOSE
Event fired in response to JavaScript window.close().

See Also:
Constant Field Values
Constructor Detail

WebBrowserEvent

public WebBrowserEvent(WebBrowser source,
                       int id)
Constructs a WebBrowserEvent object with source and event id.

Parameters:
source - the WebBrowser which owns this event.
id - the id of the event.

WebBrowserEvent

public WebBrowserEvent(WebBrowser source,
                       int id,
                       java.lang.String data)
Constructs a WebBrowserEvent object with source, event id and event data.

Parameters:
source - the WebBrowser which owns this event.
id - the id of the event.
data - the data of the event.
Method Detail

getID

public int getID()
Returns the event ID.


getData

public java.lang.String getData()
Returns the event data.


JDIC API V0.9 Release 4

For more information and documentation on JDIC, see JDIC website.

That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, working code examples, license terms and bug report information.

Copyright (c) 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.