net.rim.device.api.browser.field
Interface BrowserContent
- All Known Implementing Classes:
- BrowserContentBaseImpl
public interface BrowserContent
A browser container capable of rendering web content.
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 BrowserContent.finishLoading()
.
- See Also:
BrowserContentBaseImpl
- 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
getRenderingApplication
RenderingApplication getRenderingApplication()
- Retrieves handle to this content's rendering application.
- Returns:
- This content's rendering application.
- 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
getRenderingOptions
RenderingOptions getRenderingOptions()
- Retrieves handle to this content's rendering options.
- Returns:
- This content's rendering options.
- 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
getTitle
String getTitle()
- Retrieves the title of this content.
- Returns:
- The title of this content.
- 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
getURL
String getURL()
- Retrieves the URL of this content.
- Returns:
- The URL of this content.
- 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
getError
String getError()
- Retrieves error (if any) received when requesting the content.
- Returns:
- Error received when attempting to fetch the content.
- 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
getIcon
EncodedImage getIcon()
- Retrieves the icon of this content.
- Returns:
- The image representation of the icon.
- 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
getBrowserPageContext
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).
- 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
resourceReady
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.- 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
finishLoading
void finishLoading()
throws RenderingException
- Complete loading by rendering content.
A content object may do incremental rendering inside of this method. That is
an application can call getDisplayableContent
first and display the
field to the user; and then call finishLoading
on a background thread
to actually display content to the user. This method must not be invoked on a UI Event
Dispatch Thread.
- Throws:
RenderingException
- If this browser content was unable to render its content
resource.- 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
getDisplayableContent
Field getDisplayableContent()
- Returns a displayable UI field.
This method is the main mechanism for retrieving or providing a UI
widget. Third parties that provide their own BrowserContent objects
should always return a non-null object from this method.
- Returns:
- Returns a displayable UI field for the content.
- 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
getRenderingFlags
int getRenderingFlags()
- Returns the rendering flags for this content.
Rendering flags can be found in the RenderingConstants
class. The flags
are composed by ORing together the constants in the referenced class.
- Returns:
- The rendering flags for this content.
- 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
setError
void setError(String string)
- Indicates to the browser content class that some type of error has occurred. The
implementation may display this error string to the user.
- Parameters:
string
- Error string describing the error that occurred.- 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
resolveUrl
String resolveUrl(String relative)
- Resolves provided relative URL.
Use this method to expand a relative URL and retrieve its canonical
form.
- Parameters:
relative
- The URL to resolve.
- Returns:
- Canonical form of provided URL.
- 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
Copyright 1999-2010 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. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.