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 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:
JDE 4.0.0

Field Summary
 Category: Signed protected  RenderingOptions _renderingOptions
          Rendering options for this session.
 Category: Signed static long APP_REGISTRY_KEY
          Application registry key.
 
Constructor Summary
 Category: Signed protected RenderingSession()
          Creates new RenderingSession instance.
 
Method Summary
 Category: Signed abstract  String getAcceptCharsetValues()
          Retrieves supported character set values.
 Category: Signed abstract  String getAcceptTypes()
          Retrieves accept string for this session.
 Category: Signed  BrowserContent getBrowserContent(HttpConnection connection, InputStream in, RenderingApplication renderingApplication, int flags)
          Retrieves browser content for rendering.
 Category: Signed abstract  BrowserContent getBrowserContent(HttpConnection connection, RenderingApplication renderingApplication, Event event)
          Retrieves browser content for rendering.
 Category: Signed abstract  BrowserContent getBrowserContent(HttpConnection connection, RenderingApplication renderingApplication, int flags)
          Retrieves browser content for rendering.
 Category: Signed  BrowserContent getBrowserContent(InputConnection connection, InputStream in, String url, RenderingApplication renderingApplication, int flags)
          Retrieves browser content for rendering.
 Category: Signed  BrowserContent getBrowserContent(InputConnection connection, String url, RenderingApplication renderingApplication, Event event)
          Retrieves browser content for rendering.
 Category: Signed  BrowserContent getBrowserContent(InputConnection connection, String url, RenderingApplication renderingApplication, int flags)
          Retrieves browser content for rendering.
 Category: Signed abstract  Object getContext()
          Retrieves context object for this session.
 Category: Signed static RenderingSession getNewInstance()
          Retrieves a rendering session handle.
 Category: Signed abstract  RenderingOptions getRenderingOptions()
          Retrieves this session's rendering options.
 Category: Signed 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

_renderingOptions

protected RenderingOptions _renderingOptions
Rendering options for this session.
Since:
JDE 4.0.0
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.

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 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.
Constructor Detail

RenderingSession

protected RenderingSession()
Creates new RenderingSession instance.
Since:
JDE 4.0.0
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.
Method Detail

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

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

getBrowserContent

public BrowserContent getBrowserContent(HttpConnection connection,
                                        InputStream in,
                                        RenderingApplication renderingApplication,
                                        int flags)
                                 throws RenderingException
Retrieves browser content for rendering.
Parameters:
connection - Connection containing the content to be rendered.
in - Input stream with the data 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.6.0
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.

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

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

getBrowserContent

public BrowserContent getBrowserContent(InputConnection connection,
                                        InputStream in,
                                        String url,
                                        RenderingApplication renderingApplication,
                                        int flags)
                                 throws RenderingException
Retrieves browser content for rendering.
Parameters:
connection - Connection containing the content to be rendered.
in - Input stream with the data 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.6.0
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.

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

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

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

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

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

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



Copyright 1999-2009 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.