SHOW Signed

net.rim.blackberry.api.menuitem
Class ApplicationMenuItemRepository

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

public final class ApplicationMenuItemRepository

extends Object

Contains the functionality necessary for registering ApplicationMenuItem instances.

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:

ApplicationMenuItem

Field Summary

	static long	MENUITEM_ADDRESSBOOK_LIST Represents a specific context, in this case, when the addressbook is open in list mode.
	static long	MENUITEM_ADDRESSCARD_EDIT Represents a specific context, in this case, when an address card is open in edit mode.
	static long	MENUITEM_ADDRESSCARD_VIEW Represents a specific context, in this case, when an address card is open in view mode.
	static long	MENUITEM_CALENDAR Represents a specific context, in this case, when the calendar is open in view mode.
	static long	MENUITEM_EMAIL_EDIT Represents a specific context, in this case, when the email is open in edit mode.
	static long	MENUITEM_EMAIL_VIEW Represents a specific context, in this case, when the email is open in view mode.
	static long	MENUITEM_MESSAGE_LIST Represents a specific context, in this case, when the message list is displayed.
	static long	MENUITEM_SYSTEM ApplicationMenuItem instances registered with this ID will appear on most application menus (a system wide setting).

Method Summary

	void	addMenuItem(long id, ApplicationMenuItem item) Adds a menu item to the menu.
	static ApplicationMenuItemRepository	getInstance() Returns the ApplicationMenuItemRepository instance.
	boolean	removeMenuItem(long id, ApplicationMenuItem item) Removes a given item from a menu.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MENUITEM_EMAIL_VIEW

public static final long MENUITEM_EMAIL_VIEW

Represents a specific context, in this case, when the email is open in view mode.

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.

MENUITEM_EMAIL_EDIT

public static final long MENUITEM_EMAIL_EDIT

Represents a specific context, in this case, when the email is open in edit mode.

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.

MENUITEM_ADDRESSBOOK_LIST

public static final long MENUITEM_ADDRESSBOOK_LIST

Represents a specific context, in this case, when the addressbook is open in list mode.

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.

MENUITEM_ADDRESSCARD_EDIT

public static final long MENUITEM_ADDRESSCARD_EDIT

Represents a specific context, in this case, when an address card is open in edit mode.

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.

MENUITEM_ADDRESSCARD_VIEW

public static final long MENUITEM_ADDRESSCARD_VIEW

Represents a specific context, in this case, when an address card is open in view mode.

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.

MENUITEM_CALENDAR

public static final long MENUITEM_CALENDAR

Represents a specific context, in this case, when the calendar is open in view mode.

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.

MENUITEM_MESSAGE_LIST

public static final long MENUITEM_MESSAGE_LIST

Represents a specific context, in this case, when the message list is displayed.

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.

MENUITEM_SYSTEM

public static final long MENUITEM_SYSTEM

ApplicationMenuItem instances registered with this ID will appear on most application menus (a system wide setting).

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

getInstance

public static ApplicationMenuItemRepository getInstance()

Returns the ApplicationMenuItemRepository instance.

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.

addMenuItem

public void addMenuItem(long id,
                        ApplicationMenuItem item)

Adds a menu item to the menu.

Parameters:

id - A long representing the id of the repository.

item - The item to add to the menu.

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.

removeMenuItem

public boolean removeMenuItem(long id,
                              ApplicationMenuItem item)

Removes a given item from a menu.

Parameters:

id - The id of the ApplicationMenuItemRepository.

item - The menu item to be removed.

Returns:

true if the menu item was removed, false otherwise.

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.