net.rim.device.api.ui
Class MenuItem

java.lang.Object
  |
  +--net.rim.device.api.ui.MenuItem

All Implemented Interfaces:

Runnable

public abstract class MenuItem

extends Object

implements Runnable

Represents an abstract menu item.

Each item has an ordinal specifying the sort order within the menu, and a priority specifying which one should be the default. A lower value indicates a higher priority.

To create menu items in your own application, extend this abstract class. Your subclasses must implement the Runnable interface, which in turn supports abstract dispatching of menu actions on activation. For example

    ...
    // setup the menu items
    MenuItem item = new MyMenuItem();
    menu.addItem(item); 
    ...
    class MyMenuItem {
        MyMenuItem() {
            super(MyResourceBundle.getBundle(), MyResource.MY_MENU_ITEM, 0, 100);
        }
        public void run() {
            // do something
        }
    }
 

Field Summary

static Comparator

ORDINAL_COMPARATOR

Constructor Summary

MenuItem(ResourceBundle bundle, int id, int ordinal, int priority)
Constructs a new MenuItem.

MenuItem(String text, int ordinal, int priority)
Constructs a new MenuItem.

Method Summary

int	getOrdinal() Retrieves relative ordering of this menu item.
int	getPriority() Retrieves relative priority of this menu item.
Field	getTarget() Gets the target field for the menu.
boolean	isSeparator() Determines if this is a separator.
static MenuItem	separator(int ordinal) Adds a separator at the specified position (ordinal)
void	setText(String text) Sets the text for the menu item.
String	toString() Retrieves text string associated with this menu item.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Runnable

run

Field Detail

ORDINAL_COMPARATOR

public static final Comparator ORDINAL_COMPARATOR

Since:

JDE 3.6.0

Constructor Detail

MenuItem

public MenuItem(ResourceBundle bundle,
                int id,
                int ordinal,
                int priority)

Constructs a new MenuItem.

Parameters:

bundle - Resource bundle to support internationalization.

id - ID for this menu item (key value for the menu item's associated string in the resource bundle).

ordinal - Ordering parameter, lower values are placed closer to the top of the menu screen.

priority - Priority of the menu item. A lower value indicates a higher priority, conversely a higher value indicates a lower priority.

MenuItem

public MenuItem(String text,
                int ordinal,
                int priority)

Constructs a new MenuItem.

Parameters:

text - The text to appear with the MenuItem.

ordinal - Ordering parameter, lower values are placed closer to the top of the menu screen.

priority - The priority of the menu item. A lower value indicates a higher priority, conversely a higher value indicates a lower priority.

Since:

JDE 3.6.0

Method Detail

getOrdinal

public int getOrdinal()

Retrieves relative ordering of this menu item.

Returns:

Ordering parameter passed to the constructor when this item was created.

getPriority

public int getPriority()

Retrieves relative priority of this menu item.

A lower value indicates a higher priority. A higher value indicates a lower value.

Returns:

Priority parameter passed to the constructor when this item was created.

getTarget

public Field getTarget()

Gets the target field for the menu.

Returns:

Field object returned by invoking ContextMenu.getTarget().

isSeparator

public boolean isSeparator()

Determines if this is a separator.

Since:

JDE 3.7.0

separator

public static MenuItem separator(int ordinal)

Adds a separator at the specified position (ordinal)

Parameters:

the - ordinal at which to add the separator

Since:

JDE 3.7.0

setText

public void setText(String text)

Sets the text for the menu item.

This method sets the text string that appears in the menu for this menu item.

Parameters:

String - Text to appear in menu.

Since:

JDE 3.7.0

toString

public String toString()

Retrieves text string associated with this menu item.

This method retrieves the text string associated with this menu item. If the menu item object's locale is not the same as the current default locale, this method first sets this menu item's locale to the current default locale, and then returns the appropriate menu string from the resource bundle provided to the menu item at creation time.

Overrides:

toString in class Object

Returns:

Localized string for the menu item.