net.rim.device.api.browser.field2
Class BrowserFieldListener

java.lang.Object
  extended by net.rim.device.api.browser.field2.BrowserFieldListener

public abstract class BrowserFieldListener
extends Object

This class is to be extended for the purpose of listening for events pertaining to a BrowserField component.

Example usage:

 BrowserField browserField = new BrowserField();
 BrowserFieldListener listener = new BrowserFieldListener() {
     public void documentLoaded(BrowserField browserField, Document document) throws Exception
     {
         // the document has loaded, do something ...
     }
 }
 browserField.addListener( listener );
 

Since:
BlackBerry API 5.0.0

Method Summary
 void documentAborted(BrowserField browserField, Document document)
           
 void documentCreated(BrowserField browserField, ScriptEngine scriptEngine, Document document)
           
 void documentError(BrowserField browserField, Document document)
           
 void documentLoaded(BrowserField browserField, Document document)
           
 void documentUnloading(BrowserField browserField, Document document)
           
 void downloadProgress(BrowserField browserField, ContentReadEvent event)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Method Detail

documentCreated

public void documentCreated(BrowserField browserField,
                            ScriptEngine scriptEngine,
                            Document document)
                     throws Exception
Parameters:
browserField - The BrowserField to which the document belongs
scriptEngine - The ScriptEngine associated with the document
document - The document for which this event belongs. At this point the document will be a new and empty document object.
Throws:
Exception
Since:
BlackBerry API 5.0.0

documentLoaded

public void documentLoaded(BrowserField browserField,
                           Document document)
                    throws Exception
Parameters:
browserField - The BrowserField to which the document belongs
document - The document for which this event belongs
Throws:
Exception
Since:
BlackBerry API 5.0.0

documentError

public void documentError(BrowserField browserField,
                          Document document)
                   throws Exception
Parameters:
browserField - The BrowserField to which the document belongs
document - The document for which this event belongs
Throws:
Exception
Since:
BlackBerry API 5.0.0

documentAborted

public void documentAborted(BrowserField browserField,
                            Document document)
                     throws Exception
Parameters:
browserField - The BrowserField to which the document belongs
document - The document for which this event belongs. Can be null or partially created depending on when the abort occurred.
Throws:
Exception
Since:
BlackBerry API 5.0.0

documentUnloading

public void documentUnloading(BrowserField browserField,
                              Document document)
                       throws Exception
Parameters:
browserField - The BrowserField to which the document belongs
document - The document for which this event belongs
Throws:
Exception
Since:
BlackBerry API 5.0.0

downloadProgress

public void downloadProgress(BrowserField browserField,
                             ContentReadEvent event)
                      throws Exception
Parameters:
browserField - The BrowserField to which the document belongs
event - The details the download progress
Throws:
Exception
Since:
BlackBerry API 5.0.0





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.