Package net.rim.device.api.browser.field

Provides access to browser-component functionality you can incorporate in other applications

See:
Description

Interface Summary

BrowserContent	A browser container capable of rendering web content.
RenderingApplication	Defines callback functionality a rendering session requires to assist with handling URL resources.
RenderingConstants	Defines a number of constant values used by the browser field API.

Class Summary

BrowserContentBaseImpl	Base implementation of a browser container capable of rendering web content.
BrowserContentChangedEvent	Event to signal that field's text and/or title may have changed.
BrowserContentManager	A manager for rendering web content obtained through the browser.
CloseEvent	Event to close the browser window.
ContentReadEvent	Event indicating the progress of loading the content.
ErrorEvent	Event to set display an error message to the user.
Event	Defines general functionality for all browser events.
ExecutingScriptEvent	Event indicating browser field is executing a script.
FullWindowEvent	Event to show the content in a full screen window.
HistoryEvent	Event to interact with the browser field's history.
ObjectParamList	A container class to hold the values from the HTML param elements nested inside an HTML object element.
RedirectEvent	Event to redirect.
RenderingOptions	Options for rendering content.
RenderingSession	Class to manage rendering sessions.
RequestedResource	Object to carry information about requested resource.
SetHeaderEvent	Event to set HTTP header information.
SetHttpCookieEvent	Event to set an HTTP cookie.
StopEvent	Event to signal a halt to loading.
UrlRequestedEvent	Event to signal the request of an URL.

Exception Summary

RenderingException

Thrown if a rendering error occurs.

Package net.rim.device.api.browser.field Description

Provides access to browser-component functionality you can incorporate in other applications.

The Field API supports third-party applications that want to include browser fields within their own UI to render web content; RIM's own rendering library handles all the rendering of web content for the field, and then hands your application back the field for you to display.

Interact with a RenderingSession

A rendering session object acts as the intermediary between your application and the system's rendering library. The system's rendering library manages rendering sessions: applications retrieve a rendering session handle by invoking RenderingSession.getNewInstance(). They can then use this rendering session to retrieve browser fields to display web content.

Fulfill the RenderingApplication interface

Third-party applications using BrowserContent components must either themselves implement the RenderingApplication interface or employ a helper application that does so. The system's rendering library interacts through a rendering session and expects to interact with the RenderingApplication interface on the other end.

A rendering session expects a rendering application to be able to

• Handle rendering events of various kinds.
• Provide measurements for available screen space for browser fields.
• Retrieve "off-page" resources (such as cookies, embedded images and objects)