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

Field Summary

	static long	MENUITEM_ADDRESSBOOK_LIST ApplicationMenuItem instances registered with this ID appear when the address book is open in list mode.
	static long	MENUITEM_ADDRESSCARD_EDIT ApplicationMenuItem instances registered with this ID appear when an address card is open in edit mode.
	static long	MENUITEM_ADDRESSCARD_VIEW ApplicationMenuItem instances registered with this ID appear when an address card is open in view mode.
	static long	MENUITEM_ALARM ApplicationMenuItem instances registered with this ID appear when the alarm application is running.
	static long	MENUITEM_BROWSER ApplicationMenuItem instances registered with this ID appear when the browser application is running.
	static long	MENUITEM_CALENDAR ApplicationMenuItem instances registered with this ID appear when the calendar is open in view mode.
	static long	MENUITEM_CALENDAR_EVENT ApplicationMenuItem instances registered with this ID appear when a calendar event is open in view/edit mode.
	static long	MENUITEM_EMAIL_EDIT ApplicationMenuItem instances registered with this ID appear when the email application is open in edit mode.
	static long	MENUITEM_EMAIL_VIEW ApplicationMenuItem instances registered with this ID appear when the email application is open in view mode.
	static long	MENUITEM_GROUPADDRESS_EDIT ApplicationMenuItem instances registered with this ID appear when a group address entry is opened for edit.
	static long	MENUITEM_GROUPADDRESS_VIEW ApplicationMenuItem instances registered with this ID appear when a group address entry is opened for viewing.
	static long	MENUITEM_MEMO_EDIT ApplicationMenuItem instances registered with this ID appear when a memo is opened for editing.
	static long	MENUITEM_MEMO_LIST ApplicationMenuItem instances registered with this ID appear when the memo list is displayed.
	static long	MENUITEM_MEMO_VIEW ApplicationMenuItem instances registered with this ID appear when a memo is opened for viewing.
	static long	MENUITEM_MESSAGE_LIST ApplicationMenuItem instances registered with this ID appear when the message list is displayed.
	static long	MENUITEM_PHONE ApplicationMenuItem instances registered with this ID appear when the phone application is running.
	static long	MENUITEM_PHONELOG_VIEW ApplicationMenuItem instances registered with this ID appear when a call log is opened for viewing.
	static long	MENUITEM_SEARCH ApplicationMenuItem instances registered with this ID appear when the search window is open.
	static long	MENUITEM_SYSTEM ApplicationMenuItem instances registered with this ID appear on most application menus (a system wide setting).
	static long	MENUITEM_TASK_EDIT ApplicationMenuItem instances registered with this ID appear when a task is opened in view/edit mode.
	static long	MENUITEM_TASK_LIST ApplicationMenuItem instances registered with this ID appear when the task list is displayed.

Method Summary

	void	addMenuItem(long id, ApplicationMenuItem item) Adds a menu item to the application menu.
	static ApplicationMenuItemRepository	getInstance() Retrieves a handle to the systems application menu item repository.
	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

ApplicationMenuItem instances registered with this ID appear when the email application is open in view mode.

The ApplicationMenuItem.run(Object) method is passed a Message instance when an application menu item is invoked in this context.

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

ApplicationMenuItem instances registered with this ID appear when the email application is open in edit mode.

The ApplicationMenuItem.run(Object) method is passed a Message instance when an application menu item is invoked in this context.

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

ApplicationMenuItem instances registered with this ID appear when the address book is open in list mode.

The ApplicationMenuItem.run(Object) method is passed a Contact instance when an application menu item is invoked in this context.

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

ApplicationMenuItem instances registered with this ID appear when an address card is open in edit mode.

The ApplicationMenuItem.run(Object) method is passed a Contact instance when an application menu item is invoked in this context.

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

ApplicationMenuItem instances registered with this ID appear when an address card is open in view mode.

The ApplicationMenuItem.run(Object) method is passed a Contact instance when an application menu item is invoked in this context.

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

ApplicationMenuItem instances registered with this ID appear when the calendar is open in view mode.

The ApplicationMenuItem.run(Object) method is passed a Event instance when an application menu item is invoked in this context.

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_EVENT

public static final long MENUITEM_CALENDAR_EVENT

ApplicationMenuItem instances registered with this ID appear when a calendar event is open in view/edit mode.

The ApplicationMenuItem.run(Object) method is passed a Event instance when an application menu item is invoked in this context.

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.

MENUITEM_MESSAGE_LIST

public static final long MENUITEM_MESSAGE_LIST

ApplicationMenuItem instances registered with this ID appear when the message list is displayed.

The ApplicationMenuItem.run(Object) method is passed a Message instance when an application menu item is invoked in this context.

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_TASK_LIST

public static final long MENUITEM_TASK_LIST

ApplicationMenuItem instances registered with this ID appear when the task list is displayed.

The ApplicationMenuItem.run(Object) method is passed a ToDo instance when an application menu item is invoked in this context.

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.

MENUITEM_TASK_EDIT

public static final long MENUITEM_TASK_EDIT

ApplicationMenuItem instances registered with this ID appear when a task is opened in view/edit mode.

The ApplicationMenuItem.run(Object) method is passed a ToDo instance when an application menu item is invoked in this context.

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.

MENUITEM_MEMO_LIST

public static final long MENUITEM_MEMO_LIST

ApplicationMenuItem instances registered with this ID appear when the memo list is displayed.

The ApplicationMenuItem.run(Object) method is passed a BlackBerryMemo instance when an application menu item is invoked in this context.

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.

MENUITEM_MEMO_EDIT

public static final long MENUITEM_MEMO_EDIT

ApplicationMenuItem instances registered with this ID appear when a memo is opened for editing.

The ApplicationMenuItem.run(Object) method is passed a BlackBerryMemo instance when an application menu item is invoked in this context.

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.

MENUITEM_MEMO_VIEW

public static final long MENUITEM_MEMO_VIEW

ApplicationMenuItem instances registered with this ID appear when a memo is opened for viewing.

The ApplicationMenuItem.run(Object) method is passed a BlackBerryMemo instance when an application menu item is invoked in this context.

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.

MENUITEM_PHONELOG_VIEW

public static final long MENUITEM_PHONELOG_VIEW

ApplicationMenuItem instances registered with this ID appear when a call log is opened for viewing.

The ApplicationMenuItem.run(Object) method is passed a net.rim.blackberry.api.phone.phonelogs.PhoneLog instance when an application menu item is invoked in this context.

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.

MENUITEM_PHONE

public static final long MENUITEM_PHONE

ApplicationMenuItem instances registered with this ID appear when the phone application is running.

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.

MENUITEM_ALARM

public static final long MENUITEM_ALARM

ApplicationMenuItem instances registered with this ID appear when the alarm application is running.

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.

MENUITEM_SEARCH

public static final long MENUITEM_SEARCH

ApplicationMenuItem instances registered with this ID appear when the search window is open.

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.

MENUITEM_GROUPADDRESS_EDIT

public static final long MENUITEM_GROUPADDRESS_EDIT

ApplicationMenuItem instances registered with this ID appear when a group address entry is opened for edit.

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.

MENUITEM_GROUPADDRESS_VIEW

public static final long MENUITEM_GROUPADDRESS_VIEW

ApplicationMenuItem instances registered with this ID appear when a group address entry is opened for viewing.

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.

MENUITEM_BROWSER

public static final long MENUITEM_BROWSER

ApplicationMenuItem instances registered with this ID appear when the browser application is running.

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.

MENUITEM_SYSTEM

public static final long MENUITEM_SYSTEM

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

The ApplicationMenuItem.run(Object) method is passed a context object that is appropriate to the application from which the application menu item is invoked. For example, if it is invoked in the mail application, the context object is a Message 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.

Method Detail

getInstance

public static ApplicationMenuItemRepository getInstance()

Retrieves a handle to the systems application menu item repository.

Returns:

Handle to the system's repository.

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

Note that if any of the following conditions are true then the menu item will not be added and this method will return normally.

• item==null
• item.toString() returns null
• item.toString().trim().length() == 0
• item.toString() throws an exception

Parameters:

id - Repository ID.

item - The item to add to 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.

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