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

See Also:

ApplicationMenuItemRepository

Constructor Summary

	ApplicationMenuItem(int order) Creates an ApplicationMenuItem given an integer representing the position of the item within the menu.
	ApplicationMenuItem(Object context, int order) Creates an ApplicationMenuItem instance given the item information and an integer representing the position of the item within the menu.

Method Summary

	boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
	int	hashCode() Returns a hash code value for the object.
	abstract Object	run(Object context) Runs the menu item given the context.
	abstract String	toString() Developers should override this method and return the string to render in the menu.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ApplicationMenuItem

public ApplicationMenuItem(Object context,
                           int order)

Creates an ApplicationMenuItem instance 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 - A generic object containing context specific data.

order - A 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 an ApplicationMenuItem given an integer representing the position of the item within the menu.

This is the default constructor.

Parameters:

order - An integer representing the order of the item in the menu.

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 - The object containing the context specific information.

Returns:

The new context object.

Since:

JDE 3.7.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()

Developers should override this method and return the string to render in the menu.

Overrides:

toString in class Object

Returns:

A 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)

Description copied from class: Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation:

• It is reflexive: for any reference value x, x.equals(x) should return true.
• It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the object is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).

Overrides:

equals in class Object

Since:

JDE 3.7.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()

Description copied from class: Object

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Overrides:

hashCode in class Object

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.