jcontrol.ui.wombat.menu
Class Menu

java.lang.Object
  jcontrol.ui.wombat.Component
      jcontrol.ui.wombat.AbstractFocusComponent
          jcontrol.ui.wombat.menu.Menu

All Implemented Interfaces:

java.util.EventListener, ActionProducer, KeyListener, TouchListener, IFocusable

Direct Known Subclasses:

MultiImageMenu

public abstract class Menu
extends AbstractFocusComponent

The abstract class Menu is the superclass for graphical menus.

(c) Copyright 2005 DOMOLOGIC GmbH

Author:

Marcus Timmermann

Field Summary

Fields inherited from class jcontrol.ui.wombat.Component

backgroundColor, COLOR_COMPONENT_BACKGROUND, COLOR_COMPONENT_BACKGROUND_HIGHLIGHTED, COLOR_COMPONENT_DARK_SHADOW, COLOR_COMPONENT_FOREGROUND, COLOR_COMPONENT_FOREGROUND_INACTIVE, COLOR_COMPONENT_HIGHLIGHT_SHADOW, COLOR_COMPONENT_LIGHT_SHADOW, COLOR_COMPONENT_LIST_BACKGROUND, COLOR_COMPONENT_NORMAL_SHADOW, COLOR_COMPONENT_SELECTION_TEXT, COLOR_COMPONENT_SELECTION_TEXT_BACKGROUND, COLOR_COMPONENT_SELECTION_TEXT_BACKGROUND_INACTIVE, COLOR_COMPONENT_SELECTION_TEXT_INACTIVE, foregroundColor, frame, height, parent, state, transparentColor, width, x, y

Fields inherited from interface jcontrol.ui.wombat.IFocusable

TRANSFER_FOCUS_BACKWARD, TRANSFER_FOCUS_FORWARD

Fields inherited from interface jcontrol.ui.wombat.event.TouchListener

RESULT_ACCEPTED, RESULT_EXECUTED, RESULT_NONE

Constructor Summary

Menu(java.lang.String[] items, int x, int y, int width, int height)

Method Summary

abstract int	addMenuItem(java.lang.String item) Adds a menu item to this menu.
int	getIndex(java.lang.String item) Returns the index of the specified item or -1 if there is no such item in this menu.
java.lang.String	getItem(int index) Returns the item at the specified index or null if the index is out of range.
int	getItemCount() Returns the number of menu items.
int	getSelectedIndex() Returns the index of the selected menu item or -1 if none is selected.
abstract int	insertMenuItem(java.lang.String item, int index) Inserts a menu item at the specified position.
abstract boolean	removeMenuItem(int index) Removes a menu at the specified index item from this menu.
void	setEnabled(int index, boolean enabled) Enables or disables the menu item at the specified index.
boolean	setSelection(int index) Selects the item at the given zero-relative index in the receiver's list.

Methods inherited from class jcontrol.ui.wombat.AbstractFocusComponent

getActionListener, onKeyEvent, onTouchEvent, requestFocus, setActionListener, setEnabled, setVisible

Methods inherited from class jcontrol.ui.wombat.Component

getFrame, isEnabled, isVisible, paint, repaint, repaintAll, safeExec, setBackgroundColor, setBounds, setDirty, setFont, setForegroundColor, setRedraw, setTransparentColor, unsafeExec, update

Methods inherited from class java.lang.Object

equals, getClass, notifyAll, toString, wait

Constructor Detail

Menu

public Menu(java.lang.String[] items,
            int x,
            int y,
            int width,
            int height)

Method Detail

addMenuItem

public abstract int addMenuItem(java.lang.String item)

Adds a menu item to this menu. This method should be used with care. Initializing a menu with a list of menu items should always be done via the constructor instead. Adding or removing items in a menu will cause an array copy which may lead to a lot of memory consumption for a short period of time.

Parameters:

item - the name of the menu item, can even specify an image name

Returns:

the index of the new menu item

See Also:

insertMenuItem(String, int)

getIndex

public int getIndex(java.lang.String item)

Returns the index of the specified item or -1 if there is no such item in this menu.

Parameters:

item - the item to search for

Returns:

the index of the specified item

getItem

public java.lang.String getItem(int index)

Returns the item at the specified index or null if the index is out of range.

Parameters:

index - the index

Returns:

the item at the specified index

getItemCount

public int getItemCount()

Returns the number of menu items.

Returns:

The numer of menu items.

getSelectedIndex

public int getSelectedIndex()

Returns the index of the selected menu item or -1 if none is selected.

Returns:

The index of the selected menu item.

insertMenuItem

public abstract int insertMenuItem(java.lang.String item,
                                   int index)

Inserts a menu item at the specified position. This method should be used with care. Initializing a menu with a list of menu items should always be done via the constructor instead. Adding or removing items in a menu will cause an array copy which may lead to a lot of memory consumption for a short period of time.

Parameters:

item - the name of the menu item, can even specify an image name

index - the position

Returns:

the index of the new menu item

See Also:

addMenuItem(String)

removeMenuItem

public abstract boolean removeMenuItem(int index)

Removes a menu at the specified index item from this menu. This method should be used with care. Adding or removing items in a menu will cause an array copy which may lead to a lot of memory consumption for a short period of time. If a menu item should be removed temporary it should better be disabled using the setEnabled(int, boolean) method instead.

Parameters:

index - the index to remove

Returns:

boolean true if the item has been removed successfully, false otherwise

See Also:

setEnabled(int, boolean)

setEnabled

public void setEnabled(int index,
                       boolean enabled)

Enables or disables the menu item at the specified index. A disabled menu item is not selectable from the user interface and draws with an inactive or "grayed" look.

Parameters:

index - the index to enable or disable

enabled - the new enabled state

setSelection

public boolean setSelection(int index)

Selects the item at the given zero-relative index in the receiver's list. If the item at the index was already selected, it remains selected. Indices that are out of range are ignored.

Parameters:

index - the index of the item to select

Returns:

boolean true if the item has been selected successfully, false otherwise