|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.rim.blackberry.api.homescreen.ShortcutProvider
public abstract class ShortcutProvider
Used to create shortcuts on the Home screen of the device.
To create a shortcut, call the static ShortcutProvider.createShortcut(java.lang.String, java.lang.String, int)
method.
Shortcut
,
HomeScreen.addShortcut()
,
ShortcutEventListener
Method Summary | ||
---|---|---|
|
static Shortcut |
createShortcut(String description,
String shortcutID)
Creates a shortcut. |
|
static Shortcut |
createShortcut(String description,
String shortcutID,
int index)
Creates a shortcut for applications that have multiple entry points. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static Shortcut createShortcut(String description, String shortcutID, int index) throws IllegalArgumentException
description
- Specifies the description of the shortcut. The description displays
when the shortcut is in focus.shortcutID
- String representing a unique ID used by the application to identify the shortcut.
For example, the Contacts application might use the ID .
.
This shortcutID must be unique across a single application. Two different applications
might have the same shortcutID.index
- The index that corresponds to the order in which alternate entry points were created in
the original BlackBerry application project from 0. Applications can create one separate alternate entry point
for all the shortcuts. This way applications can distinguish whether the application was launched
directly or whether the shortcut was launched.
IllegalArgumentException
- if the shortcutID is null
, an empty String, or white space.
IllegalArgumentException
- if the description is null
, an empty String, or white space.
IllegalArgumentException
- if a shortcut with the same ID for the same application
already exists on the Home screen.
IllegalArgumentException
- if there is no application descriptor available for the specified index.public static Shortcut createShortcut(String description, String shortcutID) throws IllegalArgumentException
description
- Specifies the description of the shortcut. The description displays
when the shortcut is in focus.shortcutID
- String representing a unique ID used by the application to identify the shortcut.
For example, the Contacts application might use the ID .
.
The shortcutID must be unique across a single application. Two different applications
might have the same shortcutID.
IllegalArgumentException
- if the shortcutID is null
, an empty String, or white space.
IllegalArgumentException
- if the description is null
, an empty String, or white space.
IllegalArgumentException
- if a shortcut with the same ID for the same application
already exists on the Home screen.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.