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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:
JDE 3.6.0

Field Summary
 Category: Signed static long MENUITEM_ADDRESSBOOK_LIST
          ApplicationMenuItem instances registered with this ID appear when the address book is open in list mode.
 Category: Signed static long MENUITEM_ADDRESSCARD_EDIT
          ApplicationMenuItem instances registered with this ID appear when an address card is open in edit mode.
 Category: Signed static long MENUITEM_ADDRESSCARD_VIEW
          ApplicationMenuItem instances registered with this ID appear when an address card is open in view mode.
 Category: Signed static long MENUITEM_ALARM
          ApplicationMenuItem instances registered with this ID appear when the alarm application is running.
 Category: Signed static long MENUITEM_BROWSER
          ApplicationMenuItem instances registered with this ID appear when the browser application is running.
 Category: Signed static long MENUITEM_CALENDAR
          ApplicationMenuItem instances registered with this ID appear when the calendar is open in view mode.
 Category: Signed static long MENUITEM_CALENDAR_EVENT
          ApplicationMenuItem instances registered with this ID appear when a calendar event is open in view/edit mode.
 Category: Signed static long MENUITEM_EMAIL_EDIT
          ApplicationMenuItem instances registered with this ID appear when the email application is open in edit mode.
 Category: Signed static long MENUITEM_EMAIL_VIEW
          ApplicationMenuItem instances registered with this ID appear when the email application is open in view mode.
 Category: Signed static long MENUITEM_FILE_EXPLORER
          ApplicationMenuItem instances registered with this ID appear when the File Explorer applicaion is running.
 Category: Signed static long MENUITEM_FILE_EXPLORER_BROWSE
          ApplicationMenuItem instances registered with this ID appear when the File Explorer applicaion is running in the browse view.
 Category: Signed static long MENUITEM_FILE_EXPLORER_ITEM
          ApplicationMenuItem instances registered with this ID appear when the File Explorer applicaion is running and rendering a file.
 Category: Signed static long MENUITEM_GROUPADDRESS_EDIT
          ApplicationMenuItem instances registered with this ID appear when a group address entry is opened for edit.
 Category: Signed static long MENUITEM_GROUPADDRESS_VIEW
          ApplicationMenuItem instances registered with this ID appear when a group address entry is opened for viewing.
 Category: Signed static long MENUITEM_MAPS
          ApplicationMenuItem instances registered with this ID appear when the maps application is running.
 Category: Signed static long MENUITEM_MEMO_EDIT
          ApplicationMenuItem instances registered with this ID appear when a memo is opened for editing.
 Category: Signed static long MENUITEM_MEMO_LIST
          ApplicationMenuItem instances registered with this ID appear when the memo list is displayed.
 Category: Signed static long MENUITEM_MEMO_VIEW
          ApplicationMenuItem instances registered with this ID appear when a memo is opened for viewing.
 Category: Signed static long MENUITEM_MESSAGE_LIST
          ApplicationMenuItem instances registered with this ID appear when the message list is displayed.
 Category: Signed static long MENUITEM_MMS_EDIT
          ApplicationMenuItem instances registered with this ID appear when the MMS application is open in edit mode.
 Category: Signed static long MENUITEM_MMS_VIEW
          ApplicationMenuItem instances registered with this ID appear when the MMS application is open in view mode.
 Category: Signed static long MENUITEM_PHONE
          ApplicationMenuItem instances registered with this ID appear when the phone application is running.
 Category: Signed static long MENUITEM_PHONELOG_VIEW
          ApplicationMenuItem instances registered with this ID appear when a call log is opened for viewing.
 Category: Signed static long MENUITEM_SEARCH
          ApplicationMenuItem instances registered with this ID appear when the search window is open.
 Category: Signed static long MENUITEM_SMS_EDIT
          ApplicationMenuItem instances registered with this ID appear when the SMS application is open in edit mode.
 Category: Signed static long MENUITEM_SMS_VIEW
          ApplicationMenuItem instances registered with this ID appear when the SMS application is open in view mode.
 Category: Signed static long MENUITEM_SYSTEM
          ApplicationMenuItem instances registered with this ID appear on most application menus (a system wide setting).
 Category: Signed static long MENUITEM_TASK_EDIT
          ApplicationMenuItem instances registered with this ID appear when a task is opened in view/edit mode.
 Category: Signed static long MENUITEM_TASK_LIST
          ApplicationMenuItem instances registered with this ID appear when the task list is displayed.
 
Method Summary
 Category: Signed  void addMenuItem(long id, ApplicationMenuItem item)
          Adds a menu item to the application menu.
 Category: Signed  void addMenuItem(long id, ApplicationMenuItem item, ApplicationDescriptor application)
          Adds a menu item to the application menu.
 Category: Signed  void addMenuItem(long id, ApplicationMenuItem item, ApplicationDescriptor application, Object context)
          Adds a menu item to the application menu.
 Category: Signed static ApplicationMenuItemRepository getInstance()
          Retrieves a handle to the systems application menu item repository.
 Category: Signed  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_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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

MENUITEM_FILE_EXPLORER

public static final long MENUITEM_FILE_EXPLORER
ApplicationMenuItem instances registered with this ID appear when the File Explorer applicaion is running. If you use this ID, you must also provide an ApplicationDescriptor that describes your application. Your application will be started to run the code in the ApplicationMenuItem.run() method. You may also register a mime type String with your menu item as the context parameter. If you do, your menu item will only appear when a file matching the registered mime type is in focus or being viewed.

The ApplicationMenuItem.run(Object) method is passed a String instance (the path to the file), when an application menu item is invoked in this context.

Since:
JDE 4.2.1
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

MENUITEM_FILE_EXPLORER_BROWSE

public static final long MENUITEM_FILE_EXPLORER_BROWSE
ApplicationMenuItem instances registered with this ID appear when the File Explorer applicaion is running in the browse view. If you use this ID, you must also provide an ApplicationDescriptor that describes your application. Your application will be started to run the code in the ApplicationMenuItem.run() method. You may also register a mime type String with your menu item as the context parameter. If you do, your menu item will only appear when a file matching the registered mime type is in focus.

The ApplicationMenuItem.run(Object) method is passed a String instance (the path to the file), when an application menu item is invoked in this context.

Since:
JDE 4.2.1
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

MENUITEM_FILE_EXPLORER_ITEM

public static final long MENUITEM_FILE_EXPLORER_ITEM
ApplicationMenuItem instances registered with this ID appear when the File Explorer applicaion is running and rendering a file. If you use this ID, you must also provide an ApplicationDescriptor that describes your application. Your application will be started to run the code in the ApplicationMenuItem.run() method. You may also register a mime type String with your menu item as the context parameter. If you do, your menu item will only appear when a file matching the registered mime type is being viewed.

The ApplicationMenuItem.run(Object) method is passed a String instance (the path to the file), when an application menu item is invoked in this context.

Since:
JDE 4.2.1
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

MENUITEM_MAPS

public static final long MENUITEM_MAPS
ApplicationMenuItem instances registered with this ID appear when the maps application is running. An ApplicationDescriptor is required for this ID in addMenuItem() method

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

Since:
JDE 4.2.1
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

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 or a TextMessage instance when an application menu item is invoked in this context. If the selected message is a MMS message, a MultipartMessage instance will be passed instead.

Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

MENUITEM_MMS_EDIT

public static final long MENUITEM_MMS_EDIT
ApplicationMenuItem instances registered with this ID appear when the MMS application is open in edit mode.

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

Since:
JDE 4.3.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

MENUITEM_MMS_VIEW

public static final long MENUITEM_MMS_VIEW

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

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

Since:
JDE 4.3.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

MENUITEM_SMS_EDIT

public static final long MENUITEM_SMS_EDIT
ApplicationMenuItem instances registered with this ID appear when the SMS application is open in edit mode.

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

Since:
JDE 4.2.1
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

MENUITEM_SMS_VIEW

public static final long MENUITEM_SMS_VIEW

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

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

Since:
JDE 4.2.1
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Method Detail

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
  • An ApplicationDescriptor is required for the specified ID but is not provided (use one of the overloaded methods below instead)
Parameters:
id - Repository ID.
item - The item to add to the menu.
Throws:
ControlledAccessException - if access to the resource of the specified id is forbidden by application control.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

addMenuItem

public void addMenuItem(long id,
                        ApplicationMenuItem item,
                        ApplicationDescriptor application)
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
  • An ApplicationDescriptor is required for the specified ID but is not provided
  • An ApplicationDescriptor is provided, but its module handle does not match the module handle for the application registering the menu item
Parameters:
id - Repository ID.
item - The item to add to the menu.
application - An ApplicationDescriptor that describes your application. Required for certain repository IDs (see ID definitions for more information).
Throws:
ControlledAccessException - if access to the resource of the specified id is forbidden by application control.
Since:
JDE 4.2.1
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

addMenuItem

public void addMenuItem(long id,
                        ApplicationMenuItem item,
                        ApplicationDescriptor application,
                        Object context)
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
  • An ApplicationDescriptor is required for the specified ID but is not provided
  • An ApplicationDescriptor is provided, but its module handle does not match the module handle for the application registering the menu item
  • The context provided is the wrong type of Object for the specified ID
Parameters:
id - Repository ID.
item - The item to add to the menu.
application - An ApplicationDescriptor that describes your application. Required for certain repository IDs (see ID definitions for more information).
context - An object representing a context in which the menu item should be displayed. Only works with certain repository IDs (see ID definitions for more information).
Throws:
ControlledAccessException - if access to the resource of the specified id is forbidden by application control.
Since:
JDE 4.2.1
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

getInstance

public static ApplicationMenuItemRepository getInstance()
Retrieves a handle to the systems application menu item repository.
Returns:
Handle to the system's repository.
Throws:
ControlledAccessException - if interprocess communication (IPC) is forbidden by application control.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

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; if null then this method immediately returns false without doing anything.
Returns:
true if the menu item was removed, false otherwise.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.



Copyright 1999-2008 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.