|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object | +--net.rim.blackberry.api.homescreen.HomeScreen
APIs for accessing the home screen.
| Method Summary | ||
|
static String |
getActiveThemeName()
Returns the name of the active theme. |
|
static int |
getPreferredIconHeight()
Returns the preferred icon height with respect to the active theme. |
|
static int |
getPreferredIconWidth()
Returns the preferred icon width with respect to the active theme. |
|
static void |
setBackgroundImage(String uri)
Sets the background image for the home screen. |
|
static void |
setName(String name)
Update the current application's name. |
|
static void |
setName(String name,
ApplicationDescriptor descriptor)
Sets name for application specified by ApplicationDescriptor parameter. |
|
static void |
setName(String name,
int index)
If the current module has multiple application entry points, use this method to update the name for one particular entry point. |
|
static void |
setRolloverIcon(Bitmap rollovericon)
Sets the rollover icon for use with this application. |
|
static void |
setRolloverIcon(Bitmap rollovericon,
ApplicationDescriptor descriptor)
Sets the rollover icon for use with application specified by ApplicationDescriptor parameter. |
|
static void |
setRolloverIcon(Bitmap rollovericon,
int index)
Sets the rollover icon for use with this application entry point. |
|
static boolean |
supportsIcons()
Returns true if the current theme supports icons |
|
static void |
updateIcon(Bitmap newIcon)
Update the current application's icon. |
|
static void |
updateIcon(Bitmap newIcon,
ApplicationDescriptor descriptor)
Updates icon for the application specified by the ApplicationDescriptor parameter. |
|
static void |
updateIcon(Bitmap newIcon,
int index)
If the current module has multiple application entry points, use this method to update the icon for one particular entry point. |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method Detail |
public static final String getActiveThemeName()
public static final int getPreferredIconHeight()
supportsIcons() returns false)
then the value returned by this method is undefined.public static final int getPreferredIconWidth()
supportsIcons() returns false)
then the value returned by this method is undefined.public static final void setBackgroundImage(String uri)
uri - Resource identifier for the image file to be used as the home screen background. A null value
or an invalid path/filename results in the default background image being reset.public static final void setName(String name)
name is null, then
the application's default name, as specified in the original project workspace, is used.
Note: Changes made using this API are NOT persisted across resets.
name - New name, or null if the application's default name is to be used.public static final void setName(String name, ApplicationDescriptor descriptor)
name is null, then the application's
default name, as specified in the original project workspace, is used.
Note: Changes made using this API are NOT persisted across resets.
name - New name, or null if the application's
default name is to be used.descriptor - Application descriptor that points to the application.IllegalArgumentException - if the index doesn't correspond to a valid entry point.public static final void setName(String name, int index)
name is null, then the application's
default name, as specified in the original project workspace, is used.
Note: Changes made using this API are NOT persisted across resets.
name - New name, or null if the application's default name is to be used.index - Index of the entry point to update, from 0.IllegalArgumentException - if the index doesn't correspond to a valid entry point.public static final void setRolloverIcon(Bitmap rollovericon)
rollovericon is
null, then the application's default rollover icon, as specified in the
original project workspace, is used.
Note: If you have not
specified a main application icon for the application, you must call
updateIcon and provide an icon before setting the rollover icon. Otherwise,
the system will override the main icon and the rollover icon as set by this method
with the default icons for the current theme.
Note: Changes made using this API are NOT persisted across resets.
rollovericon - Icon to use when the application icon is in focus on the home screen,
or null if the application's default rollover icon is to be used.public static final void setRolloverIcon(Bitmap rollovericon, ApplicationDescriptor descriptor)
Note: If you have not
specified a main application icon for the application, you must call
updateIcon and provide an icon before setting the rollover icon, otherwise
the system will override the main icon and the rollover icon as set by this method
with the default icons for the current theme.
Note: Changes made using this API are NOT persisted across resets.
rollovericon - Icon to use when the application icon is in focus on the home screen,
or null if the application's default rollover icon is to be used.descriptor - Application descriptor that points to the application.IllegalArgumentException - if the index doesn't correspond to a valid entry pointpublic static final void setRolloverIcon(Bitmap rollovericon, int index)
rollovericon is null, then the
application's default rollover icon, as specified in the original project workspace, is used.
Note: If you have not
specified a main application icon for the application, you must call
updateIcon and provide an icon before setting the rollover icon. Otherwise,
the system will override the main icon and the rollover icon as set by this method
with the default icons for the current theme.
Note: Changes made using this API are NOT persisted across resets.
rollovericon - Icon to use when the application icon is in focus on the home screen,
or null if the application's default rollover icon is to be used.index - Index of the application entry point to update.IllegalArgumentException - if the index doesn't correspond to a valid entry pointpublic static final boolean supportsIcons()
true if the current theme supports icons, false otherwise.public static final void updateIcon(Bitmap newIcon)
newIcon is null,
then the application's default icon, as specified in the original project workspace,
is used.
Note: Changes made using this API are NOT persisted across resets.
newIcon - New icon, or null if the application's default icon is to be used.public static final void updateIcon(Bitmap newIcon, ApplicationDescriptor descriptor)
Note: Changes made using this API are NOT persisted across resets.
newIcon - New icon, or null if the application's
default icon is to be used.descriptor - Application descriptor that points to the application.public static final void updateIcon(Bitmap newIcon, int index)
newIcon is null, then the application's default
icon, as specified in the original project workspace, is used.
Note: Changes made using this API are NOT persisted across resets
newIcon - New icon, or null if the application's default icon is to be used.index - Index of the entry point to update, from 0.IllegalArgumentException - if the index doesn't correspond to a valid entry point
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 1999-2009 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.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.