jcontrol.ui.wombat
Class ComboBox

java.lang.Object
  jcontrol.ui.wombat.Component
      jcontrol.ui.wombat.AbstractFocusComponent
          jcontrol.ui.wombat.AbstractScrolledComponent
              jcontrol.ui.wombat.ComboBox

All Implemented Interfaces:

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

public class ComboBox
extends AbstractScrolledComponent

The class ComboBox implements a choice user interface object. Use the select-, up- and down-keys on the keyboard or the touch screen to open the combo box and to select an item.

When an item is selected, an ActionEvent of type ActionEvent.ITEM_SELECTED is fired.

(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

ComboBox(int x, int y, int width)
Constructs a new empty ComboBox at the given x- and y-coordinates.

ComboBox(java.lang.String[] items, int x, int y, int width)
Constructs a new ComboBox with a list of items at the given x- and y-coordinates with the specified width and height.

Method Summary

void	add(java.lang.String item) Adds an item to this ComboBox.
int	getSelectedIndex() Returns the currently selected index.
java.lang.String	getSelectedItem() Returns the currently selected item
KeyEvent	onKeyEvent(KeyEvent e) Handle key events.
int	onTouchEvent(TouchEvent e) If a TouchEvent accurs, this method is called.
void	paint(jcontrol.graphics.XGraphics g) Paint this ComboBox.
boolean	remove(java.lang.String item) Removes the first occurrence of item from the ComboBox.
void	setItems(java.lang.String[] items) Sets/resets the list of items in this ComboBox.
java.lang.String	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, requestFocus, setActionListener, setEnabled, setVisible

Methods inherited from class jcontrol.ui.wombat.Component

getFrame, isEnabled, isVisible, 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

ComboBox

public ComboBox(int x,
                int y,
                int width)

Constructs a new empty ComboBox at the given x- and y-coordinates. The preferred width and height is internally computed by taking the contained items dimensions.

Parameters:

x - The x-coordinate of this ComboBox.

y - The y-coordinate of this ComboBox.

width - The preferred width of this ComboBox. The ComboBox is enlarged if the text width exceeds this value.

ComboBox

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

Constructs a new ComboBox with a list of items at the given x- and y-coordinates with the specified width and height.

Parameters:

items - An array of text-items.

x - The x-coordinate of this ComboBox.

y - The y-coordinate of this ComboBox.

width - The width of this ComboBox.

Method Detail

add

public void add(java.lang.String item)

Adds an item to this ComboBox.

Parameters:

item - The item to add to the ComboBox.

getSelectedIndex

public int getSelectedIndex()

Returns the currently selected index.

Returns:

the selected index

getSelectedItem

public java.lang.String getSelectedItem()

Returns the currently selected item

Returns:

the selected item

onKeyEvent

public KeyEvent onKeyEvent(KeyEvent e)

Handle key events. On several user actions, an ActionEvent is fired.

Specified by:

onKeyEvent in interface KeyListener

Specified by:

onKeyEvent in class AbstractFocusComponent

Parameters:

e - the event that contains information about the key.

Returns:

null if the KeyEvent has been consumed by the KeyListener,
or the the specified KeyEvent if it should be passed on to the next KeyListener.

onTouchEvent

public int onTouchEvent(TouchEvent e)

If a TouchEvent accurs, this method is called.

Specified by:

onTouchEvent in interface TouchListener

Specified by:

onTouchEvent in class AbstractFocusComponent

Parameters:

e - the TouchEvent.

Returns:

RESULT_ACCEPTED if the TouchEvent has been consumed by the TouchListener,
RESULT_EXECUTED if the TouchEvent has been consumed by the TouchListener and some important action has been performed, e.g. an action event has been invoked,
RESULT_NONE if the TouchEvent should be passed on to the next TouchListener.

paint

public void paint(jcontrol.graphics.XGraphics g)

Paint this ComboBox. Don't call this method directly.

Overrides:

paint in class Component

Parameters:

g - the application's graphics object.

remove

public boolean remove(java.lang.String item)

Removes the first occurrence of item from the ComboBox.

Parameters:

item - The item to remove from the ComboBox.

Returns:

Success of remove operation.

setItems

public void setItems(java.lang.String[] items)

Sets/resets the list of items in this ComboBox.

Parameters:

items - the new item list.

setSelection

public java.lang.String 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:

the selected item, or null if the index is out of range or the ComboBox was open and therefore, the item could not be selected.