net.rim.device.api.web.jse
Class BlackBerryWidgetToolkit
java.lang.Object
net.rim.device.api.web.jse.BlackBerryWidgetToolkit
- All Implemented Interfaces:
- WidgetExtension
public class BlackBerryWidgetToolkit
- extends Object
- implements WidgetExtension
Public API used to access/register BlackBerry Widget API.
- 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
EVT_KEY_BACK
public static final int EVT_KEY_BACK
- Event identifier for 'back' key press.
- 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
EVT_KEY_MENU
public static final int EVT_KEY_MENU
- Event identifier for 'menu' key press.
- 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
EVT_KEY_CONVENIENCE_1
public static final int EVT_KEY_CONVENIENCE_1
- Event identifier for convenience key 1 press.
- 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
EVT_KEY_CONVENIENCE_2
public static final int EVT_KEY_CONVENIENCE_2
- Event identifier for convenience key 2 press.
- 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
EVT_KEY_STARTCALL
public static final int EVT_KEY_STARTCALL
- Event identifier for 'Start Call' key press.
- 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
EVT_KEY_ENDCALL
public static final int EVT_KEY_ENDCALL
- Event identifier for 'End Call' key press.
- 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
EVT_KEY_VOLUME_DOWN
public static final int EVT_KEY_VOLUME_DOWN
- Event identifier for volume down key press.
- 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
EVT_KEY_VOLUME_UP
public static final int EVT_KEY_VOLUME_UP
- Event identifier for volume up key press.
- 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
EVT_APP_EXIT
public static final int EVT_APP_EXIT
- Event identifier for application exit.
- 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
EVT_APP_FOREGROUND
public static final int EVT_APP_FOREGROUND
- Event identifier for application returning to foreground.
- 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
EVT_APP_BACKGROUND
public static final int EVT_APP_BACKGROUND
- Event identifier for application returning to background.
- 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
getInstance
public static BlackBerryWidgetToolkit getInstance()
- Retrieves an instance of the BlackBerryWidgetToolkit.
- Returns:
- an instance of the BlackBerryWidgetToolkit.
- 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
register
public void register(WidgetConfig widgetConfig,
BrowserField browserField)
- Description copied from interface:
WidgetExtension
- Registers the extension - information about the widget is passed to the extension.
- Specified by:
register in interface WidgetExtension
- Parameters:
widgetConfig - Configuration info for the widget- See Also:
WidgetExtension- 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
public void loadFeature(String feature,
String version,
Document doc,
ScriptEngine scriptEngine)
throws Exception
- Description copied from interface:
WidgetExtension
- Loads the requested feature (if it exists in the extension) into the ScriptEngine.
- Specified by:
loadFeature in interface WidgetExtension
- 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- See Also:
WidgetExtension- 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
public void unloadFeatures(Document doc)
- Description copied from interface:
WidgetExtension
- Unloads all the features associated with the document.
- Specified by:
unloadFeatures in interface WidgetExtension
- Parameters:
doc - The document that was used to load the features.- See Also:
WidgetExtension- 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
public String[] getFeatureList()
- Description copied from interface:
WidgetExtension
- Retrieves a listing of all the features available in this extension.
- Specified by:
getFeatureList in interface WidgetExtension
- Returns:
- String array of feature ID's that this extension can load.
- See Also:
WidgetExtension- 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
triggerOverridableEvent
public boolean triggerOverridableEvent(int eventId,
Object[] args)
- Triggers an event that is propagated to all listeners in the library.
- Parameters:
eventId - the event ID to be triggered.args - arguments to passed into each listener.
- Returns:
- True if there is at least one listener subscribed to this event; false otherwise.
- 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.