SHOW Signed
 

net.rim.device.api.browser.field
Interface RenderingApplication


public interface RenderingApplication

Defines callback functionality a rendering session requires to assist with handling URL resources.

Applications wishing to use BrowserContent objects must either implement this interface, or employ a helper application that does.

Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:
JDE 4.0.0

Method Summary
 Category: Signed  Object eventOccurred(Event event)
          Invoked when an event occurs.
 Category: Signed  int getAvailableHeight(BrowserContent browserContent)
          Retrieves the pixels of height available for provided browser content.
 Category: Signed  int getAvailableWidth(BrowserContent browserContent)
          Retrieves the pixels of width available for provided browser content.
 Category: Signed  int getHistoryPosition(BrowserContent browserContent)
          Retrieves the history position for provided browser content.
 Category: Signed  String getHTTPCookie(String url)
          Retrieves cookies associated with a provided URL.
 Category: Signed  HttpConnection getResource(RequestedResource resource, BrowserContent referrer)
          Retrieves specified resource.
 Category: Signed  void invokeRunnable(Runnable runnable)
          Invokes provided runnable object.
 

Method Detail

eventOccurred

public Object eventOccurred(Event event)
Invoked when an event occurs.
Parameters:
event - Event to be processed.
Returns:
Existing implementations for supported events return null; future subclasses may return other values to support other functionality.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

getAvailableHeight

public int getAvailableHeight(BrowserContent browserContent)
Retrieves the pixels of height available for provided browser content.
Parameters:
browserContent - Content for which to retrieve available pixels of height.
Returns:
Height available.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

getAvailableWidth

public int getAvailableWidth(BrowserContent browserContent)
Retrieves the pixels of width available for provided browser content.
Parameters:
browserContent - Content for which to retrieve available pixels of width.
Returns:
Width available.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

getHistoryPosition

public int getHistoryPosition(BrowserContent browserContent)
Retrieves the history position for provided browser content.
Parameters:
browserContent - Content for which to retrieve the history position.
Returns:
History position.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

getHTTPCookie

public String getHTTPCookie(String url)
Retrieves cookies associated with a provided URL. This method is triggered when JavaScript on a web page requests a cookie. The method does not send a cookie or communicate the cookie to the web server hosting the page.
Parameters:
url - URL for which to retrieve cookies.
Returns:
a string containing cookies for the specified URL.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

getResource

public HttpConnection getResource(RequestedResource resource,
                                  BrowserContent referrer)
Retrieves specified resource.

This method must return a non-null HTTP connection when the referrer is null.

This call can be non-blocking if referrer is not null. If the call is not blocking, referrer must be notified with the connection via referrer.resourceReady(HttpConnection) call. If RequestedResource.isCacheOnly() is true then the content should only be returned if it is cached.

Parameters:
resource - Resource to request.
referrer - Browser content making the request, or null.
Returns:
If this method was invoked with a valid referrer object, then this method may return null to avoid blocking, and call back into the referrer object when the requested resource is ready for use. If this method was provided null for the referrer parameter, then this method must block until it can return a connection containing an input stream for the requested resource.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

invokeRunnable

public void invokeRunnable(Runnable runnable)
Invokes provided runnable object.
Parameters:
runnable - Runnable object to invoke.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.



Copyright 1999-2009 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.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.