java.awt

接口
异常
错误
java.lang.Object
  继承者 java.awt.Component
      继承者 java.awt.List
所有已实现的接口:
ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible

public class List
     
extends Component
implements ItemSelectable, Accessible

List 组件为用户提供了一个可滚动的文本项列表。可设置此 list,使其允许用户进行单项或多项选择。

例如以下代码:


 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);
 

cnt 为容器时,将生成以下滚动列表:

显示一个包含这些项的列表:Venus、Earth、JavaSoft 和 Mars。Javasoft 为选中状态。

如果 List 允许进行多项选择,则单击已选中的项时,将取消选中该项。在上面的示例中,一次只能从滚动列表中选择一项,因为创建新的滚动列表时,第二个参数为 false。如果 List 不允许进行多项选择,则选择某一项会导致其他选中的项取消选中。

注意,本示例中显示的列表是用四个可视行创建的。创建该列表之后,不可更改可视行的数量。默认的 List 是用四行创建的,所以 lst = new List()list = new List(4, false) 等效。

从 Java 1.1 开始,AWT(Abstract Window Toolkit,抽象窗口工具包)会把列表上发生的所有鼠标、键盘和焦点事件发送给 List 对象。(维护旧的 AWT 事件模型的目的是为了向后兼容,不推荐使用它。)

当用户选中或取消选中某项时,AWT 将向列表发送一个 ItemEvent 实例。当用户双击滚动列表中的某一项时,AWT 会在紧随项事件后向列表发送一个 ActionEvent 实例。当用户选中列表中的某项,按下 return 键时,AWT 也会生成一个动作事件。

如果应用程序需要基于此列表中用户选中或激活的项执行某个动作,则应该相应地实现 ItemListenerActionListener,并注册新的侦听器,以便在此列表中接收事件。

对于多项选择滚动列表,使用外部动作(如单击按钮)来触发动作被认为是一种更好的用户界面。

从以下版本开始:
JDK1.0
另请参见:
ItemEvent, ItemListener, ActionEvent, ActionListener, 序列化表格

嵌套类摘要
protected  class List.AccessibleAWTList
          此类实现 List 类的可访问性支持。
 
从类 java.awt.Component 继承的嵌套类/接口
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
字段摘要
 
从类 java.awt.Component 继承的字段
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
从接口 java.awt.image.ImageObserver 继承的字段
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
构造方法摘要
List()
          创建新的滚动列表。
List(int rows)
          创建一个用指定可视行数初始化的新滚动列表。
List(int rows, boolean multipleMode)
          创建一个初始化为显示指定行数的新滚动列表。
 
方法摘要
 void add(String item)
          向滚动列表的末尾添加指定的项。
 void add(String item, int index)
          向滚动列表中索引指示的位置添加指定的项。
 void addActionListener(ActionListener l)
          添加指定的动作侦听器以从此列表接收动作事件。
 void addItem(String item)
          已过时。 add(String) 取代。
 void addItem(String item, int index)
          已过时。 add(String, int) 取代。
 void addItemListener(ItemListener l)
          添加指定的项侦听器以接收此列表的项事件。
 void addNotify()
          创建列表的同位体。
 boolean allowsMultipleSelections()
          已过时。 从 JDK version 1.1 开始,由 isMultipleMode() 取代。
 void clear()
          已过时。 从 JDK version 1.1 开始,由 removeAll() 取代。
 int countItems()
          已过时。 从 JDK version 1.1 开始,由 getItemCount() 取代。
 void delItem(int position)
          已过时。 remove(String)remove(int) 取代。
 void delItems(int start, int end)
          已过时。 从 JDK version 1.1 开始,后来不再公开使用。只希望作为包私有方法时保留此方法。
 void deselect(int index)
          取消选择指定索引处的项。
 AccessibleContext getAccessibleContext()
          获取与此 List 关联的 AccessibleContext
 ActionListener[] getActionListeners()
          返回已在此列表上注册的所有动作侦听器的数组。
 String getItem(int index)
          获取与指定索引关联的项。
 int getItemCount()
          获取列表中的项数。
 ItemListener[] getItemListeners()
          返回已在此列表上注册的所有项侦听器的数组。
 String[] getItems()
          获取列表中的项。
<T extends EventListener>
T[]
getListeners(Class<T> listenerType)
          返回目前已在此 List 上注册为 FooListener 的所有对象的数组。
 Dimension getMinimumSize()
          确定此滚动列表的最小大小。
 Dimension getMinimumSize(int rows)
          获取具有指定行数的列表的最少维数。
 Dimension getPreferredSize()
          获取此滚动列表的首选大小。
 Dimension getPreferredSize(int rows)
          获取具有指定行数的列表的首选维数。
 int getRows()
          获取此列表中的可视行数。
 int getSelectedIndex()
          获取列表中选中项的索引。
 int[] getSelectedIndexes()
          获取列表中选中的索引。
 String getSelectedItem()
          获取此滚动列表中选中的项。
 String[] getSelectedItems()
          获取此滚动列表中选中的项。
 Object[] getSelectedObjects()
          获取对象数组中此滚动列表的选中项。
 int getVisibleIndex()
          获取上次由 makeVisible 方法使其可视的项的索引。
 boolean isIndexSelected(int index)
          确定是否已选中此滚动列表中的指定项。
 boolean isMultipleMode()
          确定此列表是否允许进行多项选择。
 boolean isSelected(int index)
          已过时。 从 JDK version 1.1 开始,由 isIndexSelected(int) 取代。
 void makeVisible(int index)
          使指定索引处的项可视。
 Dimension minimumSize()
          已过时。 从 JDK version 1.1 开始,由 getMinimumSize() 取代。
 Dimension minimumSize(int rows)
          已过时。 从 JDK version 1.1 开始,由 getMinimumSize(int) 取代。
protected  String paramString()
          返回表示此滚动列表状态的参数字符串。
 Dimension preferredSize()
          已过时。 从 JDK version 1.1 开始,由 getPreferredSize() 取代。
 Dimension preferredSize(int rows)
          已过时。 从 JDK version 1.1 开始,由 getPreferredSize(int) 取代。
protected  void processActionEvent(ActionEvent e)
          处理发生在此列表上的动作事件,方法是将这些事件指派给所有已注册的 ActionListener 对象。
protected  void processEvent(AWTEvent e)
          此滚动列表的进程事件。
protected  void processItemEvent(ItemEvent e)
          处理发生在此列表上的项事件,方法是将这些事件指派给所有已注册的 ItemListener 对象。
 void remove(int position)
          从此滚动列表中移除指定位置处的项。
 void remove(String item)
          从列表中移除项的第一次出现。
 void removeActionListener(ActionListener l)
          移除指定的动作侦听器,以便不再从此列表接收动作事件。
 void removeAll()
          从此列表中移除所有项。
 void removeItemListener(ItemListener l)
          移除指定的项侦听器,以便不再从此列表接收项事件。
 void removeNotify()
          移除此列表的同位体。
 void replaceItem(String newValue, int index)
          使用新字符串替换滚动列表中指定索引处的项。
 void select(int index)
          选择滚动列表中指定索引处的项。
 void setMultipleMode(boolean b)
          设置确定此列表是否允许进行多项选择的标志。
 void setMultipleSelections(boolean b)
          已过时。 从 JDK version 1.1 开始,由 setMultipleMode(boolean) 取代。
 
从类 java.awt.Component 继承的方法
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, postEvent, prepareImage, prepareImage, print, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate
 
从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

构造方法详细信息

List

public List()
     throws HeadlessException
创建新的滚动列表。默认情况下,有四个可视行,并且不允许进行多项选择。注意,这是 List(0, false) 的一种便捷方法。还要注意,列表中的可视行数一旦创建就不能更改。

抛出:
HeadlessException - 如果为 GraphicsEnvironment.isHeadless(),则返回 true。
另请参见:
GraphicsEnvironment.isHeadless()

List

public List(int rows)
     throws HeadlessException
创建一个用指定可视行数初始化的新滚动列表。默认情况下,不允许进行多项选择。注意,这是 List(rows, false) 的一种便捷方法。还要注意,列表中的可视行数一旦创建就不能更改。

参数:
rows - 要显示的项数。
抛出:
HeadlessException - 如果为 GraphicsEnvironment.isHeadless(),则返回 true。
从以下版本开始:
JDK1.1
另请参见:
GraphicsEnvironment.isHeadless()

List

public List(int rows,
            boolean multipleMode)
     throws HeadlessException
创建一个初始化为显示指定行数的新滚动列表。注意,如果指定了零行,则会按默认的四行创建列表。还要注意,列表中的可视行数一旦创建就不能更改。如果 multipleMode 的值为 true,则用户可从列表中选择多项。如果为 false,则一次只能选择一项。

参数:
rows - 要显示的项数。
multipleMode - 如果为 true,则允许进行多项选择;否则,一次只能选择一项。
抛出:
HeadlessException - 如果为 GraphicsEnvironment.isHeadless(),则返回 true。
另请参见:
GraphicsEnvironment.isHeadless()
方法详细信息

addNotify

public void addNotify()
创建列表的同位体。同位体允许我们在不更改列表功能的情况下修改其外观。

覆盖:
Component 中的 addNotify
另请参见:
Component.isDisplayable(), Component.removeNotify()

removeNotify

public void removeNotify()
移除此列表的同位体。同位体允许我们在不更改列表功能的情况下修改其外观。

覆盖:
Component 中的 removeNotify
另请参见:
Component.isDisplayable(), Component.addNotify()

getItemCount

public int getItemCount()
获取列表中的项数。

返回:
列表中的项数
从以下版本开始:
JDK1.1
另请参见:
getItem(int)

countItems

@Deprecated
public int countItems()
已过时。  从 JDK version 1.1 开始,由 getItemCount() 取代。


getItem

public String getItem(int index)
获取与指定索引关联的项。

参数:
index - 项的位置
返回:
一个与指定索引关联的项
另请参见:
getItemCount()

getItems

public String[] getItems()
获取列表中的项。

返回:
一个包含列表中项的字符串数组
从以下版本开始:
JDK1.1
另请参见:
select(int), deselect(int), isIndexSelected(int)

add

public void add(String item)
向滚动列表的末尾添加指定的项。

参数:
item - 要添加的项
从以下版本开始:
JDK1.1

addItem