javabook
Class ListBox

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javabook.JavaBookDialog
                                |
                                +--javabook.ListBox

public class ListBox

extends JavaBookDialog

implements java.awt.event.ActionListener

This class provides a list of items from which the user can select. Only a single selection is allowed. Appropriate status is returned when the selection is not made.

This class is provided as freeware. You are free to use as provided or modify to your heart's content. But you use it at your own risk. No implied or explicit warranty is given.

See Also:

Serialized Form

Field Summary

static int	CANCEL The Cancel button is pressed
static java.lang.String	NO_ITEM Nothing is selected
static int	NO_SELECTION Nothing is selected

Fields inherited from class javabook.JavaBookDialog

font, wasMoved

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Constructor Summary

ListBox()
Default constructor.

ListBox(java.awt.Frame owner)
Creates a modal dialog with a default title.

ListBox(java.awt.Frame owner, boolean modal)
Creates a modal or modeless dialog with a default title.

ListBox(java.awt.Frame owner, java.lang.String text)
Creates a modal dialog with its title set to the second parameter.

ListBox(java.awt.Frame owner, java.lang.String text, boolean modal)
Creates a modal or modeless dialog with its title set to the second parameter.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e) Implements the required method of the ActionListener.
void	addItem(java.lang.String item) Adds a new item to the list.
protected void	adjustSize() Adjusts the dialog.
void	deleteItem(int index) Deletes an item from the list.
void	deleteItem(java.lang.String item) Deletes an item from the list.
java.lang.String	getItemFromIndex(int index) Returns an item at the specified location in the list.
int	getSelectedIndex() Returns the position of the item selected.
java.lang.String	getSelectedItem() Returns the selected item if any.
boolean	isCanceled() Returns true if this dialog is canceled by the user
void	windowClosing(java.awt.event.WindowEvent e) The standard event handler for window closing event.

Methods inherited from class javabook.JavaBookDialog

moveToCenter, setVisible, windowActivated, windowClosed, windowDeactivated, windowDeiconified, windowIconified, windowOpened

Methods inherited from class java.awt.Dialog

addNotify, dispose, getTitle, hide, isModal, isResizable, paramString, setModal, setResizable, setTitle, show

Methods inherited from class java.awt.Window

addWindowListener, applyResourceBundle, applyResourceBundle, finalize, getFocusOwner, getInputContext, getLocale, getOwnedWindows, getOwner, getToolkit, getWarningString, isShowing, pack, postEvent, processEvent, processWindowEvent, removeWindowListener, setCursor, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setFont, setLayout, update, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputMethodRequests, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

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

Field Detail

NO_SELECTION

public static final int NO_SELECTION

Nothing is selected

CANCEL

public static final int CANCEL

The Cancel button is pressed

NO_ITEM

public static final java.lang.String NO_ITEM

Nothing is selected

Constructor Detail

ListBox

public ListBox()

Default constructor.

ListBox

public ListBox(java.awt.Frame owner)

Creates a modal dialog with a default title.

Parameters:

owner - any Frame object, but most commonly expected is a MainWindow object

ListBox

public ListBox(java.awt.Frame owner,
               java.lang.String text)

Creates a modal dialog with its title set to the second parameter.

Parameters:

owner - any Frame object, but most commonly expected is a MainWindow object

text - the title of this dialog

ListBox

public ListBox(java.awt.Frame owner,
               boolean modal)

Creates a modal or modeless dialog with a default title.

Parameters:

owner - any Frame object, but most commonly expected is a MainWindow object

modal - true for modal and false for modeless dialog

ListBox

public ListBox(java.awt.Frame owner,
               java.lang.String text,
               boolean modal)

Creates a modal or modeless dialog with its title set to the second parameter.

Parameters:

owner - any Frame object, but most commonly expected is a MainWindow object

text - the title of this dialog

modal - true for modal and false for modeless dialog

Method Detail

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Implements the required method of the ActionListener. Do not call this method. The Java virtual machine handles the action event processing. This method sets the status to ACTION_OK or ACTION_CANCEL depending on which button is clicked.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

e - the ActionEvent object.

addItem

public void addItem(java.lang.String item)

Adds a new item to the list.

Parameters:

item - a String value to be added to the list

deleteItem

public void deleteItem(int index)

Deletes an item from the list. The item to remove is identified by its position index in the list.

Parameters:

index - the position of an item to be removed

deleteItem

public void deleteItem(java.lang.String item)

Deletes an item from the list. The item (String) to remove is identified by its value.

Parameters:

item - an item to be removed

getSelectedIndex

public int getSelectedIndex()

Returns the position of the item selected. If the OK button was clicked, then the method returns the index of the selected item. If the Cancel button was clicked, then this method returns NO_SELECTION.

Returns:

status of the user selection

getItemFromIndex

public java.lang.String getItemFromIndex(int index)

Returns an item at the specified location in the list. This method returns an item at the designated position whether the item is selected or not.

Parameters:

index - position of an item in the list

Returns:

the specified item in the list

getSelectedItem

public java.lang.String getSelectedItem()

Returns the selected item if any. Appropriate status is returned if no item is selected. return the item selected by the user

isCanceled

public boolean isCanceled()

Returns true if this dialog is canceled by the user

Returns:

true if this dialog is canceled

windowClosing

public void windowClosing(java.awt.event.WindowEvent e)

The standard event handler for window closing event. This dialog is closed when the window closing event occurs.

Overrides:

windowClosing in class JavaBookDialog

Tags copied from class: JavaBookDialog

Parameters:

e - the WindowEvent object.

adjustSize

protected void adjustSize()

Adjusts the dialog. Nothing is in this method because the Panel object is used for layout.

Overrides:

adjustSize in class JavaBookDialog