WidgetConfig (BlackBerry JDE 7.1.0 API Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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
	`static String`	`WIDGET_LOCAL_DOMAIN` The default string used to indicate the 'local' access tag - implicitly declared in config.xml.

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