javax.swing

接口
异常
java.lang.Object
  继承者 java.awt.Component
      继承者 java.awt.Container
          继承者 javax.swing.JComponent
              继承者 javax.swing.JList
所有已实现的接口:
ImageObserver, MenuContainer, Serializable, Accessible, Scrollable

public class JList
     
extends JComponent
implements Scrollable, Accessible

显示对象列表并且允许用户选择一个或多个项的组件。单独的模型 ListModel 维护列表的内容。

使用能自动构建只读 ListModel 实例的 JList 构造方法,可以方便地显示对象数组或对象 Vector:

 // Create a JList that displays strings from an array

 String[] data = {"one", "two", "three", "four"};
 JList myList = new JList(data);

 // Create a JList that displays the superclasses of JList.class, by
 // creating it with a Vector populated with this data

 Vector superClasses = new Vector();
 Class rootClass = javax.swing.JList.class;
 for(Class cls = rootClass; cls != null; cls = cls.getSuperclass()) {
     superClasses.addElement(cls);
 }
 JList myList = new JList(superClasses);
 
 // The automatically created model is stored in JList's "model"
 // property, which you can retrieve

 ListModel model = myList.getModel();
 for(int i = 0; i < model.getSize(); i++) {
     System.out.println(model.getElementAt(i));
 }
 

可通过构造方法或 setModel 方法向 JList 直接提供 ListModel。内容不需要是静态的,即项数和项值可以随时间而更改。正确的 ListModel 实现在每次发生更改时通知已添加到其中的 javax.swing.event.ListDataListener 集合。这些更改的特性由标识已修改、已添加或已移除的列表索引范围的 javax.swing.event.ListDataEvent 来描述。通过侦听该模型,JListListUI 负责保持可视化表示形式与更改一致。

简单的、动态内容的 JList 应用程序可以使用 DefaultListModel 类维护列表元素。此类实现 ListModel 接口,它还提供类似于 java.util.Vector 的 API。而需要自定义 ListModel 实现的应用程序可能希望子类化 AbstractListModel,它提供对管理和通知侦听器的基本支持。例如,AbstractListModel 的一个只读实现:

 // This list model has about 2^16 elements.  Enjoy scrolling.

 ListModel bigData = new AbstractListModel() {
     public int getSize() { return Short.MAX_VALUE; }
     public Object getElementAt(int index) { return "Index " + index; }
 };
 

JList 的选择状态由另一个独立模型(ListSelectionModel 的一个实例)进行管理。JList 在构造时使用选择模型初始化,它还包含要查询或设置此选择模型的方法。此外,JList 提供了便捷的方法,可以很容易地管理选择。这些方法(如 setSelectedIndexgetSelectedValue)是维护与选择模型交互细节的覆盖方法。默认情况下,JList 的选择模型配置为允许一次选择项的任何组合;选择模式为 MULTIPLE_INTERVAL_SELECTION。选择模式可以在选择模型上进行直接更改,或者通过 JList 的覆盖方法更改。更新选择模型以响应用户动作的责任取决于列表的 ListUI

正确的 ListSelectionModel 实现在每次选择发生更改时通知向其添加的 javax.swing.event.ListSelectionListener 集合。这些更改的特征由标识选择更改范围的 javax.swing.event.ListSelectionEvent 来描述。

侦听列表选择中更改的首选方法是向 JList 中直接添加 ListSelectionListener。然后,JList 负责侦听选择模型并向侦听器通知更改。

侦听选择更改以便使列表可视化表示形式保持最新的责任取决于列表的 ListUI

绘制 JList 中的单元由称为单元渲染器(以 cellRenderer 属性的形式安装在列表上)的委托进行处理。渲染器提供一个其用法类似 "rubber stamp" 的 java.awt.Component 来绘制单元。每当需要绘制单元时,列表的 ListUI 就请求组件的单元渲染器,将其移动到位,然后通过其 paint 方法绘制单元的内容。默认单元渲染器(它使用 JLabel 组件呈现)由列表的 ListUI 安装。用户还可以使用如下代码替换自己的渲染器:


  // Display an icon and a string for each object in the list.

 class MyCellRenderer extends JLabel implements ListCellRenderer {
     final static ImageIcon longIcon = new ImageIcon("long.gif");
     final static ImageIcon shortIcon = new ImageIcon("short.gif");

     // This is the only method defined by ListCellRenderer.
     // We just reconfigure the JLabel each time we're called.

     public Component getListCellRendererComponent(
       JList list,              // the list
       Object value,            // value to display
       int index,               // cell index
       boolean isSelected,      // is the cell selected
       boolean cellHasFocus)    // does the cell have focus
     {
         String s = value.toString();
         setText(s);
         setIcon((s.length() > 10) ? longIcon : shortIcon);
         if (isSelected) {
             setBackground(list.getSelectionBackground());
             setForeground(list.getSelectionForeground());
         } else {
             setBackground(list.getBackground());
             setForeground(list.getForeground());
         }
         setEnabled(list.isEnabled());
         setFont(list.getFont());
         setOpaque(true);
         return this;
     }
 }

 myList.setCellRenderer(new MyCellRenderer());
 

单元渲染器的另一项工作是帮助确定列表的大小信息。默认情况下,列表的 ListUI 通过请求单元渲染器提供每个列表项的首选大小来确定单元的大小。对于大的项列表,这可能开销很大。为了避免这些计算,可以在列表上设置 fixedCellWidthfixedCellHeight,或者根据单个原型值自动计算这些值:


 JList bigDataList = new JList(bigData);

 // We don't want the JList implementation to compute the width
 // or height of all of the list cells, so we give it a string
 // that's as big as we'll need for any cell.  It uses this to
 // compute values for the fixedCellWidth and fixedCellHeight
// properties.

 bigDataList.setPrototypeCellValue("Index 1234567890");
 

JList 不实现直接滚动。要创建一个滚动的列表,请将它作为 JScrollPane 的视口视图。例如:

 JScrollPane scrollPane = new JScrollPane(myList);

 // Or in two steps:
 JScrollPane scrollPane = new JScrollPane();
 scrollPane.getViewport().setView(myList);
 

JList 没有提供两次或三次(或 N 次)鼠标单击的任何特殊处理,但是,如果希望对这些事件采取操作,则可以很方便地添加一个 MouseListener。使用 locationToIndex 方法确定单击的是哪一个单元。例如:

 MouseListener mouseListener = new MouseAdapter() {
     public void mouseClicked(MouseEvent e) {
         if (e.getClickCount() == 2) {
             int index = list.locationToIndex(e.getPoint());
             System.out.println("Double clicked on Item " + index);
          }
     }
 };
 list.addMouseListener(mouseListener);
 

警告:Swing 不是线程安全的。有关更多信息,请参阅 Swing's Threading Policy

警告:此类的序列化对象与以后的 Swing 版本不兼容。当前序列化支持适用于短期存储,或适用于在运行相同 Swing 版本的应用程序之间进行 RMI(Remote Method Invocation,远程方法调用)。从 1.4 版本开始,已在 java.beans 包中添加了支持所有 JavaBeansTM 长期存储的功能。请参见 XMLEncoder

有关更多文档,请参阅 The Java Tutorial 中的 How to Use Lists。另请参见 The Swing Connection 中的文章 Advanced JList Programming。  

另请参见:
ListModel, AbstractListModel, DefaultListModel, ListSelectionModel, DefaultListSelectionModel, ListCellRenderer, DefaultListCellRenderer

嵌套类摘要
protected  class JList.AccessibleJList
          此类实现 JList 类的可访问性支持。
static class JList.DropLocation
          TransferHandler.DropLocation 的一个子类,表示 JList 的放置位置 (drop location)。
 
从类 javax.swing.JComponent 继承的嵌套类/接口
JComponent.AccessibleJComponent
 
从类 java.awt.Container 继承的嵌套类/接口
Container.AccessibleAWTContainer
 
从类 java.awt.Component 继承的嵌套类/接口
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
字段摘要
static int HORIZONTAL_WRAP
          指示“报纸样式”布局,单元按先水平后垂直排列。
static int VERTICAL
          指示单个列中单元的垂直布局;默认布局。
static int VERTICAL_WRAP
          指示“报纸样式”布局,单元按先垂直后水平排列。
 
从类 javax.swing.JComponent 继承的字段
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
从类 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
 
构造方法摘要
JList()
          构造一个具有空的、只读模型的 JList
JList(ListModel dataModel)
          根据指定的非 null 模型构造一个显示元素的 JList
JList(Object[] listData)
          构造一个 JList,使其显示指定数组中的元素。
JList(Vector<?> listData)
          构造一个 JList,使其显示指定 Vector 中的元素。
 
方法摘要
 void addListSelectionListener(ListSelectionListener listener)
          将侦听器添加到列表,每次选择发生更改时将获得通知;这是侦听选择状态更改的首选方式。
 void addSelectionInterval(int anchor, int lead)
          将选择设置为指定间隔与当前选择的并集。
 void clearSelection()
          清除选择;调用此方法后,isSelectionEmpty 将返回 true
protected  ListSelectionModel createSelectionModel()
          返回一个 DefaultListSelectionModel 实例;在构造期间调用此方法初始化列表的选择模型属性。
 void ensureIndexIsVisible(int index)
          滚动封闭视口中的列表,使指定单元完全可见。
protected  void fireSelectionValueChanged(int firstIndex, int lastIndex, boolean isAdjusting)
          通知直接添加到列表的 ListSelectionListener 对列表模型做出了选择更改。
 AccessibleContext getAccessibleContext()
          获取与此 JList 关联的 AccessibleContext
 int getAnchorSelectionIndex()
          返回定位选择索引。
 Rectangle getCellBounds(int index0, int index1)
          返回列表的坐标系统中两个索引所指定单元范围内的边界矩形。
 ListCellRenderer getCellRenderer()
          返回负责绘制列表项的对象。
 boolean getDragEnabled()
          返回是否启用自动拖动处理。
 JList.DropLocation getDropLocation()
          返回在该组件上执行 DnD 操作期间此组件应该视觉上指示为放置位置的位置;如果当前没有任何显示的位置,则返回 null
 DropMode getDropMode()
          返回此组件的放置模式。
 int getFirstVisibleIndex()
          返回当前可见的最小的列表索引。
 int getFixedCellHeight()
          返回 fixedCellHeight 属性的值。
 int getFixedCellWidth()
          返回 fixedCellWidth 属性的值。
 int getLastVisibleIndex()
          返回当前可见的最大列表索引。
 int getLayoutOrientation()
          返回列表的布局方向属性:如果布局是单列单元,则返回 VERTICAL;如果布局是“报纸样式”并且内容按先垂直后水平排列, 则返回 VERTICAL_WRAP;如果布局是“报纸样式”并且内容按先水平后垂直排列,则返回 HORIZONTAL_WRAP
 int getLeadSelectionIndex()
          返回前导选择索引。
 ListSelectionListener[] getListSelectionListeners()
          返回通过 addListSelectionListener 添加到此 JList 中的所有 ListSelectionListener 所组成的数组。
 int getMaxSelectionIndex()
          返回选择的最大单元索引;如果选择为空,则返回 -1
 int getMinSelectionIndex()
          返回选择的最小单元索引;如果选择为空,则返回 -1
 ListModel getModel()
          返回保存由 JList 组件显示的项列表的数据模型。
 int getNextMatch(String prefix, int startIndex, Position.Bias bias)
          返回其 toString 值以给定前缀开头的下一个列表元素。
 Dimension getPreferredScrollableViewportSize()
          计算显示 visibleRowCount 行所需的视口的大小。
 Object getPrototypeCellValue()
          返回“原型的”单元值,即用于计算单元的固定宽度和高度的值。
 int getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction)
          返回为显露上一个或下一个块而滚动的距离。
 boolean getScrollableTracksViewportHeight()
          如果此 JListJViewport 中显示并且视口的高度大于列表的首选高度,或者布局方向为 VERTICAL_WRAPvisibleRowCount <= 0,则返回 true;否则返回 false
 boolean getScrollableTracksViewportWidth()
          如果此 JListJViewport 中显示并且视口的宽度大于列表的首选宽度,或者布局方向为 HORIZONTAL_WRAPvisibleRowCount <= 0,则返回 true;否则返回 false
 int getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction)
          返回为显露上一个或下一个行(垂直滚动)或列(水平滚动)而滚动的距离。
 int getSelectedIndex()
          返回最小的选择单元索引;只选择了列表中单个项时,返回该选择
 int[] getSelectedIndices()
          返回所选的全部索引的数组(按升序排列)。
 Object getSelectedValue()
          返回最小的选择单元索引的值;只选择了列表中单个项时,返回所选值
 Object[] getSelectedValues()
          返回所有选择值的数组,根据其列表中的索引顺序按升序排序。
 Color getSelectionBackground()
          返回用于绘制选定项的背景的颜色。
 Color getSelectionForeground()
          返回用于绘制选定项的前景的颜色。
 int getSelectionMode()
          返回列表的当前选择模式。
 ListSelectionModel getSelectionModel()
          返回当前选择模型。
 String getToolTipText(MouseEvent event)
          返回用于给定事件的工具提示文本。
 ListUI getUI()
          返回呈现此组件的外观对象 ListUI
 String getUIClassID()
          返回 "ListUI",它是用于查找定义此组件外观的 javax.swing.plaf.ListUI 类名称的 UIDefaults 键。
 boolean getValueIsAdjusting()
          返回选择模型的 isAdjusting 属性的值。
 int getVisibleRowCount()
          返回 visibleRowCount 属性的值。
 Point indexToLocation(int index)
          返回列表的坐标系统中指定项的原点。
 boolean isSelectedIndex(int index)
          如果选择了指定的索引,则返回 true;否则返回 false
 boolean isSelectionEmpty()
          如果什么也没有选择,则返回 true;否则返回 false
 int locationToIndex(Point location)
          返回最接近列表的坐标系统中给定位置的单元索引。
protected  String paramString()
          返回此 JListString 表示形式。
 void removeListSelectionListener(ListSelectionListener listener)
          从列表中移除一个选择侦听器。
 void removeSelectionInterval(int index0, int index1)
          将选择设置为指定间隔和当前选择的差集。
 void setCellRenderer(ListCellRenderer cellRenderer)
          设置用于绘制列表中每个单元的委托。
 void setDragEnabled(boolean b)
          打开或关闭自动拖动处理。
 void setDropMode(DropMode dropMode)
          设置此组件的放置模式。
 void setFixedCellHeight(int height)
          设置一个固定值,将用于列表中每个单元的高度。
 void setFixedCellWidth(int width)
          设置一个固定值,将用于列表中每个单元的宽度。
 void setLayoutOrientation(int layoutOrientation)
          定义布置列表单元的方式。
 void setListData(Object[] listData)
          根据一个对象数组构造只读 ListModel,然后对此模型调用 setModel
 void setListData(Vector<?> listData)
          根据一个 Vector 构造只读 ListModel,然后对此模型调用 setModel
 void setModel(ListModel model)
          设置表示列表内容或列表“值”的模型,通知属性更改侦听器,然后清除列表选择。
 void setPrototypeCellValue(Object prototypeCellValue)
          设置 prototypeCellValue 属性,然后(如果新值为非 null)计算 fixedCellWidthfixedCellHeight 属性:请求单元渲染器组件提供单元渲染器的给定值(及索引 0),并使用该组件的首选大小。
 void setSelectedIndex(int index)
          选择单个单元。
 void setSelectedIndices(int[] indices)
          将选择更改为给定数组所指定的索引的集合。
 void setSelectedValue(Object anObject, boolean shouldScroll)
          从列表中选择指定的对象。
 void setSelectionBackground(Color selectionBackground)
          设置用于绘制选定项的背景的颜色,单元渲染器可以使用此颜色填充所选单元。
 void setSelectionForeground(Color selectionForeground)
          设置用于绘制选定项的前景的颜色,单元渲染器可以使用此颜色呈现文本和图形。
 void setSelectionInterval(int anchor, int lead)
          选择指定的间隔。
 void setSelectionMode(int selectionMode)
          设置列表的选择模式。
 void setSelectionModel(ListSelectionModel selectionModel)
          将列表的 selectionModel 设置为非 nullListSelectionModel 实现。
 void setUI(ListUI ui)
          设置呈现此组件的外观对象 ListUI
 void setValueIsAdjusting(boolean b)
          设置选择模型的 valueIsAdjusting 属性。
 void setVisibleRowCount(int visibleRowCount)
          设置 visibleRowCount 属性,对于不同的布局方向,此方法有不同的含义:对于 VERTICAL 布局方向,此方法设置要显示的首选行数(不要求滚动);对于其他方向,它影响单元的包装。
 void updateUI()
          重置 ListUI 属性,将其设置为当前外观所提供的值。
 
从类 javax.swing.JComponent 继承的方法
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImm

JDK 1.6 中文手册