net.rim.device.api.web
Interface WidgetConfig


public interface WidgetConfig

The WidgetConfig object stores information parsed from the config.xml and any additional information generated by the Web Component Pack.

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 5.0.0

Field Summary
Category: Signed static String WIDGET_LOCAL_DOMAIN
          The default string used to indicate the 'local' access tag - implicitly declared in config.xml.
 
Method Summary
Category: Signed  WidgetAccess[] getAccessList()
          Retrieves an array of WidgetAccess object representing the 'access' tags in the config.xml.
Category: Signed  String getAuthor()
          Widget author.
Category: Signed  String getAuthorEmail()
          Widget author's email.
Category: Signed  String getAuthorURL()
          Widget author's URL.
Category: Signed  Document getConfigXML()
          Retrieves the document node for the config.xml used to generate this object.
Category: Signed  String getContent()
          The 'content' element.
Category: Signed  String getContentCharset()
          The 'charset' attribute.
Category: Signed  String getContentType()
          The 'contentType' attribute.
Category: Signed  String getCopyright()
          Widget's copyright info.
Category: Signed  HttpHeaders getCustomHeaders()
          Returns a hashtable of the custom headers definted in the 'rim:header' attribute.
Category: Signed  String getDescription()
          Widget description.
Category: Signed  WidgetExtension getExtensionForFeature(String featureID)
          Retrieves a WidgetExtension for the corresponding feature ID.
Category: Signed  Enumeration getExtensions()
          An enumeration of all the Javascript Extension to be loaded for this widget.
Category: Signed  String getID()
          An internally generated ID.
Category: Signed  String getIcon()
          Retrieves the location of the widget's icon on the device ribbon.
Category: Signed  String getIconHover()
          Retrieves the location of the widget's hover icon on the device ribbon.
Category: Signed  String getLicense()
          Widget license information.
Category: Signed  String getLicenseURL()
           
Category: Signed  String getLoadingScreenColor()
          Hex value of loading screen color
Category: Signed  String getName()
          Widget name.
Category: Signed  Hashtable getNotifications()
          Hashtable describing the information parsed from the 'rim:notification' elements
Category: Signed  String getVersion()
          Widget version.
 



Field Detail

WIDGET_LOCAL_DOMAIN

static final String WIDGET_LOCAL_DOMAIN
The default string used to indicate the 'local' access tag - implicitly declared in config.xml.

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 5.0.0


Method Detail

getAccessList

WidgetAccess[] getAccessList()
Retrieves an array of WidgetAccess object representing the 'access' tags in the config.xml.

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 5.0.0

getAuthor

String getAuthor()
Widget author.

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 5.0.0

getAuthorEmail

String getAuthorEmail()
Widget author's email.

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 5.0.0

getAuthorURL

String getAuthorURL()
Widget author's 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 5.0.0

getCopyright

String getCopyright()
Widget's copyright info.

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 5.0.0

getConfigXML

Document getConfigXML()
Retrieves the document node for the config.xml used to generate this object.

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 5.0.0

getContent

String getContent()
The 'content' element.

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 5.0.0

getContentCharset

String getContentCharset()
The 'charset' attribute.

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 5.0.0

getContentType

String getContentType()
The 'contentType' attribute.

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 5.0.0

getCustomHeaders

HttpHeaders getCustomHeaders()
Returns a hashtable of the custom headers definted in the 'rim:header' attribute.

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 5.0.0

getDescription

String getDescription()
Widget description.

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 5.0.0

getExtensions

Enumeration getExtensions()
An enumeration of all the Javascript Extension to be loaded for this widget.

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 5.0.0

getExtensionForFeature

WidgetExtension getExtensionForFeature(String featureID)
Retrieves a WidgetExtension for the corresponding feature ID.

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 5.0.0

getIcon

String getIcon()
Retrieves the location of the widget's icon on the device ribbon.

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 5.0.0

getIconHover

String getIconHover()
Retrieves the location of the widget's hover icon on the device ribbon.

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 5.0.0

getLicense

String getLicense()
Widget license information.

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 5.0.0

getLicenseURL

String getLicenseURL()
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 5.0.0

getName

String getName()
Widget name.

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 5.0.0

getNotifications

Hashtable getNotifications()
Hashtable describing the information parsed from the 'rim:notification' elements

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 5.0.0

getVersion

String getVersion()
Widget version.

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 5.0.0

getID

String getID()
An internally generated ID.

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 6.0.0

getLoadingScreenColor

String getLoadingScreenColor()
Hex value of loading screen color

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