SHOW Signed
 

net.rim.blackberry.api.homescreen
Class HomeScreen

java.lang.Object
  |
  +--net.rim.blackberry.api.homescreen.HomeScreen

public final class HomeScreen
extends Object

APIs for accessing the home screen

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:
JDE 4.1.0

Method Summary
 Category: Signed static String getActiveThemeName()
          Returns the name of the active theme
 Category: Signed static int getPreferredIconHeight()
          Returns the preferred icon height as per the active theme
 Category: Signed static int getPreferredIconWidth()
          Returns the preferred icon width as per the active theme
 Category: Signed static void setName(String name)
          Update the current application's name.
 Category: Signed 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.
 Category: Signed static void setRolloverIcon(Bitmap rollovericon)
          Sets the rollover icon for use with this application.
 Category: Signed static void setRolloverIcon(Bitmap rollovericon, int index)
          Sets the rollover icon for use with this application entry point.
 Category: Signed static boolean supportsIcons()
          Returns true if the current theme supports icons
 Category: Signed static void updateIcon(Bitmap newIcon)
          Update the current application's icon.
 Category: Signed 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

getActiveThemeName

public static final String getActiveThemeName()
Returns the name of the active theme
Returns:
the name of the active theme
Since:
JDE 4.1.0
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.

getPreferredIconHeight

public static final int getPreferredIconHeight()
Returns the preferred icon height as per the active theme
Returns:
the preferred icon height in pixels. Returns 0 if there is no active theme. If the active theme does not support icons (that is, if supportsIcons() returns false) then the value returned by this method is undefined.
Since:
JDE 4.1.0
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.

getPreferredIconWidth

public static final int getPreferredIconWidth()
Returns the preferred icon width as per the active theme
Returns:
the preferred icon width in pixels. Returns 0 if there is no active theme. If the active theme does not support icons (that is, if supportsIcons() returns false) then the value returned by this method is undefined.
Since:
JDE 4.1.0
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.

setName

public static final void setName(String name)
Update the current application's name. If name is null, then the application's default name, as specified in the original project workspace, is used.

Note: Changes made via this API are NOT persisted across resets.

Parameters:
name - the new name, or null if the application's default name is to be used.
Since:
JDE 4.2.0
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.

setName

public static final 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. The index corresponds to the order in which alternate entry points were created in the original project workspace, and can be determined via the .rapc file generated for the project. If name is null, then the application's default name, as specified in the original project workspace, is used.

Note: Changes made via this API are NOT persisted across resets.

Parameters:
name - the new name, or null if the application's default name is to be used.
index - the index of the entry point to update, from 0.
Throws:
IllegalArgumentException - if the index doesn't correspond to a valid entry point.
Since:
JDE 4.2.0
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.

setRolloverIcon

public static final void setRolloverIcon(Bitmap rollovericon)
Sets the rollover icon for use with this application. If rollovericon is null, then the application's default rollover icon, as specified in the original project workspace, is used.

Note: If you have never before specified a main application icon for the application, you will need to 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 via this API are NOT persisted across resets

Parameters:
rollovericon - the 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.
Since:
JDE 4.1.0
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.

setRolloverIcon

public static final void setRolloverIcon(Bitmap rollovericon,
                                         int index)
Sets the rollover icon for use with this application entry point. The index corresponds to the order in which alternate entry points were created in the original project workspace, and can be determined via the .rapc file generated for the project. If rollovericon is null, then the application's default rollover icon, as specified in the original project workspace, is used.

Note: If you have never before specified a main application icon for the application, you will need to 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 via this API are NOT persisted across resets

Parameters:
rollovericon - the 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 - the index of the application entry point to update
Throws:
IllegalArgumentException - if the index doesn't correspond to a valid entry point
Since:
JDE 4.1.0
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.

supportsIcons

public static final boolean supportsIcons()
Returns true if the current theme supports icons
Returns:
true if the current theme supports icons
Since:
JDE 4.1.0
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.

updateIcon

public static final void updateIcon(Bitmap newIcon)
Update the current application's icon. If newIcon is null, then the application's default icon, as specified in the original project workspace, is used.

Note: Changes made via this API are NOT persisted across resets.

Parameters:
newIcon - the new icon, or null if the application's default icon is to be used.
Since:
JDE 4.1.0
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.

updateIcon

public static final 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. The index corresponds to the order in which alternate entry points were created in the original project workspace, and can be determined via the .rapc file generated for the project. If newIcon is null, then the application's default icon, as specified in the original project workspace, is used.

Note: Changes made via this API are NOT persisted across resets

Parameters:
newIcon - the new icon, or null if the application's default icon is to be used.
index - the index of the entry point to update, from 0.
Throws:
IllegalArgumentException - if the index doesn't correspond to a valid entry point
Since:
JDE 4.1.0
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.



Copyright 1999-2008 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.