SHOW Signed

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

All Known Implementing Classes:

BrowserContentBaseImpl

public interface BrowserContent

Field in which internet resource content (URLs) can be rendered.

Applications wishing to use browser fields to render web content should retrieve them from a rendering session (by invoking RenderingSession.getBrowserContent) rather than directly instantiating them.

When a browser content gets created it won't actually render any of its associated content until you invoke finishLoading().

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

Method Summary

	void	finishLoading() Complete loading by rendering content.
	BrowserPageContext	getBrowserPageContext() Retrieves page context for this browser content.
	Field	getDisplayableContent()
	String	getError() Retrieves error (if any) received when requesting content URL.
	EncodedImage	getIcon() Retrieves the title icon for this content.
	RenderingApplication	getRenderingApplication() Retrieves handle to this content's rendering application.
	int	getRenderingFlags()
	RenderingOptions	getRenderingOptions() Retrieves handle to this content's rendering options.
	String	getTitle() Retrieves this content's title.
	String	getURL() Retrieves the URL for this content.
	String	resolveUrl(String relative) Resolves provided relative URL.
	void	resourceReady(RequestedResource resource) Indicates resource is ready to render.
	void	setError(String string)

Method Detail

getRenderingApplication

public RenderingApplication getRenderingApplication()

Retrieves handle to this content's rendering application.

Returns:

This content's rendering application.

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 RenderingOptions getRenderingOptions()

Retrieves handle to this content's rendering options.

Returns:

This content's rendering options.

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.

getTitle

public String getTitle()

Retrieves this content's title.

Returns:

This content's title.

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.

getURL

public String getURL()

Retrieves the URL for this content.

Returns:

URL for this content.

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.

getError

public String getError()

Retrieves error (if any) received when requesting content URL.

Returns:

Error received when attempting to fetch resource content at URL.

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.

getIcon

public EncodedImage getIcon()

Retrieves the title icon for this content.

Returns:

image

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.

getBrowserPageContext

public BrowserPageContext getBrowserPageContext()

Retrieves page context for this browser content.

Third parties can overwrite this method to direct the way the rendering library displays this content within the browser application.

Returns:

Null (third parties that implement their own browser contents can return a browser page context object, if they require special handling).

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.

resourceReady

public void resourceReady(RequestedResource resource)

Indicates resource is ready to render.

The rendering application invokes this call-back method after the resource is requested and the HTTP Connection is ready.

Parameters:

resource - Resource that was requested, which the HTTP connection set.

Since:

JDE 4.0.2

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.

finishLoading

public void finishLoading()
                   throws RenderingException

Complete loading by rendering content.

Throws:

RenderingException - If this browser content was unable to render its content resource.

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.

getDisplayableContent

public Field getDisplayableContent()

Returns:

Returns the content.

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.

getRenderingFlags

public int getRenderingFlags()

Returns:

Retrieves rendering flags for this content.

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.

setError

public void setError(String string)

Parameters:

string - Error string.

Since:

JDE 4.0.2

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.

resolveUrl

public String resolveUrl(String relative)

Resolves provided relative URL.

Use this method to expand a relative URL and retrieve its canonical form.

Parameters:

relative - URL to resolve.

Returns:

Canonical form of provided URL.

Since:

JDE 4.0.2

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.