SHOW Signed

net.rim.blackberry.api.menuitem
Class ApplicationMenuItem

java.lang.Object
  |
  +--net.rim.blackberry.api.menuitem.ApplicationMenuItem

public abstract class ApplicationMenuItem

extends Object

Provides the functionality for adding items to application menus.

Developers should extend an instance of this class and register your instance with the ApplicationMenuItemRepository. Register your instance along with an appropriate context ID, which will define when your item will appear, as defined by the contants in MenuItemRepository.

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 3.6.0

Constructor Summary

	ApplicationMenuItem(int order) Creates a new ApplicationMenuItem instance with provided menu position.
	ApplicationMenuItem(Object context, int order) Creates a new ApplicationMenuItem instance with provided context and menu position.

Method Summary

	boolean	equals(Object o) Determines if this menu item is equal to the provided object.
	int	hashCode() Retrieves a hash code value for this menu item.
	abstract Object	run(Object context) Runs the menu item given the context.
	abstract String	toString() Retrieves name menu item should use for display in a menu.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ApplicationMenuItem

public ApplicationMenuItem(Object context,
                           int order)

Creates a new ApplicationMenuItem instance with provided context and menu position.

This constructor builds a new ApplicationMenuItem given the item information and an integer representing the position of the item within the menu.

Developers should override this method to take custom actions on the context parameter.

Parameters:

context - Generic object containing context specific data.

order - Display order of this item, lower numbers correspond to higher placement in the menu (relative, an entry of 0 won't necessarily result in the top most item).

Since:

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

ApplicationMenuItem

public ApplicationMenuItem(int order)

Creates a new ApplicationMenuItem instance with provided menu position.

Parameters:

order - Display order of this item, lower numbers correspond to higher placement in the menu (relative, an entry of 0 won't necessarily result in the top most item).

Since:

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

Method Detail

run

public abstract Object run(Object context)

Runs the menu item given the context.

Developers should override this method and implement specific menu handling.

Parameters:

context - Object containing the context specific information.

Returns:

New context object.

Since:

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

toString

public abstract String toString()

Retrieves name menu item should use for display in a menu.

Sub-classes should override this to provide the name the menu item should use for display in a menu.

Overrides:

toString in class Object

Returns:

String describing this menu item; must not be null.

Since:

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

equals

public boolean equals(Object o)

Determines if this menu item is equal to the provided object.

Overrides:

equals in class Object

Parameters:

o - Object to test against this menu item.

Returns:

True if provided object is the same object as this menu item, or if provided object is an ApplicationMenuItem with identical characteristics; otherwise, false.

Since:

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

hashCode

public int hashCode()

Retrieves a hash code value for this menu item.

Note: this method builds a hash out this menu item's current position, a hash of it's cookie, and a hash of the results of toString().

Overrides:

hashCode in class Object

Returns:

SHA-1 hash value for this menu item.

Since:

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