net.rim.device.api.web
Interface WidgetExtension

All Known Implementing Classes:
BlackBerryWidgetToolkit

public interface WidgetExtension

Interface to allow 3rd party JavaScript extensions to be registered with a widget. This interface is used by the Web Component Pack to add extensions to the Script Engine.

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 Summary
Category: Signed  String[] getFeatureList()
          Retrieves a listing of all the features available in this extension.
Category: Signed  void loadFeature(String feature, String version, Document doc, ScriptEngine scriptEngine)
          Loads the requested feature (if it exists in the extension) into the ScriptEngine.
Category: Signed  void register(WidgetConfig widgetConfig, BrowserField browserField)
          Registers the extension - information about the widget is passed to the extension.
Category: Signed  void unloadFeatures(Document doc)
          Unloads all the features associated with the document.
 



Method Detail

register

void register(WidgetConfig widgetConfig,
              BrowserField browserField)
Registers the extension - information about the widget is passed to the extension.

Parameters:
widgetConfig - Configuration info for the 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

loadFeature

void loadFeature(String feature,
                 String version,
                 Document doc,
                 ScriptEngine scriptEngine)
                 throws Exception
Loads the requested feature (if it exists in the extension) into the ScriptEngine.

Parameters:
feature - The feature to be loaded.
version - The version requested to load.
doc - The document associated with the script engine.
scriptEngine - The ScriptEngine to add the feature to.
Throws:
Exception
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

unloadFeatures

void unloadFeatures(Document doc)
Unloads all the features associated with the document.

Parameters:
doc - The document that was used to load the features.
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

getFeatureList

String[] getFeatureList()
Retrieves a listing of all the features available in this extension.

Returns:
String array of feature ID's that this extension can load.
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.