org.ascentphase.suit
Class ComboListPopup

java.lang.Object
  |
  +--Canvas
        |
        +--org.ascentphase.suit.Panel
              |
              +--org.ascentphase.suit.InputPopup
                    |
                    +--org.ascentphase.suit.ListPopup
                          |
                          +--org.ascentphase.suit.ComboListPopup

public class ComboListPopup

extends ListPopup

A ComboListPopup contains a list of selectable options plus the option to select a user-defined option that the user can specify. The options are mutually exclusive.

Version:

Author:

huyd

See Also:

Serialized Form

Field Summary

static int	CLOSE_OTHER Indicates that the user wishes to specify a user-defined option
static Command	OTHER Command event to indicate user selected user-defined option

Fields inherited from class org.ascentphase.suit.ListPopup

items, popupTitle, scroll

Fields inherited from class org.ascentphase.suit.InputPopup

CLOSE_CANCEL, CLOSE_OK, closeCmd, closeState

Fields inherited from class org.ascentphase.suit.Panel

clearReq

Constructor Summary

ComboListPopup(java.lang.String title, org.ascentphase.suit.ItemList list)
Initializes the ComboListPopup with the given form title and list of options.

ComboListPopup(java.lang.String title, org.ascentphase.suit.ItemList list, java.lang.String txtChoice)
Initializes the ComboListPopup with the given form title and list of options.

Method Summary

java.lang.String	getText() Returns the selected option that the user selected from the list.
protected void	handleCommandEvent(Command evt) Notifies any listeners when a Command event occurs.
protected void	initialize(java.lang.String initText)

Methods inherited from class org.ascentphase.suit.ListPopup

initialize

Methods inherited from class org.ascentphase.suit.InputPopup

getCloseState, setCloseCommand

Methods inherited from class org.ascentphase.suit.Panel

add, add, keyPressed, keyReleased, keyRepeated, paint, pointerDragged, pointerPressed, pointerReleased, remove, setCommandListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLOSE_OTHER

public static final int CLOSE_OTHER

Indicates that the user wishes to specify a user-defined option

See Also:

Constant Field Values

OTHER

public static final Command OTHER

Command event to indicate user selected user-defined option

Constructor Detail

ComboListPopup

public ComboListPopup(java.lang.String title,
                      org.ascentphase.suit.ItemList list)

Initializes the ComboListPopup with the given form title and list of options.

Parameters:

title - the String title of the popup.

list - the list of options to display

ComboListPopup

public ComboListPopup(java.lang.String title,
                      org.ascentphase.suit.ItemList list,
                      java.lang.String txtChoice)

Initializes the ComboListPopup with the given form title and list of options. txtChoice is the default input option. If it exists in the ItemList, it will be highlighted by default.

Parameters:

title - the String title of the popup.

list - the list of options to display

txtChoice - the default input option.

Method Detail

initialize

protected void initialize(java.lang.String initText)

getText

public java.lang.String getText()

Returns the selected option that the user selected from the list.

Overrides:

getText in class ListPopup

handleCommandEvent

protected void handleCommandEvent(Command evt)

Description copied from class: Panel

Notifies any listeners when a Command event occurs.

Overrides:

handleCommandEvent in class InputPopup

Parameters:

evt - the Command evt to pass to listeners.