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 extends MenuItem {
        MyMenuItem() {
            super(MyResourceBundle.getBundle(), MyResource.MY_MENU_ITEM, 0, 100);
        }
        public void run() {
            // do something
        }
    }
 

Field Summary

static int	CANCEL_SELECT Cancel selection menu item.
static int	CHANGE_OPTION Change option menu item.
static int	CLOSE Clsoe menu item.
static int	COPY Copy menu item.
static int	CUT Cut menu item.
static Comparator	ORDINAL_COMPARATOR Menu item comparator..
static int	PASTE Paste menu item.
static int	SAVE_CLOSE Save menu item.
static int	SELECT Select menu item.

Constructor Summary

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

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

Method Summary

ResourceBundle	getBundle() Retrieves resource bundle of this menu item.
int	getId() Retrieves ID of this menu item.
int	getOrdinal() Retrieves relative ordering of this menu item.
static MenuItem	getPrefab(int id) Retrieves a prefabricated 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	setOrdinal(int ordinal) Dynamically sets the ordinal of this menu item.
void	setPriority(int priority) Dynamically sets the priority of this menu item.
void	setText(String text) Sets the text for this 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

CHANGE_OPTION

public static final int CHANGE_OPTION

Change option menu item.

Since:

JDE 4.0.0

COPY

public static final int COPY

Copy menu item.

Since:

JDE 4.0.0

CUT

public static final int CUT

Cut menu item.

Since:

JDE 4.0.0

PASTE

public static final int PASTE

Paste menu item.

Since:

JDE 4.0.0

SELECT

public static final int SELECT

Select menu item.

Since:

JDE 4.0.0

CANCEL_SELECT

public static final int CANCEL_SELECT

Cancel selection menu item.

Since:

JDE 4.0.0

CLOSE

public static final int CLOSE

Clsoe menu item.

Since:

JDE 4.0.0

SAVE_CLOSE

public static final int SAVE_CLOSE

Save menu item.

Since:

JDE 4.0.0

ORDINAL_COMPARATOR

public static final Comparator ORDINAL_COMPARATOR

Menu item comparator..

Since:

JDE 3.6.0

Constructor Detail

MenuItem

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

Constructs a new MenuItem instance.

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

Parameters:

text - The text to appear with the menu item.

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

getBundle

public ResourceBundle getBundle()

Retrieves resource bundle of this menu item.

Returns:

Resource bundle parameter passed to the constructor when this item was created.

Since:

JDE 4.0.0

getId

public int getId()

Retrieves ID of this menu item.

Returns:

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

Since:

JDE 4.0.0

getOrdinal

public int getOrdinal()

Retrieves relative ordering of this menu item.

Returns:

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

getPrefab

public static MenuItem getPrefab(int id)

Retrieves a prefabricated menu item.

Items may be cached.

Parameters:

ID - ID for prefabricated menu item.

Returns:

Prefabricated menu item.

Since:

JDE 4.0.0

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.

Returns:

True if this menu item is a separator; otherwise, false.

Since:

JDE 3.7.0

separator

public static MenuItem separator(int ordinal)

Adds a separator at the specified position (ordinal).

Parameters:

ordinal - Ordinal at which to add the separator.

Returns:

Menu item created.

Since:

JDE 3.7.0

setOrdinal

public void setOrdinal(int ordinal)

Dynamically sets the ordinal of this menu item.

Parameters:

ordinal - the value to set for the ordinal of this menu item.

Since:

JDE 4.2.0

setPriority

public void setPriority(int priority)

Dynamically sets the priority of this menu item.

Parameters:

priority - the value to set for the priority of this menu item.

Since:

JDE 4.2.0

setText

public void setText(String text)

Sets the text for this menu item.

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

Parameters:

String - Text to appear in menu.

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.