net.rim.device.api.browser.plugin
Class BrowserContentProviderContext

java.lang.Object
  net.rim.device.api.browser.plugin.BrowserContentProviderContext

public class BrowserContentProviderContext
extends Object

Collects context information handed to a browser field provider by the 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

Constructor Summary
	BrowserContentProviderContext(HttpConnection httpConnection, RenderingApplication renderingApplication, RenderingSession renderingSession, int flags, Event event) Creates a new BrowserFieldProviderContext instance.
	BrowserContentProviderContext(InputConnection inputConnection, InputStream in, RenderingApplication renderingApplication, RenderingSession renderingSession, int flags, Event event) Creates a new BrowserFieldProviderContext instance.

Method Summary
	Event	getEvent() Retrieves event that initiated this rendering.
	int	getFlags() Retrieves rendering flags.
	HttpConnection	getHttpConnection() Retrieves connection containing data to render.
	InputConnection	getInputConnection() Retrieves connection containing data to render.
	InputStream	getInputStream() Retrieves the input stream, possibly null.
	RenderingApplication	getRenderingApplication() Retrieves rendering application to handle "off-page" resource requests.
	RenderingSession	getRenderingSession() Retrieves the rendering session for this field.

Methods inherited from class java.lang.Object

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

Constructor Detail

BrowserContentProviderContext

public BrowserContentProviderContext(HttpConnection httpConnection,
                                     RenderingApplication renderingApplication,
                                     RenderingSession renderingSession,
                                     int flags,
                                     Event event)

Creates a new BrowserFieldProviderContext instance.

Parameters:

httpConnection - Data to render.

renderingApplication - Rendering application to handle "off-page" resource requests.

renderingSession - Rendering session to handle interactions with browser field.

flags - Rendering flags (rendering constants).

event - Event that caused the creation of this context.

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

BrowserContentProviderContext

public BrowserContentProviderContext(InputConnection inputConnection,
                                     InputStream in,
                                     RenderingApplication renderingApplication,
                                     RenderingSession renderingSession,
                                     int flags,
                                     Event event)

Creates a new BrowserFieldProviderContext instance.

Parameters:

inputConnection - Data to render.

in - Input stream to render from. If null; the plugin should open the stream from the inputConnection.

renderingApplication - Rendering application to handle "off-page" resource requests.

renderingSession - Rendering session to handle interactions with browser field.

flags - Rendering flags (rendering constants).

event - Event that caused the creation of this context.

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

Method Detail

getEvent

public Event getEvent()

Retrieves event that initiated this rendering.

Returns:

Causing event.

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

getFlags

public int getFlags()

Retrieves rendering flags.

Returns:

Rendering flags.

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

getHttpConnection

public HttpConnection getHttpConnection()

Retrieves connection containing data to render.

Returns:

Connection containing data to render.

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

getInputConnection

public InputConnection getInputConnection()

Retrieves connection containing data to render.

Returns:

Connection containing data to render.

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

getInputStream

public InputStream getInputStream()

Retrieves the input stream, possibly null. If the result is null, the plugin should open the input stream from the connection.

Returns:

Input stream containing data to render.

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

getRenderingApplication

public RenderingApplication getRenderingApplication()

Retrieves rendering application to handle "off-page" resource requests.

Returns:

Rendering application for callbacks.

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

getRenderingSession

public RenderingSession getRenderingSession()

Retrieves the rendering session for this field.

Returns:

Rendering session for this field.

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