类 java.awt.List

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.List

public class List

extends Component

implements ItemSelectable

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 是一容器时，产生如下滚动列表：

在未选择的项上单击以选择此项。在已选择的项上单击以取消选择此项。 在上面的例子中，某一时刻仅能从列表中选择一项，因为当创建新的滚动列表时第二个参数为 false。选定一项时，其它选定的项将自动取消选择。

从 Java 1.1 开始，抽象的窗口 Toolkit 将所有的鼠标、键盘和在列表上发生的焦点事件发送给相应的 List 对象。 (以前的 AWT 事件模型仅保持向后兼容，且不推荐使用此类。)

当选择某一项或取消某项选择时，AWT 将向列表对象发送一个 ItemEvent 实例。当用户双击滚动列表中的某一项时，紧随项事件，AWT 将再发送一个 ActionEvent 实例。当选择列表中的某项时，用户同时按下回车键，AWT 也将产生一个动作事件。

如果应用程序想要执行在当前列表中选定或者激活项的一些动作，那么应执行 ItemListener 或 ActionListener 方法，正确登记新的监听者，接收当前列表的事件。

对于多项选择的滚动列表，推荐使用一个外部指示符(诸如单击按钮)来触发动作，以获得一个更好的用户接口。

来自：

JDK1.0

参见：

ItemEvent, ItemListener, ActionEvent, ActionListener

构造子下标

List()

创建一个新的滚动列表。

List(int)

创建一个新的滚动列表，以指定的可视行数对它初始化。

List(int, boolean)

创建一个新的初始化的滚动列表，显示指定的行数。

方法下标

add(String)

在滚动列表的末尾添加指定项。

add(String, int)

在滚动列表的末尾添加指定项。

addActionListener(ActionListener)

添加指定的动作监听者，接收此列表的动作事件。

addItem(String)

addItem(String, int)

addItemListener(ItemListener)

添加指定的动作监听者，接收此列表的项目事件。

addNotify()

创建列表的同级件。

allowsMultipleSelections()

不推荐使用该方法。

clear()

不推荐使用该方法。

countItems()

不推荐使用该方法。

delItem(int)

从此列表中删除指定位置的项。

delItems(int, int)

不推荐使用该方法。

deselect(int)

取消指定下标处的项的选择状态。

getItem(int)

获取与指定下标相关的项。

getItemCount()

获取列表的项数。

getItems()

获取列表项。

getMinimumSize()

确定滚动列表的最小尺寸。

getMinimumSize(int)

获取指定行数的列表的最小尺寸。

getPreferredSize()

获取滚动列表的最佳尺寸。

getPreferredSize(int)

获取指定行数的列表的最佳尺寸。

getRows()

获取列表的可视行数。

getSelectedIndex()

获取列表中选定项的下标。

getSelectedIndexes()

获取列表中的选定下标。

getSelectedItem()

获取滚动列表的某一选定项。

getSelectedItems()

获取滚动列表的若干选定项。

getSelectedObjects()

返回在一数组对象中的列表的选定项。

getVisibleIndex()

获取项下标，它是通过 makeVisible 方法最后产生的。

isIndexSelected(int)

判定滚动列表中的指定项是否是选定的。

isMultipleMode()

判定列表是否允许多项选择。

isSelected(int)

不推荐使用该方法。

makeVisible(int)

使指定下标的项可视。

minimumSize()

不推荐使用该方法。

minimumSize(int)

不推荐使用该方法。

paramString()

返回参数串，表示滚动列表的状态。

preferredSize()

不推荐使用该方法。

preferredSize(int)

不推荐使用该方法。

processActionEvent(ActionEvent)

处理发生在组件上的动作事件，将之分配给任一已登记的 ActionListener 对象。

processEvent(AWTEvent)

处理滚动列表中的事件。

processItemEvent(ItemEvent)

处理列表中发生的项事件，将之分配给任一已登记的 ItemListener 对象。

remove(int)

从此列表中删除指定位置的项。

remove(String)

删除列表中首次出现的某项。

removeActionListener(ActionListener)

删除指定的动作监听者，使之不再接收列表的动作事件。

removeAll()

删除列表中的所有项。

removeItemListener(ItemListener)

删除指定的项监听者，使之不再接收列表的项事件。

removeNotify()

删除列表的同级件。

replaceItem(String, int)

用新串置换滚动列表中的指定项。

select(int)

选择滚动列表中指定下标的项。

setMultipleMode(boolean)

设置标志，用于决定列表是否允许多项选择。

setMultipleSelections(boolean)

不推荐使用该方法。

构造子

 public List()

创建一个新的滚动列表。 开始时没有可视行，且仅能从列表中选择一项。

 public List(int rows)

创建一个以指定的可视行数初始化的新的滚动列表。 缺省不允许多项选择。

参数：

rows - 显示的项数。

 public List(int rows,
             boolean multipleMode)

创建一个新的初始化的滚动列表，显示指定的行数。 如果 multipleMode 为 true，那么用户能从列表中选择多项。如果它为 false，一次仅能选择一项。

参数：

rows - 显示的项数。

multipleMode - 如果为 true， 允许多项选择；否则一次仅能选择一项。

方法

 public void addNotify()

创建列表的同级件。 此同级件允许在不改变列表功能的情况下，修改其外观。

覆盖：

类 Component 中的 addNotify

 public void removeNotify()

删除列表的同级件。 此同级件允许在不改变列表功能的情况下，修改列表外观。

覆盖：

类 Component 中的 removeNotify

 public int getItemCount()

获取列表的项数。

返回值：

列表的项数。

参见：

getItem

 public int countItems()

注释：不推荐使用 countItems() 方法。 如同 JDK 1.1 版，用 getItemCount() 方法替换。

 public String getItem(int index)

获取与指定下标相关的项。

参数：

index - 项的位置。

返回值：

指定下标对应的项。

参见：

getItemCount

 public synchronized String[] getItems()

获取列表项。

返回值：

包含列表项的字符数组。

参见：

select, deselect, isIndexSelected

 public void add(String item)

在滚动列表的末尾添加指定项。

参数：

item - 待添加的项。

 public void addItem(String item)

 public synchronized void add(String item,
                              int index)

在滚动列表的末尾添加指定项。 index 从零开始。如果 index 为 -1，那么将此项添加到列表末尾。如果 index 的值大于列表项数，则此项被添加到列表末尾。

参数：

item - 待添加的项。

index - 项的添加位置。

 public synchronized void addItem(String item,
                                  int index)

 public synchronized void replaceItem(String newValue,
                                      int index)

用新串置换滚动列表中的指定项。

参数：

newValue - 置换一个已有项的新的字符串。

index - 待置换的项位置。

 public synchronized void removeAll()

删除列表中的所有项。

参见：

remove, delItems

 public synchronized void clear()

注释：不推荐使用 clear()。 如同 JDK 1.1 版，用 removeAll() 替换。

 public synchronized void remove(String item)

删除列表中首次出现的某项。

参数：

item - 从列表中将删除的项。

抛出： IllegalArgumentException

如果列表中不存在此项。

 public synchronized void remove(int position)

从此列表中删除指定位置的某项。

参数：

position - 待删除的项下标。

参见：

add

 public synchronized void delItem(int position)

从此列表中删除指定位置的项。

 public synchronized int getSelectedIndex()

获取列表中选定项的下标。

返回值：

选定项的下标，如果没有选定的项或者有多条选定项则为 -1。

参见：

select, deselect, isIndexSelected

 public synchronized int[] getSelectedIndexes()

获取列表中的选定的多个下标。

返回值：

一个数组，存放滚动列表中选定项的下标。

参见：

select, deselect, isIndexSelected

 public synchronized String getSelectedItem()

获取滚动列表的某一选定项。

返回值：

列表的选定项，若没有选定项则为空。

参见：

select, deselect, isIndexSelected

 public synchronized String[] getSelectedItems()

获取滚动列表的若干选定项。

返回值：

一个数组，存放滚动列表中的选定项。

参见：

select, deselect, isIndexSelected

 public Object[] getSelectedObjects()

用一个数组对象，返回列表中的选定项。

参见：

ItemSelectable

 public void select(int index)

选择滚动列表中指定下标的项。

参数：

index - 待选择的项位置。

参见：

getSelectedItem, deselect, isIndexSelected

 public synchronized void deselect(int index)

取消指定下标处的项的选择状态。

如果指定下标处的项没有选定，或此下标越界，那么忽略此操作。

参数：

index - 取消选择的项位置。

参见：

select, getSelectedItem, isIndexSelected

 public boolean isIndexSelected(int index)

判定滚动列表中的指定项是否是选定的。

参数：

index - 检查的项。

返回值：

如果指定的项是选定的则为 true，否则为 false。

参见：

select, deselect

 public boolean isSelected(int index)

注释：不推荐使用 isSelected()。 如同 JDK 1.1 版，用 isIndexSelected(int) 替换。

 public int getRows()

获取列表的可视行数。

返回值：

获取此滚动列表的可视行数。

 public boolean isMultipleMode()

判定列表是否允许多项选择。

返回值：

如果此列表允许多项选择则为 true，否则为 false。

参见：

setMultipleMode

 public boolean allowsMultipleSelections()

注释：不推荐使用 allowsMultipleSelections()。 如同 JDK 1.1 版，用 isMultipleMode() 替换。

 public synchronized void setMultipleMode(boolean b)

设置标志，用于决定列表是否允许多项选择。

参数：

b - 如果为 true， 允许多项选择；否则一次仅能选择一项。

参见：

isMultipleMode

 public synchronized void setMultipleSelections(boolean b)

注释：不推荐使用 setMultipleSelections()。 如同 JDK 1.1 版，用 setMultipleMode(boolean) 替换。

 public int getVisibleIndex()

获取项下标，它是通过 makeVisible 方法最后产生的。

返回值：

最后一个可视的项下标。

参见：

makeVisible

 public synchronized void makeVisible(int index)

使指定下标的项可视。

参数：

index - 项的位置。

参见：

getVisibleIndex

 public Dimension getPreferredSize(int rows)

获取指定行数的列表的最佳尺寸。

参数：

rows - 列表的行数。

返回值：

显示此滚动列表的最佳尺寸。

参见：

getPreferredSize

 public Dimension preferredSize(int rows)

注释：不推荐使用 preferredSize()。 如同 JDK 1.1 版，用 getPreferredSize(int) 替换。

 public Dimension getPreferredSize()

获取滚动列表的最佳尺寸。

返回值：

显示此滚动列表的最佳尺寸。

覆盖：

类 Component 中的 getPreferredSize

参见：

getPreferredSize

 public Dimension preferredSize()

注释：不推荐使用 preferredSize()。 如同 JDK 1.1 版，用 getPreferredSize() 替换。

覆盖：

类 Component 中的 preferredSize

 public Dimension getMinimumSize(int rows)

获取指定行数的列表的最小尺寸。

参数：

rows - 列表的行数。

返回值：

显示此滚动列表的最小尺寸。

参见：

getMinimumSize

 public Dimension minimumSize(int rows)

注释：不推荐使用 minimumSize()。 如同 JDK 1.1 版，用 getMinimumSize(int) 替换。

 public Dimension getMinimumSize()

确定滚动列表的最小尺寸。

返回值：

显示此滚动列表所需的最小尺寸。

覆盖：

类 Component 中的 getMinimumSize

参见：

getMinimumSize

 public Dimension minimumSize()

注释：不推荐使用 minimumSize()。 如同 JDK 1.1 版，用 getMinimumSize() 替换。

覆盖：

类 Component 中的 minimumSize

 public synchronized void addItemListener(ItemListener l)

添加指定的动作监听者，接收此列表的项目事件。

参数：

l - 项监听者。

参见：

ItemEvent, ItemListener, removeItemListener

 public synchronized void removeItemListener(ItemListener l)

删除指定的项监听者，使之不再接收列表的项事件。

参数：

l - 项监听者。

参见：

ItemEvent, ItemListener, addItemListener

 public synchronized void addActionListener(ActionListener l)

添加指定的动作监听者，接收此列表的动作事件。 当用户在列表项上双击时产生动作事件。

参数：

l - 动作监听者。

参见：

ActionEvent, ActionListener, removeActionListener

 public synchronized void removeActionListener(ActionListener l)

删除指定的动作监听者，使之不再接收列表的动作事件。 当用户在列表项上双击时产生动作事件。

参数：

l - 动作监听者。

参见：

ActionEvent, ActionListener, addActionListener

 protected void processEvent(AWTEvent e)

处理滚动列表中的事件。 如果事件是 ItemEvent 的一个实例，则调用 processItemEvent 方法。否则，如果此事件是 ActionEvent 的一个实例，则调用 processActionEvent 方法。 如果此事件不是项事件和动作事件，那么调用父类的 processEvent 方法。

参数：

e - 事件。

覆盖：

processEvent 类 Component 中的

参见：

ActionEvent, ItemEvent, processActionEvent, processItemEvent

 protected void processItemEvent(ItemEvent e)

处理列表中发生的项事件，将之分配给任一已登记的 ItemListener 对象。

除非此组件的项事件有效，否则不能调用此方法。当如下条件之一发生时，项事件有效：

• 通过 addItemListener 方法，登记了一个 ItemListener 对象。
• 通过执行 enableEvents 方法使项事件有效。

参数：

e - 项事件。

参见：

ItemEvent, ItemListener, addItemListener, enableEvents

 protected void processActionEvent(ActionEvent e)

处理发生在组件上的动作事件，将之分配给任一已登记的 ActionListener 对象。

除非此组件的动作事件有效，否则不能调用此方法。 当如下条件之一发生时，动作事件有效：

• 通过 addActionListener 方法，登记了一个 ActionListener 对象。
• 通过执行 enableEvents 方法使动作事件有效。

参数：

e - 动作事件。

参见：

ActionEvent, ActionListener, addActionListener, enableEvents

 protected String paramString()

返回参数串，表示滚动列表的状态。 此串对调试有用。

返回值：

滚动列表的参数串。

覆盖：

>类 Component 中的 paramString

 public synchronized void delItems(int start,
                                   int end)

注释：不推荐使用 delItems()。 同 JDK 1.1 版中的一样，不作为将来的公共使用方法。要求仅保留为包的私有方法。