net.rim.device.api.browser.field
Class RenderingSession

java.lang.Object
  net.rim.device.api.browser.field.RenderingSession

public abstract class RenderingSession
extends Object

Class to manage rendering sessions.

An application wanting to use a rendering session's services must invoke RenderingSession.getNewInstance() in order to retrieve a rendering session handle. Then, it can fetch browser contents to render web content by invoking one of the RenderingSession.getBrowserContent(javax.microedition.io.HttpConnection, net.rim.device.api.browser.field.RenderingApplication, int) methods.

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:

BlackBerry API 4.0.0

Field Summary
	static long	APP_REGISTRY_KEY Application registry key.
	protected RenderingOptions	_renderingOptions Rendering options for this session.

Method Summary
	abstract String	getAcceptCharsetValues() Retrieves supported character set values.
	abstract String	getAcceptTypes() Retrieves accept string for this session.
	BrowserContent	getBrowserContent(HttpConnection connection, InputStream in, RenderingApplication renderingApplication, int flags) Retrieves browser content for rendering.
	abstract BrowserContent	getBrowserContent(HttpConnection connection, RenderingApplication renderingApplication, int flags) Retrieves browser content for rendering.
	abstract BrowserContent	getBrowserContent(HttpConnection connection, RenderingApplication renderingApplication, Event event) Retrieves browser content for rendering.
	BrowserContent	getBrowserContent(InputConnection connection, InputStream in, String url, RenderingApplication renderingApplication, int flags) Retrieves browser content for rendering.
	BrowserContent	getBrowserContent(InputConnection connection, String url, RenderingApplication renderingApplication, int flags) Retrieves browser content for rendering.
	BrowserContent	getBrowserContent(InputConnection connection, String url, RenderingApplication renderingApplication, Event event) Retrieves browser content for rendering.
	abstract Object	getContext() Retrieves context object for this session.
	static RenderingSession	getNewInstance() Retrieves a rendering session handle.
	abstract RenderingOptions	getRenderingOptions() Retrieves this session's rendering options.
	abstract Vector	getSupportedMimeType() Retrieves list of supported mime types.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

APP_REGISTRY_KEY

public static final long APP_REGISTRY_KEY

Application registry key.

See Also:

Constant Field Values

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:

BlackBerry API 4.0.0

_renderingOptions

protected RenderingOptions _renderingOptions

Rendering options for this session.

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:

BlackBerry API 4.0.0

Method Detail

getNewInstance

public static RenderingSession getNewInstance()

Retrieves a rendering session handle.

Returns:

Handle to rendering session.

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:

BlackBerry API 4.0.0

getAcceptTypes

public abstract String getAcceptTypes()

Retrieves accept string for this session.

Returns:

Accept string for this session.

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:

BlackBerry API 4.0.0

getSupportedMimeType

public abstract Vector getSupportedMimeType()

Retrieves list of supported mime types.

Returns:

a vector of strings; each element is a supported mime type..

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:

BlackBerry API 4.0.0

getRenderingOptions

public abstract RenderingOptions getRenderingOptions()

Retrieves this session's rendering options.

Returns:

Rendering options for this session

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:

BlackBerry API 4.0.0

getAcceptCharsetValues

public abstract String getAcceptCharsetValues()

Retrieves supported character set values.

Returns:

List of character set values, separated by commas.

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:

BlackBerry API 4.0.0

getContext

public abstract Object getContext()

Retrieves context object for this session.

Returns:

Context for this session.

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:

BlackBerry API 4.0.0

getBrowserContent

public abstract BrowserContent getBrowserContent(HttpConnection connection,
                                                 RenderingApplication renderingApplication,
                                                 int flags)
                                          throws RenderingException

Retrieves browser content for rendering.

Parameters:

connection - Connection with the input stream containing the content to be rendered.

renderingApplication - Rendering application that can listen for events from browser content; may be null.

flags - Flags indicating extra information about rendering.

Returns:

Browser content containing content of the connection passed in.

Throws:

RenderingException

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:

BlackBerry API 4.0.0

getBrowserContent

public BrowserContent getBrowserContent(HttpConnection connection,
                                        InputStream in,
                                        RenderingApplication renderingApplication,
                                        int flags)
                                 throws RenderingException

Retrieves browser content for rendering.

Parameters:

connection - Connection containing the content to be rendered.

in - Input stream with the data to be rendered.

renderingApplication - Rendering application that can listen for events from browser content; may be null.

flags - Flags indicating extra information about rendering.

Returns:

Browser content containing content of the connection passed in.

Throws:

RenderingException

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:

BlackBerry API 4.6.0

getBrowserContent

public abstract BrowserContent getBrowserContent(HttpConnection connection,
                                                 RenderingApplication renderingApplication,
                                                 Event event)
                                          throws RenderingException

Retrieves browser content for rendering.

Parameters:

connection - Connection with the input stream containing the content to be rendered.

renderingApplication - Rendering application that can listen for events from browser content; may be null.

event - Event from browser content that caused new Browser content to be retrieved.

Returns:

Browser content containing content of the connection passed in

Throws:

RenderingException

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:

BlackBerry API 4.0.0

getBrowserContent

public BrowserContent getBrowserContent(InputConnection connection,
                                        String url,
                                        RenderingApplication renderingApplication,
                                        int flags)
                                 throws RenderingException

Retrieves browser content for rendering.

Parameters:

connection - Connection with the input stream containing the content to be rendered.

url - The base URL used to resolve relative references, not used for HTTP connections.

renderingApplication - Rendering application that can listen for events from browser content; may be null.

flags - Flags indicating extra information about rendering.

Returns:

Browser content containing content of the connection passed in.

Throws:

RenderingException

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:

BlackBerry API 4.2.0

getBrowserContent

public BrowserContent getBrowserContent(InputConnection connection,
                                        InputStream in,
                                        String url,
                                        RenderingApplication renderingApplication,
                                        int flags)
                                 throws RenderingException

Retrieves browser content for rendering.

Parameters:

connection - Connection containing the content to be rendered.

in - Input stream with the data to be rendered.

url - The base URL used to resolve relative references, not used for HTTP connections.

renderingApplication - Rendering application that can listen for events from browser content; may be null.

flags - Flags indicating extra information about rendering.

Returns:

Browser content containing content of the connection passed in.

Throws:

RenderingException

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:

BlackBerry API 4.6.0

getBrowserContent

public BrowserContent getBrowserContent(InputConnection connection,
                                        String url,
                                        RenderingApplication renderingApplication,
                                        Event event)
                                 throws RenderingException

Retrieves browser content for rendering.

Parameters:

connection - Connection with the input stream containing the content to be rendered.

url - The base URL used to resolve relative references, not used for HTTP connections.

renderingApplication - Rendering application that can listen for events from browser content; may be null.

event - Event from browser content that caused new Browser content to be retrieved.

Returns:

Browser content containing content of the connection passed in

Throws:

RenderingException

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:

BlackBerry API 4.2.0