public class

List

extends Component
implements ItemSelectable Accessible

java.lang.Object
↳	java.awt.Component
	↳	java.awt.List

Class Overview

The List component presents the user with a scrolling list of text items. The list can be set up so that the user can choose either one item or multiple items.

For example, the code . . .

 List lst = new List(4, false);
 lst.add("Mercury");
 lst.add("Venus");
 lst.add("Earth");
 lst.add("JavaSoft");
 lst.add("Mars");
 lst.add("Jupiter");
 lst.add("Saturn");
 lst.add("Uranus");
 lst.add("Neptune");
 lst.add("Pluto");
 cnt.add(lst);

where cnt is a container, produces the following scrolling list:

Shows a list containing: Venus, Earth, JavaSoft, and Mars. Javasoft is selected.

If the List allows multiple selections, then clicking on an item that is already selected deselects it. In the preceding example, only one item from the scrolling list can be selected at a time, since the second argument when creating the new scrolling list is false. If the List does not allow multiple selections, selecting an item causes any other selected item to be deselected.

Note that the list in the example shown was created with four visible rows. Once the list has been created, the number of visible rows cannot be changed. A default List is created with four rows, so that lst = new List() is equivalent to list = new List(4, false).

Beginning with Java 1.1, the Abstract Window Toolkit sends the List object all mouse, keyboard, and focus events that occur over it. (The old AWT event model is being maintained only for backwards compatibility, and its use is discouraged.)

When an item is selected or deselected by the user, AWT sends an instance of ItemEvent to the list. When the user double-clicks on an item in a scrolling list, AWT sends an instance of ActionEvent to the list following the item event. AWT also generates an action event when the user presses the return key while an item in the list is selected.

If an application wants to perform some action based on an item in this list being selected or activated by the user, it should implement ItemListener or ActionListener as appropriate and register the new listener to receive events from this list.

For multiple-selection scrolling lists, it is considered a better user interface to use an external gesture (such as clicking on a button) to trigger the action.

Summary

Nested Classes
class	List.AccessibleAWTList	This class implements accessibility support for the `List` class.

[Expand]

Inherited Constants

From class java.awt.Component

From interface java.awt.image.ImageObserver

Public Constructors
	List() Creates a new scrolling list.
	List(int rows) Creates a new scrolling list initialized with the specified number of visible lines.
	List(int rows, boolean multipleMode) Creates a new scrolling list initialized to display the specified number of rows.

Public Methods
void	add(String item, int index) Adds the specified item to the the scrolling list at the position indicated by the index.
void	add(String item) Adds the specified item to the end of scrolling list.
synchronized void	addActionListener(ActionListener l) Adds the specified action listener to receive action events from this list.
void	addItem(String item) This method is deprecated. replaced by `add(String)`.
synchronized void	addItem(String item, int index) This method is deprecated. replaced by `add(String, int)`.
synchronized void	addItemListener(ItemListener l) Adds the specified item listener to receive item events from this list.
void	addNotify() Creates the peer for the list.
boolean	allowsMultipleSelections() This method is deprecated. As of JDK version 1.1, replaced by `isMultipleMode()`.
synchronized void	clear() This method is deprecated. As of JDK version 1.1, replaced by `removeAll()`.
int	countItems() This method is deprecated. As of JDK version 1.1, replaced by `getItemCount()`.
void	delItem(int position) This method is deprecated. replaced by `remove(String)` and `remove(int)`.
synchronized void	delItems(int start, int end) This method is deprecated. As of JDK version 1.1, Not for public use in the future. This method is expected to be retained only as a package private method.
synchronized void	deselect(int index) Deselects the item at the specified index.
AccessibleContext	getAccessibleContext() Gets the `AccessibleContext` associated with this `List`.
synchronized ActionListener[]	getActionListeners() Returns an array of all the action listeners registered on this list.
String	getItem(int index) Gets the item associated with the specified index.
int	getItemCount() Gets the number of items in the list.
synchronized ItemListener[]	getItemListeners() Returns an array of all the item listeners registered on this list.
synchronized String[]	getItems() Gets the items in the list.
<T extends EventListener> T[]	getListeners(Class<T> listenerType) Returns an array of all the objects currently registered as `FooListener`s upon this `List`.
Dimension	getMinimumSize() Determines the minimum size of this scrolling list.
Dimension	getMinimumSize(int rows) Gets the minumum dimensions for a list with the specified number of rows.
Dimension	getPreferredSize() Gets the preferred size of this scrolling list.
Dimension	getPreferredSize(int rows) Gets the preferred dimensions for a list with the specified number of rows.
int	getRows() Gets the number of visible lines in this list.
synchronized int	getSelectedIndex() Gets the index of the selected item on the list,
synchronized int[]	getSelectedIndexes() Gets the selected indexes on the list.
synchronized String	getSelectedItem() Gets the selected item on this scrolling list.
synchronized String[]	getSelectedItems() Gets the selected items on this scrolling list.
Object[]	getSelectedObjects() Gets the selected items on this scrolling list in an array of Objects.
int	getVisibleIndex() Gets the index of the item that was last made visible by the method `makeVisible`.
boolean	isIndexSelected(int index) Determines if the specified item in this scrolling list is selected.
boolean	isMultipleMode() Determines whether this list allows multiple selections.
boolean	isSelected(int index) This method is deprecated. As of JDK version 1.1, replaced by `isIndexSelected(int)`.
synchronized void	makeVisible(int index) Makes the item at the specified index visible.
Dimension	minimumSize(int rows) This method is deprecated. As of JDK version 1.1, replaced by `getMinimumSize(int)`.
Dimension	minimumSize() This method is deprecated. As of JDK version 1.1, replaced by `getMinimumSize()`.
Dimension	preferredSize(int rows) This method is deprecated. As of JDK version 1.1, replaced by `getPreferredSize(int)`.
Dimension	preferredSize() This method is deprecated. As of JDK version 1.1, replaced by `getPreferredSize()`.
synchronized void	remove(String item) Removes the first occurrence of an item from the list.
void	remove(int position) Removes the item at the specified position from this scrolling list.
synchronized void	removeActionListener(ActionListener l) Removes the specified action listener so that it no longer receives action events from this list.
void	removeAll() Removes all items from this list.
synchronized void	removeItemListener(ItemListener l) Removes the specified item listener so that it no longer receives item events from this list.
void	removeNotify() Removes the peer for this list.
synchronized void	replaceItem(String newValue, int index) Replaces the item at the specified index in the scrolling list with the new string.
void	select(int index) Selects the item at the specified index in the scrolling list.
void	setMultipleMode(boolean b) Sets the flag that determines whether this list allows multiple selections.
synchronized void	setMultipleSelections(boolean b) This method is deprecated. As of JDK version 1.1, replaced by `setMultipleMode(boolean)`.

Protected Methods
String	paramString() Returns the parameter string representing the state of this scrolling list.
void	processActionEvent(ActionEvent e) Processes action events occurring on this component by dispatching them to any registered `ActionListener` objects.
void	processEvent(AWTEvent e) Processes events on this scrolling list.
void	processItemEvent(ItemEvent e) Processes item events occurring on this list by dispatching them to any registered `ItemListener` objects.

[Expand]

Inherited Methods

From class java.awt.Component

boolean	action(Event evt, Object what) This method is deprecated. As of JDK version 1.1, should register this component as ActionListener on component which fires action events.
void	add(PopupMenu popup) Adds the specified popup menu to the component.
synchronized void	addComponentListener(ComponentListener l) Adds the specified component listener to receive component events from this component.
synchronized void	addFocusListener(FocusListener l) Adds the specified focus listener to receive focus events from this component when this component gains input focus.
void	addHierarchyBoundsListener(HierarchyBoundsListener l) Adds the specified hierarchy bounds listener to receive hierarchy bounds events from this component when the hierarchy to which this container belongs changes.
void	addHierarchyListener(HierarchyListener l) Adds the specified hierarchy listener to receive hierarchy changed events from this component when the hierarchy to which this container belongs changes.
synchronized void	addInputMethodListener(InputMethodListener l) Adds the specified input method listener to receive input method events from this component.
synchronized void	addKeyListener(KeyListener l) Adds the specified key listener to receive key events from this component.
synchronized void	addMouseListener(MouseListener l) Adds the specified mouse listener to receive mouse events from this component.
synchronized void	addMouseMotionListener(MouseMotionListener l) Adds the specified mouse motion listener to receive mouse motion events from this component.
synchronized void	addMouseWheelListener(MouseWheelListener l) Adds the specified mouse wheel listener to receive mouse wheel events from this component.
void	addNotify() Makes this `Component` displayable by connecting it to a native screen resource.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener) Adds a PropertyChangeListener to the listener list for a specific property.
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChangeListener to the listener list.
void	applyComponentOrientation(ComponentOrientation orientation) Sets the `ComponentOrientation` property of this component and all components contained within it.
boolean	areFocusTraversalKeysSet(int id) Returns whether the Set of focus traversal keys for the given focus traversal operation has been explicitly defined for this Component.
Rectangle	bounds() This method is deprecated. As of JDK version 1.1, replaced by `getBounds()`.
int	checkImage(Image image, ImageObserver observer) Returns the status of the construction of a screen representation of the specified image.
int	checkImage(Image image, int width, int height, ImageObserver observer) Returns the status of the construction of a screen representation of the specified image.
AWTEvent	coalesceEvents(AWTEvent existingEvent, AWTEvent newEvent) Potentially coalesce an event being posted with an existing event.
boolean	contains(Point p) Checks whether this component "contains" the specified point, where the point's x and y coordinates are defined to be relative to the coordinate system of this component.
boolean	contains(int x, int y) Checks whether this component "contains" the specified point, where `x` and `y` are defined to be relative to the coordinate system of this component.
Image	createImage(int width, int height) Creates an off-screen drawable image to be used for double buffering.
Image	createImage(ImageProducer producer) Creates an image from the specified image producer.
VolatileImage	createVolatileImage(int width, int height, ImageCapabilities caps) Creates a volatile off-screen drawable image, with the given capabilities.
VolatileImage	createVolatileImage(int width, int height) Creates a volatile off-screen drawable image to be used for double buffering.
void	deliverEvent(Event e) This method is deprecated. As of JDK version 1.1, replaced by `dispatchEvent(AWTEvent e)`.
void	disable() This method is deprecated. As of JDK version 1.1, replaced by `setEnabled(boolean)`.
final void	disableEvents(long eventsToDisable) Disables the events defined by the specified event mask parameter from being delivered to this component.
final void	dispatchEvent(AWTEvent e) Dispatches an event to this component or one of its sub components.
void	doLayout() Prompts the layout manager to lay out this component.
void	enable() This method is deprecated. As of JDK version 1.1, replaced by `setEnabled(boolean)`.
void	enable(boolean b) This method is deprecated. As of JDK version 1.1, replaced by `setEnabled(boolean)`.
final void	enableEvents(long eventsToEnable) Enables the events defined by the specified event mask parameter to be delivered to this component.
void	enableInputMethods(boolean enable) Enables or disables input method support for this component.
void	firePropertyChange(String propertyName, float oldValue, float newValue) Reports a bound property change.
void	firePropertyChange(String propertyName, byte oldValue, byte newValue) Reports a bound property change.
void	firePropertyChange(String propertyName, char oldValue, char newValue) Reports a bound property change.
void	firePropertyChange(String propertyName, short oldValue, short newValue) Reports a bound property change.
void	firePropertyChange(String propertyName, long oldValue, long newValue) Reports a bound property change.
void	firePropertyChange(String propertyName, boolean oldValue, boolean newValue) Support for reporting bound property changes for boolean properties.
void	firePropertyChange(String propertyName, double oldValue, double newValue) Reports a bound property change.
void	firePropertyChange(String propertyName, Object oldValue, Object newValue) Support for reporting bound property changes for Object properties.
void	firePropertyChange(String propertyName, int oldValue, int newValue) Support for reporting bound property changes for integer properties.
AccessibleContext	getAccessibleContext() Gets the `AccessibleContext` associated with this `Component`.
float	getAlignmentX() Returns the alignment along the x axis.
float	getAlignmentY() Returns the alignment along the y axis.
Color	getBackground() Gets the background color of this component.
int	getBaseline(int width, int height) Returns the baseline.
Component.BaselineResizeBehavior	getBaselineResizeBehavior() Returns an enum indicating how the baseline of the component changes as the size changes.
Rectangle	getBounds(Rectangle rv) Stores the bounds of this component into "return value" rv and return rv.
Rectangle	getBounds() Gets the bounds of this component in the form of a `Rectangle` object.
ColorModel	getColorModel() Gets the instance of `ColorModel` used to display the component on the output device.
Component	getComponentAt(Point p) Returns the component or subcomponent that contains the specified point.
Component	getComponentAt(int x, int y) Determines if this component or one of its immediate subcomponents contains the (x, y) location, and if so, returns the containing component.
synchronized ComponentListener[]	getComponentListeners() Returns an array of all the component listeners registered on this component.
ComponentOrientation	getComponentOrientation() Retrieves the language-sensitive orientation that is to be used to order the elements or text within this component.
Cursor	getCursor() Gets the cursor set in the component.
synchronized DropTarget	getDropTarget() Gets the `DropTarget` associated with this `Component`.
Container	getFocusCycleRootAncestor() Returns the Container which is the focus cycle root of this Component's focus traversal cycle.
synchronized FocusListener[]	getFocusListeners() Returns an array of all the focus listeners registered on this component.
Set<AWTKeyStroke>	getFocusTraversalKeys(int id) Returns the Set of focus traversal keys for a given traversal operation for this Component.
boolean	getFocusTraversalKeysEnabled() Returns whether focus traversal keys are enabled for this Component.
Font	getFont() Gets the font of this component.
FontMetrics	getFontMetrics(Font font) Gets the font metrics for the specified font.
Color	getForeground() Gets the foreground color of this component.
Graphics	getGraphics() Creates a graphics context for this component.
GraphicsConfiguration	getGraphicsConfiguration() Gets the `GraphicsConfiguration` associated with this `Component`.
int	getHeight() Returns the current height of this component.
synchronized HierarchyBoundsListener[]	getHierarchyBoundsListeners() Returns an array of all the hierarchy bounds listeners registered on this component.
synchronized HierarchyListener[]	getHierarchyListeners() Returns an array of all the hierarchy listeners registered on this component.
boolean	getIgnoreRepaint()
InputContext	getInputContext() Gets the input context used by this component for handling the communication with input methods when text is entered in this component.
synchronized InputMethodListener[]	getInputMethodListeners() Returns an array of all the input method listeners registered on this component.
InputMethodRequests	getInputMethodRequests() Gets the input method request handler which supports requests from input methods for this component.
synchronized KeyListener[]	getKeyListeners() Returns an array of all the key listeners registered on this component.
<T extends EventListener> T[]	getListeners(Class<T> listenerType) Returns an array of all the objects currently registered as `FooListener`s upon this `Component`.
Locale	getLocale() Gets the locale of this component.
Point	getLocation() Gets the location of this component in the form of a point specifying the component's top-left corner.
Point	getLocation(Point rv) Stores the x,y origin of this component into "return value" rv and return rv.
Point	getLocationOnScreen() Gets the location of this component in the form of a point specifying the component's top-left corner in the screen's coordinate space.
Dimension	getMaximumSize() Gets the maximum size of this component.
Dimension	getMinimumSize() Gets the mininimum size of this component.
synchronized MouseListener[]	getMouseListeners() Returns an array of all the mouse listeners registered on this component.
synchronized MouseMotionListener[]	getMouseMotionListeners() Returns an array of all the mouse motion listeners registered on this component.
Point	getMousePosition() Returns the position of the mouse pointer in this `Component`'s coordinate space if the `Component` is directly under the mouse pointer, otherwise returns `null`.
synchronized MouseWheelListener[]	getMouseWheelListeners() Returns an array of all the mouse wheel listeners registered on this component.
String	getName() Gets the name of the component.
Container	getParent() Gets the parent of this component.
ComponentPeer	getPeer() This method is deprecated. As of JDK version 1.1, programs should not directly manipulate peers; replaced by `boolean isDisplayable()`.
Dimension	getPreferredSize() Gets the preferred size of this component.
PropertyChangeListener[]	getPropertyChangeListeners() Returns an array of all the property change listeners registered on this component.
PropertyChangeListener[]	getPropertyChangeListeners(String propertyName) Returns an array of all the listeners which have been associated with the named property.
Dimension	getSize() Returns the size of this component in the form of a `Dimension` object.
Dimension	getSize(Dimension rv) Stores the width/height of this component into "return value" rv and return rv.
Toolkit	getToolkit() Gets the toolkit of this component.
final Object	getTreeLock() Gets this component's locking object (the object that owns the thread sychronization monitor) for AWT component-tree and layout operations.
int	getWidth() Returns the current width of this component.
int	getX() Returns the current x coordinate of the components origin.
int	getY() Returns the current y coordinate of the components origin.
boolean	gotFocus(Event evt, Object what) This method is deprecated. As of JDK version 1.1, replaced by processFocusEvent(FocusEvent).
boolean	handleEvent(Event evt) This method is deprecated. As of JDK version 1.1 replaced by processEvent(AWTEvent).
boolean	hasFocus() Returns `true` if this `Component` is the focus owner.
void	hide() This method is deprecated. As of JDK version 1.1, replaced by `setVisible(boolean)`.
boolean	imageUpdate(Image img, int infoflags, int x, int y, int w, int h) Repaints the component when the image has changed.
boolean	inside(int x, int y) This method is deprecated. As of JDK version 1.1, replaced by contains(int, int).
void	invalidate() Invalidates this component.
boolean	isBackgroundSet() Returns whether the background color has been explicitly set for this Component.
boolean	isCursorSet() Returns whether the cursor has been explicitly set for this Component.
boolean	isDisplayable() Determines whether this component is displayable.
boolean	isDoubleBuffered() Returns true if this component is painted to an offscreen image ("buffer") that's copied to the screen later.
boolean	isEnabled() Determines whether this component is enabled.
boolean	isFocusCycleRoot(Container container) Returns whether the specified Container is the focus cycle root of this Component's focus traversal cycle.
boolean	isFocusOwner() Returns `true` if this `Component` is the focus owner.
boolean	isFocusTraversable() This method is deprecated. As of 1.4, replaced by `isFocusable()`.
boolean	isFocusable() Returns whether this Component can be focused.
boolean	isFontSet() Returns whether the font has been explicitly set for this Component.
boolean	isForegroundSet() Returns whether the foreground color has been explicitly set for this Component.
boolean	isLightweight() A lightweight component doesn't have a native toolkit peer.
boolean	isMaximumSizeSet() Returns true if the maximum size has been set to a non-`null` value otherwise returns false.
boolean	isMinimumSizeSet() Returns whether or not `setMinimumSize` has been invoked with a non-null value.
boolean	isOpaque() Returns true if this component is completely opaque, returns false by default.
boolean	isPreferredSizeSet() Returns true if the preferred size has been set to a non-`null` value otherwise returns false.
boolean	isShowing() Determines whether this component is showing on screen.
boolean	isValid() Determines whether this component is valid.
boolean	isVisible() Determines whether this component should be visible when its parent is visible.
boolean	keyDown(Event evt, int key) This method is deprecated. As of JDK version 1.1, replaced by processKeyEvent(KeyEvent).
boolean	keyUp(Event evt, int key) This method is deprecated. As of JDK version 1.1, replaced by processKeyEvent(KeyEvent).
void	layout() This method is deprecated. As of JDK version 1.1, replaced by `doLayout()`.
void	list(PrintStream out) Prints a listing of this component to the specified output stream.
void	list() Prints a listing of this component to the standard system output stream `System.out`.
void	list(PrintStream out, int indent) Prints out a list, starting at the specified indentation, to the specified print stream.
void	list(PrintWriter out) Prints a listing to the specified print writer.
void	list(PrintWriter out, int indent) Prints out a list, starting at the specified indentation, to the specified print writer.
Component	locate(int x, int y) This method is deprecated. As of JDK version 1.1, replaced by getComponentAt(int, int).
Point	location() This method is deprecated. As of JDK version 1.1, replaced by `getLocation()`.
boolean	lostFocus(Event evt, Object what) This method is deprecated. As of JDK version 1.1, replaced by processFocusEvent(FocusEvent).
Dimension	minimumSize() This method is deprecated. As of JDK version 1.1, replaced by `getMinimumSize()`.
boolean	mouseDown(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
boolean	mouseDrag(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent).
boolean	mouseEnter(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
boolean	mouseExit(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
boolean	mouseMove(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent).
boolean	mouseUp(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
void	move(int x, int y) This method is deprecated. As of JDK version 1.1, replaced by `setLocation(int, int)`.
void	nextFocus() This method is deprecated. As of JDK version 1.1, replaced by transferFocus().
void	paint(Graphics g) Paints this component.
void	paintAll(Graphics g) Paints this component and all of its subcomponents.
String	paramString() Returns a string representing the state of this component.
boolean	postEvent(Event e) This method is deprecated. As of JDK version 1.1, replaced by dispatchEvent(AWTEvent).
Dimension	preferredSize() This method is deprecated. As of JDK version 1.1, replaced by `getPreferredSize()`.
boolean	prepareImage(Image image, ImageObserver observer) Prepares an image for rendering on this component.
boolean	prepareImage(Image image, int width, int height, ImageObserver observer) Prepares an image for rendering on this component at the specified width and height.
void	print(Graphics g) Prints this component.
void	printAll(Graphics g) Prints this component and all of its subcomponents.
void	processComponentEvent(ComponentEvent e) Processes component events occurring on this component by dispatching them to any registered `ComponentListener` objects.
void	processEvent(AWTEvent e) Processes events occurring on this component.
void	processFocusEvent(FocusEvent e) Processes focus events occurring on this component by dispatching them to any registered `FocusListener` objects.
void	processHierarchyBoundsEvent(HierarchyEvent e) Processes hierarchy bounds events occurring on this component by dispatching them to any registered `HierarchyBoundsListener` objects.
void	processHierarchyEvent(HierarchyEvent e) Processes hierarchy events occurring on this component by dispatching them to any registered `HierarchyListener` objects.
void	processInputMethodEvent(InputMethodEvent e) Processes input method events occurring on this component by dispatching them to any registered `InputMethodListener` objects.
void	processKeyEvent(KeyEvent e) Processes key events occurring on this component by dispatching them to any registered `KeyListener` objects.
void	processMouseEvent(MouseEvent e) Processes mouse events occurring on this component by dispatching them to any registered `MouseListener` objects.
void	processMouseMotionEvent(MouseEvent e) Processes mouse motion events occurring on this component by dispatching them to any registered `MouseMotionListener` objects.
void	processMouseWheelEvent(MouseWheelEvent e) Processes mouse wheel events occurring on this component by dispatching them to any registered `MouseWheelListener` objects.
void	remove(MenuComponent popup) Removes the specified popup menu from the component.
synchronized void	removeComponentListener(ComponentListener l) Removes the specified component listener so that it no longer receives component events from this component.
synchronized void	removeFocusListener(FocusListener l) Removes the specified focus listener so that it no longer receives focus events from this component.
void	removeHierarchyBoundsListener(HierarchyBoundsListener l) Removes the specified hierarchy bounds listener so that it no longer receives hierarchy bounds events from this component.
void	removeHierarchyListener(HierarchyListener l) Removes the specified hierarchy listener so that it no longer receives hierarchy changed events from this component.
synchronized void	removeInputMethodListener(InputMethodListener l) Removes the specified input method listener so that it no longer receives input method events from this component.
synchronized void	removeKeyListener(KeyListener l) Removes the specified key listener so that it no longer receives key events from this component.
synchronized void	removeMouseListener(MouseListener l) Removes the specified mouse listener so that it no longer receives mouse events from this component.
synchronized void	removeMouseMotionListener(MouseMotionListener l) Removes the specified mouse motion listener so that it no longer receives mouse motion events from this component.
synchronized void	removeMouseWheelListener(MouseWheelListener l) Removes the specified mouse wheel listener so that it no longer receives mouse wheel events from this component.
void	removeNotify() Makes this `Component` undisplayable by destroying it native screen resource.
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener) Removes a `PropertyChangeListener` from the listener list for a specific property.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a PropertyChangeListener from the listener list.
void	repaint(int x, int y, int width, int height) Repaints the specified rectangle of this component.
void	repaint(long tm, int x, int y, int width, int height) Repaints the specified rectangle of this component within `tm` milliseconds.
void	repaint() Repaints this component.
void	repaint(long tm) Repaints the component.
void	requestFocus() Requests that this Component get the input focus, and that this Component's top-level ancestor become the focused Window.
boolean	requestFocus(boolean temporary) Requests that this `Component` get the input focus, and that this `Component`'s top-level ancestor become the focused `Window`.
boolean	requestFocusInWindow(boolean temporary) Requests that this `Component` get the input focus, if this `Component`'s top-level ancestor is already the focused `Window`.
boolean	requestFocusInWindow() Requests that this Component get the input focus, if this Component's top-level ancestor is already the focused Window.
void	reshape(int x, int y, int width, int height) This method is deprecated. As of JDK version 1.1, replaced by `setBounds(int, int, int, int)`.
void	resize(Dimension d) This method is deprecated. As of JDK version 1.1, replaced by `setSize(Dimension)`.
void	resize(int width, int height) This method is deprecated. As of JDK version 1.1, replaced by `setSize(int, int)`.
void	setBackground(Color c) Sets the background color of this component.
void	setBounds(int x, int y, int width, int height) Moves and resizes this component.
void	setBounds(Rectangle r) Moves and resizes this component to conform to the new bounding rectangle `r`.
void	setComponentOrientation(ComponentOrientation o) Sets the language-sensitive orientation that is to be used to order the elements or text within this component.
void	setCursor(Cursor cursor) Sets the cursor image to the specified cursor.
synchronized void	setDropTarget(DropTarget dt) Associate a `DropTarget` with this component.
void	setEnabled(boolean b) Enables or disables this component, depending on the value of the parameter `b`.
void	setFocusTraversalKeys(int id, Set<? extends AWTKeyStroke> keystrokes) Sets the focus traversal keys for a given traversal operation for this Component.
void	setFocusTraversalKeysEnabled(boolean focusTraversalKeysEnabled) Sets whether focus traversal keys are enabled for this Component.
void	setFocusable(boolean focusable) Sets the focusable state of this Component to the specified value.
void	setFont(Font f) Sets the font of this component.
void	setForeground(Color c) Sets the foreground color of this component.
void	setIgnoreRepaint(boolean ignoreRepaint) Sets whether or not paint messages received from the operating system should be ignored.
void	setLocale(Locale l) Sets the locale of this component.
void	setLocation(int x, int y) Moves this component to a new location.
void	setLocation(Point p) Moves this component to a new location.
void	setMaximumSize(Dimension maximumSize) Sets the maximum size of this component to a constant value.
void	setMinimumSize(Dimension minimumSize) Sets the minimum size of this component to a constant value.
void	setName(String name) Sets the name of the component to the specified string.
void	setPreferredSize(Dimension preferredSize) Sets the preferred size of this component to a constant value.
void	setSize(int width, int height) Resizes this component so that it has width `width` and height `height`.
void	setSize(Dimension d) Resizes this component so that it has width `d.width` and height `d.height`.
void	setVisible(boolean b) Shows or hides this component depending on the value of parameter `b`.
void	show() This method is deprecated. As of JDK version 1.1, replaced by `setVisible(boolean)`.
void	show(boolean b) This method is deprecated. As of JDK version 1.1, replaced by `setVisible(boolean)`.
Dimension	size() This method is deprecated. As of JDK version 1.1, replaced by `getSize()`.
String	toString() Returns a string representation of this component and its values.
void	transferFocus() Transfers the focus to the next component, as though this Component were the focus owner.
void	transferFocusBackward() Transfers the focus to the previous component, as though this Component were the focus owner.
void	transferFocusUpCycle() Transfers the focus up one focus traversal cycle.
void	update(Graphics g) Updates this component.
void	validate() Ensures that this component has a valid layout.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface java.awt.ItemSelectable

From interface java.awt.MenuContainer

From interface java.awt.image.ImageObserver

From interface javax.accessibility.Accessible

Public Constructors

public List ()

Creates a new scrolling list. By default, there are four visible lines and multiple selections are not allowed. Note that this is a convenience method for List(0, false). Also note that the number of visible lines in the list cannot be changed after it has been created.

Throws

HeadlessException	if GraphicsEnvironment.isHeadless() returns true.

public List (int rows)

Creates a new scrolling list initialized with the specified number of visible lines. By default, multiple selections are not allowed. Note that this is a convenience method for List(rows, false). Also note that the number of visible rows in the list cannot be changed after it has been created.

Parameters

rows	the number of items to show.

Throws

HeadlessException	if GraphicsEnvironment.isHeadless() returns true.

public List (int rows, boolean multipleMode)

Creates a new scrolling list initialized to display the specified number of rows. Note that if zero rows are specified, then the list will be created with a default of four rows. Also note that the number of visible rows in the list cannot be changed after it has been created. If the value of multipleMode is true, then the user can select multiple items from the list. If it is false, only one item at a time can be selected.

Parameters

rows	the number of items to show.
multipleMode	if `true`, then multiple selections are allowed; otherwise, only one item can be selected at a time.

Throws

HeadlessException	if GraphicsEnvironment.isHeadless() returns true.

Public Methods

public void add (String item, int index)

Adds the specified item to the the scrolling list at the position indicated by the index. The index is zero-based. If the value of the index is less than zero, or if the value of the index is greater than or equal to the number of items in the list, then the item is added to the end of the list.

Parameters

item	the item to be added; if this parameter is `null` then the item is treated as an empty string, `""`
index	the position at which to add the item

public void add (String item)

Adds the specified item to the end of scrolling list.

Parameters

item	the item to be added

public synchronized void addActionListener (ActionListener l)

Adds the specified action listener to receive action events from this list. Action events occur when a user double-clicks on a list item or types Enter when the list has the keyboard focus.

If listener l is null, no exception is thrown and no action is performed.

Refer to AWT Threading Issues for details on AWT's threading model.

Parameters

l	the action listener

public void addItem (String item)

This method is deprecated.
replaced by add(String).

public synchronized void addItem (String item, int index)

This method is deprecated.
replaced by add(String, int).

public synchronized void addItemListener (ItemListener l)

Adds the specified item listener to receive item events from this list. Item events are sent in response to user input, but not in response to calls to select or deselect. If listener l is null, no exception is thrown and no action is performed.

Refer to AWT Threading Issues for details on AWT's threading model.

Parameters

l	the item listener

public void addNotify ()

Creates the peer for the list. The peer allows us to modify the list's appearance without changing its functionality.

public boolean allowsMultipleSelections ()

This method is deprecated.
As of JDK version 1.1, replaced by isMultipleMode().

public synchronized void clear ()

This method is deprecated.
As of JDK version 1.1, replaced by removeAll().

public int countItems ()

This method is deprecated.
As of JDK version 1.1, replaced by getItemCount().

public void delItem (int position)

This method is deprecated.
replaced by remove(String) and remove(int).

public synchronized void delItems (int start, int end)

This method is deprecated.
As of JDK version 1.1, Not for public use in the future. This method is expected to be retained only as a package private method.

public synchronized void deselect (int index)

Deselects the item at the specified index.

Note that passing out of range parameters is invalid, and will result in unspecified behavior.

If the item at the specified index is not selected, then the operation is ignored.

Parameters

index	the position of the item to deselect

public AccessibleContext getAccessibleContext ()

Gets the AccessibleContext associated with this List. For lists, the AccessibleContext takes the form of an AccessibleAWTList. A new AccessibleAWTList instance is created, if necessary.

Returns

an AccessibleAWTList that serves as the AccessibleContext of this List

public synchronized ActionListener[] getActionListeners ()

Returns an array of all the action listeners registered on this list.

Returns

all of this list's ActionListeners or an empty array if no action listeners are currently registered

public String getItem (int index)

Gets the item associated with the specified index.

Parameters

index	the position of the item

Returns

an item that is associated with the specified index

public int getItemCount ()

Gets the number of items in the list.

Returns

the number of items in the list

public synchronized ItemListener[] getItemListeners ()

Returns an array of all the item listeners registered on this list.

Returns

all of this list's ItemListeners or an empty array if no item listeners are currently registered

public synchronized String[] getItems ()

Gets the items in the list.

Returns

a string array containing items of the list

public T[] getListeners (Class<T> listenerType)

Returns an array of all the objects currently registered as FooListeners upon this List. FooListeners are registered using the addFooListener method.

You can specify the listenerType argument with a class literal, such as FooListener.class. For example, you can query a List l for its item listeners with the following code:

ItemListener[] ils = (ItemListener[])(l.getListeners(ItemListener.class));

If no such listeners exist, this method returns an empty array.

Parameters

listenerType	the type of listeners requested; this parameter should specify an interface that descends from `java.util.EventListener`

Returns

an array of all objects registered as FooListeners on this list, or an empty array if no such listeners have been added

Throws

ClassCastException	if `listenerType` doesn't specify a class or interface that implements `java.util.EventListener`

public Dimension getMinimumSize ()

Determines the minimum size of this scrolling list.

Returns

the minimum dimensions needed to display this scrolling list

public Dimension getMinimumSize (int rows)

Gets the minumum dimensions for a list with the specified number of rows.

Parameters

rows	number of rows in the list

Returns

the minimum dimensions for displaying this scrolling list given that the specified number of rows must be visible

public Dimension getPreferredSize ()

Gets the preferred size of this scrolling list.

Returns

the preferred dimensions for displaying this scrolling list

public Dimension getPreferredSize (int rows)

Gets the preferred dimensions for a list with the specified number of rows.

Parameters

rows	number of rows in the list

Returns

the preferred dimensions for displaying this scrolling list given that the specified number of rows must be visible

public int getRows ()

Gets the number of visible lines in this list. Note that once the List has been created, this number will never change.

Returns

the number of visible lines in this scrolling list

public synchronized int getSelectedIndex ()

Gets the index of the selected item on the list,

Returns

the index of the selected item; if no item is selected, or if multiple items are selected, -1 is returned.

public synchronized int[] getSelectedIndexes ()

Gets the selected indexes on the list.

Returns

an array of the selected indexes on this scrolling list; if no item is selected, a zero-length array is returned.

public synchronized String getSelectedItem ()

Gets the selected item on this scrolling list.

Returns

the selected item on the list; if no item is selected, or if multiple items are selected, null is returned.

public synchronized String[] getSelectedItems ()

Gets the selected items on this scrolling list.

Returns

an array of the selected items on this scrolling list; if no item is selected, a zero-length array is returned.

public Object[] getSelectedObjects ()

Gets the selected items on this scrolling list in an array of Objects.

Returns

an array of Objects representing the selected items on this scrolling list; if no item is selected, a zero-length array is returned.

public int getVisibleIndex ()

Gets the index of the item that was last made visible by the method makeVisible.

Returns

the index of the item that was last made visible

public boolean isIndexSelected (int index)

Determines if the specified item in this scrolling list is selected.

Parameters

index	the item to be checked

Returns

true if the specified item has been selected; false otherwise

public boolean isMultipleMode ()

Determines whether this list allows multiple selections.

Returns

true if this list allows multiple selections; otherwise, false

public boolean isSelected (int index)

This method is deprecated.
As of JDK version 1.1, replaced by isIndexSelected(int).

public synchronized void makeVisible (int index)

Makes the item at the specified index visible.

Parameters

index	the position of the item

public Dimension minimumSize (int rows)

This method is deprecated.
As of JDK version 1.1, replaced by getMinimumSize(int).

public Dimension minimumSize ()

This method is deprecated.
As of JDK version 1.1, replaced by getMinimumSize().

public Dimension preferredSize (int rows)

This method is deprecated.
As of JDK version 1.1, replaced by getPreferredSize(int).

public Dimension preferredSize ()

This method is deprecated.
As of JDK version 1.1, replaced by getPreferredSize().

public synchronized void remove (String item)

Removes the first occurrence of an item from the list. If the specified item is selected, and is the only selected item in the list, the list is set to have no selection.

Parameters

item	the item to remove from the list

Throws

IllegalArgumentException	if the item doesn't exist in the list

public void remove (int position)

Removes the item at the specified position from this scrolling list. If the item with the specified position is selected, and is the only selected item in the list, the list is set to have no selection.

Parameters

position	the index of the item to delete

Throws

ArrayIndexOutOfBoundsException	if the `position` is less than 0 or greater than `getItemCount()-1`

public synchronized void removeActionListener (ActionListener l)

Removes the specified action listener so that it no longer receives action events from this list. Action events occur when a user double-clicks on a list item. If listener l is null, no exception is thrown and no action is performed.

Refer to AWT Threading Issues for details on AWT's threading model.

Parameters

l	the action listener

public void removeAll ()

Removes all items from this list.

public synchronized void removeItemListener (ItemListener l)

Removes the specified item listener so that it no longer receives item events from this list. If listener l is null, no exception is thrown and no action is performed.

Refer to AWT Threading Issues for details on AWT's threading model.

Parameters

l	the item listener

public void removeNotify ()

Removes the peer for this list. The peer allows us to modify the list's appearance without changing its functionality.

public synchronized void replaceItem (String newValue, int index)

Replaces the item at the specified index in the scrolling list with the new string.

Parameters

newValue	a new string to replace an existing item
index	the position of the item to replace

Throws

ArrayIndexOutOfBoundsException	if `index` is out of range

public void select (int index)

Selects the item at the specified index in the scrolling list.

Note that passing out of range parameters is invalid, and will result in unspecified behavior.

Note that this method should be primarily used to initially select an item in this component. Programmatically calling this method will not trigger an ItemEvent. The only way to trigger an ItemEvent is by user interaction.

Parameters

index	the position of the item to select

public void setMultipleMode (boolean b)

Sets the flag that determines whether this list allows multiple selections. When the selection mode is changed from multiple-selection to single-selection, the selected items change as follows: If a selected item has the location cursor, only that item will remain selected. If no selected item has the location cursor, all items will be deselected.

Parameters

b	if `true` then multiple selections are allowed; otherwise, only one item from the list can be selected at once

public synchronized void setMultipleSelections (boolean b)

This method is deprecated.
As of JDK version 1.1, replaced by setMultipleMode(boolean).

Protected Methods

protected String paramString ()

Returns the parameter string representing the state of this scrolling list. This string is useful for debugging.

Returns

the parameter string of this scrolling list

protected void processActionEvent (ActionEvent e)

Processes action events occurring on this component by dispatching them to any registered ActionListener objects.

This method is not called unless action events are enabled for this component. Action events are enabled when one of the following occurs:

An ActionListener object is registered via addActionListener.
Action events are enabled via enableEvents.

Note that if the event parameter is null the behavior is unspecified and may result in an exception.

Parameters

e	the action event

protected void processEvent (AWTEvent e)

Processes events on this scrolling list. If an event is an instance of ItemEvent, it invokes the processItemEvent method. Else, if the event is an instance of ActionEvent, it invokes processActionEvent. If the event is not an item event or an action event, it invokes processEvent on the superclass.

Note that if the event parameter is null the behavior is unspecified and may result in an exception.

Parameters

e	the event

protected void processItemEvent (ItemEvent e)

Processes item events occurring on this list by dispatching them to any registered ItemListener objects.

This method is not called unless item events are enabled for this component. Item events are enabled when one of the following occurs:

An ItemListener object is registered via addItemListener.
Item events are enabled via enableEvents.

Note that if the event parameter is null the behavior is unspecified and may result in an exception.

Parameters

e	the item event

Interfaces

Classes

Enums

Exceptions

Errors

List

Class Overview

See Also

Summary

Public Constructors

public List ()

Throws

See Also

public List (int rows)

Parameters

Throws

See Also

public List (int rows, boolean multipleMode)

Parameters

Throws

See Also

Public Methods

public void add (String item, int index)

Parameters

public void add (String item)

Parameters

public synchronized void addActionListener (ActionListener l)

Parameters

See Also

public void addItem (String item)

public synchronized void addItem (String item, int index)

public synchronized void addItemListener (ItemListener l)

Parameters

See Also

public void addNotify ()

public boolean allowsMultipleSelections ()

public synchronized void clear ()

public int countItems ()

public void delItem (int position)

public synchronized void delItems (int start, int end)

public synchronized void deselect (int index)

Parameters

See Also

public AccessibleContext getAccessibleContext ()

Returns

public synchronized ActionListener[] getActionListeners ()

Returns

See Also

public String getItem (int index)

Parameters

Returns

See Also

public int getItemCount ()

Returns

See Also

public synchronized ItemListener[] getItemListeners ()

Returns

See Also

public synchronized String[] getItems ()

Returns

See Also

public T[] getListeners (Class<T> listenerType)

Parameters

Returns

Throws

See Also

public Dimension getMinimumSize ()

Returns

See Also

public Dimension getMinimumSize (int rows)

Parameters

Returns

See Also

public Dimension getPreferredSize ()

Returns

See Also

public Dimension getPreferredSize (int rows)

Parameters

Returns

See Also