SHOW Signed

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

java.lang.Object
  |
  +--net.rim.device.api.browser.field.BrowserContentBaseImpl
All Implemented Interfaces:
BrowserContent

public class BrowserContentBaseImpl
extends Object
implements 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

Field Summary
 Category: Signed protected  BrowserPageContext _context
           
 Category: Signed protected  String _error
          Any error incurred when attempting to retrieve content for this content (HTTP response values lower than 200 or greater than 400).
 Category: Signed protected  int _flags
          The flags for the requests.
 Category: Signed protected  EncodedImage _icon
          Image to be displayed in the title.
 Category: Signed protected  RenderingApplication _renderingApplication
          Application that uses this content.
 Category: Signed protected  RenderingOptions _renderingOptions
          Rendering options.
 Category: Signed protected  String _title
          Browser field title.
 Category: Signed protected  String _url
          Browser Field URL.
 
Constructor Summary
 Category: Signed BrowserContentBaseImpl(String url, Field content, RenderingApplication renderingApplication, RenderingOptions renderingOptions, int flags)
          Constructs a new BrowserContent instance.
 
Method Summary
 Category: Signed  void finishLoading()
          Complete loading by rendering content.
 Category: Signed  BrowserPageContext getBrowserPageContext()
          Retrieves page context for this browser content.
 Category: Signed  Field getDisplayableContent()
           
 Category: Signed  String getError()
          Retrieves error (if any) received when requesting content URL.
 Category: Signed  EncodedImage getIcon()
          Retrieves the title icon for this content.
 Category: Signed  RenderingApplication getRenderingApplication()
          Retrieves handle to this content's rendering application.
 Category: Signed  int getRenderingFlags()
           
 Category: Signed  RenderingOptions getRenderingOptions()
          Retrieves handle to this content's rendering options.
 Category: Signed  int getSharedFlags()
           
 Category: Signed  String getTitle()
          Retrieves this content's title.
 Category: Signed  String getURL()
          Retrieves the URL for this content.
 Category: Signed  String resolveUrl(String relative)
          Resolves provided relative URL.
 Category: Signed  void resourceReady(RequestedResource resource)
          Indicates resource is ready to render.
 Category: Signed  void setBrowserPageContext(BrowserPageContext context)
           
 Category: Signed  void setContent(Field field)
           
 Category: Signed  void setError(String string)
           
 Category: Signed  void setIcon(EncodedImage icon)
          Sets title icon for this content.
 Category: Signed  void setTitle(String title)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_icon

protected EncodedImage _icon
Image to be displayed in the 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.

_renderingApplication

protected RenderingApplication _renderingApplication
Application that uses 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.

_renderingOptions

protected RenderingOptions _renderingOptions
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.

_url

protected String _url
Browser Field 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.

_title

protected String _title
Browser field 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.

_error

protected String _error
Any error incurred when attempting to retrieve content for this content (HTTP response values lower than 200 or greater than 400).
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.

_flags

protected int _flags
The flags for the requests.
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.

_context

protected BrowserPageContext _context
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

BrowserContentBaseImpl

public BrowserContentBaseImpl(String url,
                              Field content,
                              RenderingApplication renderingApplication,
                              RenderingOptions renderingOptions,
                              int flags)
                       throws IllegalArgumentException
Constructs a new BrowserContent instance.
Parameters:
url - Url for this content.
content - Displayable field for this browser content.
renderingApplication - Application that uses this content.
renderingOptions - Options the rendering application uses to render this content; may not be null.
flags - Rendering flags.
Throws:
IllegalArgumentException - If you provide null for the rendering options parameter.
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

setContent

public void setContent(Field field)
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.

setTitle

public void setTitle(String title)
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.

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.

setIcon

public void setIcon(EncodedImage icon)
Sets title icon for this content.
Parameters:
icon - image to be used
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.

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.

setBrowserPageContext

public void setBrowserPageContext(BrowserPageContext context)
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. Browser Fields that want to manage relative urls, should overwrite this method.

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.

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 final 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.

getSharedFlags

public final int getSharedFlags()
Returns:
Retrieves the flags that are to be shared between this browser content and subsequent requests from it.
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.


Copyright 1999-2004 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.