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 clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:

JDE 4.1.0

Method Summary

	static String	getActiveThemeName() Returns the name of the active theme
	static int	getPreferredIconHeight() Returns the preferred icon height as per the active theme
	static int	getPreferredIconWidth() Returns the preferred icon width as per the active theme
	static void	setRolloverIcon(Bitmap rollovericon) Sets the rollover icon for use with this application.
	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 Note:Changes made via this api are NOT persisted across resets
	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

updateIcon

public static final void updateIcon(Bitmap newicon)

Update the current application's icon
Note:Changes made via this api are NOT persisted across resets

Parameters:

newicon - the new icon

Since:

JDE 4.1.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

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.
Note:Changes made via this api are NOT persisted across resets

Parameters:

newicon - the new icon

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 clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

setRolloverIcon

public static final void setRolloverIcon(Bitmap rollovericon)

Sets the rollover icon for use with this application.
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

Since:

JDE 4.1.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

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.
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

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 clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

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 clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

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 clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getPreferredIconHeight

public static final int getPreferredIconHeight()

Returns the preferred icon height as per the active theme

Returns:

the preferred icon height in pixels. a return value of 0 indicates the current theme does not support icons.

Since:

JDE 4.1.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getPreferredIconWidth

public static final int getPreferredIconWidth()

Returns the preferred icon width as per the active theme

Returns:

the preferred icon width in pixels. a return value of 0 indicates the current theme does not support icons.

Since:

JDE 4.1.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.