SHOW Signed

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 getNewInstance() in order to retrieve a rendering session handle. Then, it can fetch browser contents to render web content by invoking one of the getBrowserContent(javax.microedition.io.HttpConnection, net.rim.device.api.browser.field.RenderingApplication, int) methods.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:

JDE 4.0.0

Field Summary

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

Constructor Summary

protected

RenderingSession() Creates new RenderingSession instance.

Method Summary

	abstract String	getAcceptCharsetValues() Retrieves supported character set values.
	abstract String	getAcceptTypes() Retrieves accept string for this session.
	abstract BrowserContent	getBrowserContent(HttpConnection connection, RenderingApplication renderingApplication, Event event) Retrieves browser content for rendering.
	abstract BrowserContent	getBrowserContent(HttpConnection connection, RenderingApplication renderingApplication, int flags) Retrieves browser content for rendering.
	BrowserContent	getBrowserContent(InputConnection connection, String url, RenderingApplication renderingApplication, Event event) Retrieves browser content for rendering.
	BrowserContent	getBrowserContent(InputConnection connection, String url, RenderingApplication renderingApplication, int flags) 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.

Since:

JDE 4.0.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

_renderingOptions

protected RenderingOptions _renderingOptions

Rendering options for this session.

Since:

JDE 4.0.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Constructor Detail

RenderingSession

protected RenderingSession()

Creates new RenderingSession instance.

Since:

JDE 4.0.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Method Detail

getNewInstance

public static RenderingSession getNewInstance()

Retrieves a rendering session handle.

Returns:

Handle to rendering session.

Since:

JDE 4.0.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getAcceptTypes

public abstract String getAcceptTypes()

Retrieves accept string for this session.

Returns:

Accept string for this session.

Since:

JDE 4.0.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getSupportedMimeType

public abstract Vector getSupportedMimeType()

Retrieves list of supported mime types.

Returns:

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

Since:

JDE 4.0.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getRenderingOptions

public abstract RenderingOptions getRenderingOptions()

Retrieves this session's rendering options.

Returns:

Rendering options for this session

Since:

JDE 4.0.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getAcceptCharsetValues

public abstract String getAcceptCharsetValues()

Retrieves supported character set values.

Returns:

List of character set values, separated by commas.

Since:

JDE 4.0.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getContext

public abstract Object getContext()

Retrieves context object for this session.

Returns:

Context for this session.

Since:

JDE 4.0.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

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.

Since:

JDE 4.0.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

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

Since:

JDE 4.0.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

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.

Since:

JDE 4.2.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

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

Since:

JDE 4.2.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.