net.rim.device.api.browser.plugin
Interface BrowserPageContext


public interface BrowserPageContext

Describes a collection of particular rendering properties.

The rendering session can use a class implementing this interface to query a specialized browser field for any particular rendering requirements it might have. Third parties implementing a specialized browser field should return a context object implementing this interface through BrowserContent.getBrowserPageContext().

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

Field Summary
Category: Signed static int DISPLAY_STYLE
          Property to handle display styles.
Category: Signed static int STYLE_NO_HORIZONTAL_SCROLLBAR
          Style to disable the horizontal scrollbar.
Category: Signed static int STYLE_NO_VERTICAL_SCROLLBAR
          Style to disable the vertical scrollbar.
Category: Signed static int STYLE_OVERLAY_FOOTER
          Style to ignore the footer height when calculating position on the screen.
Category: Signed static int STYLE_SHOW_FOOTER_ALWAYS
          Style to always show the footer.
Category: Signed static int STYLE_SHOW_IN_FULL_SCREEN
          Style to show page in full screen mode (no header and footer).
Category: Signed static int STYLE_VERTICAL_SCROLL_ON_LEFT
          Style to show the vertical scrollbar on the left hand side.
 
Method Summary
Category: Signed  boolean getPropertyWithBooleanValue(int id, boolean defaultValue)
          Retrieves value of specified property as a boolean value.
Category: Signed  int getPropertyWithIntValue(int id, int defaultValue)
          Retrieves value of specified property as a integer value.
Category: Signed  Object getPropertyWithObjectValue(int id, Object defaultValue)
          Retrieves value of specified property as an object.
Category: Signed  String getPropertyWithStringValue(int id, String defaultValue)
          Retrieves value of specified property as a string value.
 



Field Detail

STYLE_NO_VERTICAL_SCROLLBAR

static final int STYLE_NO_VERTICAL_SCROLLBAR
Style to disable the vertical scrollbar.

See Also:
Constant Field Values
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

STYLE_SHOW_IN_FULL_SCREEN

static final int STYLE_SHOW_IN_FULL_SCREEN
Style to show page in full screen mode (no header and footer).

See Also:
Constant Field Values
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

STYLE_OVERLAY_FOOTER

static final int STYLE_OVERLAY_FOOTER
Style to ignore the footer height when calculating position on the screen.

See Also:
Constant Field Values
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

STYLE_SHOW_FOOTER_ALWAYS

static final int STYLE_SHOW_FOOTER_ALWAYS
Style to always show the footer.

See Also:
Constant Field Values
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

STYLE_VERTICAL_SCROLL_ON_LEFT

static final int STYLE_VERTICAL_SCROLL_ON_LEFT
Style to show the vertical scrollbar on the left hand side.

See Also:
Constant Field Values
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.1.0

STYLE_NO_HORIZONTAL_SCROLLBAR

static final int STYLE_NO_HORIZONTAL_SCROLLBAR
Style to disable the horizontal scrollbar.

See Also:
Constant Field Values
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.2.1

DISPLAY_STYLE

static final int DISPLAY_STYLE
Property to handle display styles.

See Also:
Constant Field Values
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


Method Detail

getPropertyWithBooleanValue

boolean getPropertyWithBooleanValue(int id,
                                    boolean defaultValue)
Retrieves value of specified property as a boolean value.

Parameters:
id - ID of property to query.
defaultValue - Expected default value of property.
Returns:
Current value of property.
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

getPropertyWithStringValue

String getPropertyWithStringValue(int id,
                                  String defaultValue)
Retrieves value of specified property as a string value.

Parameters:
id - ID of property to query.
defaultValue - Expected default value of property.
Returns:
Current value of property.
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

getPropertyWithIntValue

int getPropertyWithIntValue(int id,
                            int defaultValue)
Retrieves value of specified property as a integer value.

Parameters:
id - ID of property to query.
defaultValue - Expected default value of property.
Returns:
Current value of property.
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

getPropertyWithObjectValue

Object getPropertyWithObjectValue(int id,
                                  Object defaultValue)
Retrieves value of specified property as an object.

Parameters:
id - ID of property to query.
defaultValue - Expected default value of property.
Returns:
Current value of property.
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.