JList (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.swing
class JList

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JList

All Implemented Interfaces:: MenuContainer, ImageObserver, Serializable, Accessible, Scrollable, TransferHandler.HasGetTransferHandler

Most common ways to construct:

DefaultListModel model = …;

JList list = new JList(model);

Based on 21 examples

JList list = new JList();

Based on 20 examples

Vector superClasses = …;

JList classList = new JList(superClasses);

Based on 19 examples

ListSelectionEvent e = …;

JList l = (JList)e.getSource();

Based on 17 examples

public class JList
extends JComponent
implements Scrollable, Accessible

A component that displays a list of objects and allows the user to select one or more items. A separate model, {@code ListModel}, maintains the contents of the list.

It's easy to display an array or Vector of objects, using the {@code JList} constructor that automatically builds a read-only {@code ListModel} instance for you:

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

A {@code ListModel} can be supplied directly to a {@code JList} by way of a constructor or the {@code setModel} method. The contents need not be static - the number of items, and the values of items can change over time. A correct {@code ListModel} implementation notifies the set of {@code javax.swing.event.ListDataListener}s that have been added to it, each time a change occurs. These changes are characterized by a {@code javax.swing.event.ListDataEvent}, which identifies the range of list indices that have been modified, added, or removed. {@code JList}'s {@code ListUI} is responsible for keeping the visual representation up to date with changes, by listening to the model.

Simple, dynamic-content, {@code JList} applications can use the {@code DefaultListModel} class to maintain list elements. This class implements the {@code ListModel} interface and also provides a java.util.Vector-like API. Applications that need a more custom ListModel implementation may instead wish to subclass {@code AbstractListModel}, which provides basic support for managing and notifying listeners. For example, a read-only implementation of {@code 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; }
 };

The selection state of a {@code JList} is managed by another separate model, an instance of {@code ListSelectionModel}. {@code JList} is initialized with a selection model on construction, and also contains methods to query or set this selection model. Additionally, {@code JList} provides convenient methods for easily managing the selection. These methods, such as {@code setSelectedIndex} and {@code getSelectedValue}, are cover methods that take care of the details of interacting with the selection model. By default, {@code JList}'s selection model is configured to allow any combination of items to be selected at a time; selection mode {@code MULTIPLE_INTERVAL_SELECTION}. The selection mode can be changed on the selection model directly, or via {@code JList}'s cover method. Responsibility for updating the selection model in response to user gestures lies with the list's {@code ListUI}.

A correct {@code ListSelectionModel} implementation notifies the set of {@code javax.swing.event.ListSelectionListener}s that have been added to it each time a change to the selection occurs. These changes are characterized by a {@code javax.swing.event.ListSelectionEvent}, which identifies the range of the selection change.

The preferred way to listen for changes in list selection is to add {@code ListSelectionListener}s directly to the {@code JList}. {@code JList} then takes care of listening to the the selection model and notifying your listeners of change.

Responsibility for listening to selection changes in order to keep the list's visual representation up to date lies with the list's {@code ListUI}.

Painting of cells in a {@code JList} is handled by a delegate called a cell renderer, installed on the list as the {@code cellRenderer} property. The renderer provides a {@code java.awt.Component} that is used like a "rubber stamp" to paint the cells. Each time a cell needs to be painted, the list's {@code ListUI} asks the cell renderer for the component, moves it into place, and has it paint the contents of the cell by way of its {@code paint} method. A default cell renderer, which uses a {@code JLabel} component to render, is installed by the lists's {@code ListUI}. You can substitute your own renderer using code like this:

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

Another job for the cell renderer is in helping to determine sizing information for the list. By default, the list's {@code ListUI} determines the size of cells by asking the cell renderer for its preferred size for each list item. This can be expensive for large lists of items. To avoid these calculations, you can set a {@code fixedCellWidth} and {@code fixedCellHeight} on the list, or have these values calculated automatically based on a single prototype value:

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

{@code JList} doesn't implement scrolling directly. To create a list that scrolls, make it the viewport view of a {@code JScrollPane}. For example:

 JScrollPane scrollPane = new JScrollPane(myList);

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

{@code JList} doesn't provide any special handling of double or triple (or N) mouse clicks, but it's easy to add a {@code MouseListener} if you wish to take action on these events. Use the {@code locationToIndex} method to determine what cell was clicked. For example:

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

Warning: Swing is not thread safe. For more information see Swing's Threading Policy.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans^TM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}.

See How to Use Lists in The Java Tutorial for further documentation. Also see the article Advanced JList Programming in The Swing Connection.

Nested Class Summary
`protected class`	`JList.AccessibleJList` This class implements accessibility support for the class.
`static class`	`JList.DropLocation` A subclass of `TransferHandler.DropLocation` representing a drop location for a `JList`.

Nested classes/interfaces inherited from class javax.swing.JComponent
`JComponent.AccessibleJComponent`

Nested classes/interfaces inherited from class java.awt.Container
`Container.AccessibleAWTContainer`

Nested classes/interfaces inherited from class java.awt.Component
`Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy`

Field Summary
`static int`	`HORIZONTAL_WRAP` Indicates a "newspaper style" layout with cells flowing horizontally then vertically.
`static int`	`VERTICAL` Indicates a vertical layout of cells, in a single column; the default layout.
`static int`	`VERTICAL_WRAP` Indicates a "newspaper style" layout with cells flowing vertically then horizontally.

Fields inherited from class javax.swing.JComponent
`accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW`

Fields inherited from class java.awt.Component
`BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT`

Constructor Summary
`JList()` Constructs a `JList` with an empty, read-only, model.
`JList(ListModel dataModel)` Constructs a that displays elements from the specified, , model.
`JList(Object[] listData)` Constructs a `JList` that displays the elements in the specified array.
`JList(Vector listData)` Constructs a `JList` that displays the elements in the specified `Vector`.

Method Summary
`void`	`addListSelectionListener(ListSelectionListener listener)` Adds a listener to the list, to be notified each time a change to the selection occurs; the preferred way of listening for selection state changes.
`void`	`addSelectionInterval(int anchor, int lead)` Sets the selection to be the union of the specified interval with current selection.
`void`	`clearSelection()` Clears the selection; after calling this method, will return .
`protected ListSelectionModel`	`createSelectionModel()` Returns an instance of ; called during construction to initialize the list's selection model property.
`void`	`ensureIndexIsVisible(int index)` Scrolls the list within an enclosing viewport to make the specified cell completely visible.
`protected void`	`fireSelectionValueChanged(int firstIndex, int lastIndex, boolean isAdjusting)` Notifies s added directly to the list of selection changes made to the selection model.
`AccessibleContext`	`getAccessibleContext()` Gets the associated with this .
`int`	`getAnchorSelectionIndex()` Returns the anchor selection index.
`Rectangle`	`getCellBounds(int index0, int index1)` Returns the bounding rectangle, in the list's coordinate system, for the range of cells specified by the two indices.
`ListCellRenderer`	`getCellRenderer()` Returns the object responsible for painting list items.
`boolean`	`getDragEnabled()` Returns whether or not automatic drag handling is enabled.
`JList.DropLocation`	`getDropLocation()` Returns the location that this component should visually indicate as the drop location during a DnD operation over the component, or if no location is to currently be shown.
`DropMode`	`getDropMode()` Returns the drop mode for this component.
`int`	`getFirstVisibleIndex()` Returns the smallest list index that is currently visible.
`int`	`getFixedCellHeight()` Returns the value of the property.
`int`	`getFixedCellWidth()` Returns the value of the property.
`int`	`getLastVisibleIndex()` Returns the largest list index that is currently visible.
`int`	`getLayoutOrientation()` Returns the layout orientation property for the list: if the layout is a single column of cells, if the layout is "newspaper style" with the content flowing vertically then horizontally, or if the layout is "newspaper style" with the content flowing horizontally then vertically.
`int`	`getLeadSelectionIndex()` Returns the lead selection index.
`ListSelectionListener[]`	`getListSelectionListeners()` Returns an array of all the s added to this by way of .
`int`	`getMaxSelectionIndex()` Returns the largest selected cell index, or if the selection is empty.
`int`	`getMinSelectionIndex()` Returns the smallest selected cell index, or if the selection is empty.
`ListModel`	`getModel()` Returns the data model that holds the list of items displayed by the `JList` component.
`int`	`getNextMatch(String prefix, int startIndex, Position.Bias bias)` Returns the next list element whose value starts with the given prefix.
`Dimension`	`getPreferredScrollableViewportSize()` Computes the size of viewport needed to display rows.
`Object`	`getPrototypeCellValue()` Returns the "prototypical" cell value -- a value used to calculate a fixed width and height for cells.
`int`	`getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction)` Returns the distance to scroll to expose the next or previous block.
`boolean`	`getScrollableTracksViewportHeight()` Returns if this is displayed in a and the viewport is taller than the list's preferred height, or if the layout orientation is and ; otherwise returns .
`boolean`	`getScrollableTracksViewportWidth()` Returns if this is displayed in a and the viewport is wider than the list's preferred width, or if the layout orientation is and ; otherwise returns .
`int`	`getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction)` Returns the distance to scroll to expose the next or previous row (for vertical scrolling) or column (for horizontal scrolling).
`int`	`getSelectedIndex()` Returns the smallest selected cell index; the selection when only a single item is selected in the list.
`int[]`	`getSelectedIndices()` Returns an array of all of the selected indices, in increasing order.
`Object`	`getSelectedValue()` Returns the value for the smallest selected cell index; the selected value when only a single item is selected in the list.
`Object[]`	`getSelectedValues()` Returns an array of all the selected values, in increasing order based on their indices in the list.
`Color`	`getSelectionBackground()` Returns the color used to draw the background of selected items.
`Color`	`getSelectionForeground()` Returns the color used to draw the foreground of selected items.
`int`	`getSelectionMode()` Returns the current selection mode for the list.
`ListSelectionModel`	`getSelectionModel()` Returns the current selection model.
`String`	`getToolTipText(MouseEvent event)` Returns the tooltip text to be used for the given event.
`ListUI`	`getUI()` Returns the , the look and feel object that renders this component.
`String`	`getUIClassID()` Returns , the `UIDefaults` key used to look up the name of the class that defines the look and feel for this component.
`boolean`	`getValueIsAdjusting()` Returns the value of the selection model's property.
`int`	`getVisibleRowCount()` Returns the value of the property.
`Point`	`indexToLocation(int index)` Returns the origin of the specified item in the list's coordinate system.
`boolean`	`isSelectedIndex(int index)` Returns if the specified index is selected, else .
`boolean`	`isSelectionEmpty()` Returns if nothing is selected, else .
`int`	`locationToIndex(Point location)` Returns the cell index closest to the given location in the list's coordinate system.
`protected String`	`paramString()` Returns a representation of this .
`void`	`removeListSelectionListener(ListSelectionListener listener)` Removes a selection listener from the list.
`void`	`removeSelectionInterval(int index0, int index1)` Sets the selection to be the set difference of the specified interval and the current selection.
`void`	`setCellRenderer(ListCellRenderer cellRenderer)` Sets the delegate that is used to paint each cell in the list.
`void`	`setDragEnabled(boolean b)` Turns on or off automatic drag handling.
`void`	`setDropMode(DropMode dropMode)` Sets the drop mode for this component.
`void`	`setFixedCellHeight(int height)` Sets a fixed value to be used for the height of every cell in the list.
`void`	`setFixedCellWidth(int width)` Sets a fixed value to be used for the width of every cell in the list.
`void`	`setLayoutOrientation(int layoutOrientation)` Defines the way list cells are layed out.
`void`	`setListData(Object[] listData)` Constructs a read-only `ListModel` from an array of objects, and calls with this model.
`void`	`setListData(Vector listData)` Constructs a read-only `ListModel` from a `Vector` and calls with this model.
`void`	`setModel(ListModel model)` Sets the model that represents the contents or "value" of the list, notifies property change listeners, and then clears the list's selection.
`void`	`setPrototypeCellValue(Object prototypeCellValue)` Sets the property, and then (if the new value is ), computes the and properties by requesting the cell renderer component for the given value (and index 0) from the cell renderer, and using that component's preferred size.
`void`	`setSelectedIndex(int index)` Selects a single cell.
`void`	`setSelectedIndices(int[] indices)` Changes the selection to be the set of indices specified by the given array.
`void`	`setSelectedValue(Object anObject, boolean shouldScroll)` Selects the specified object from the list.
`void`	`setSelectionBackground(Color selectionBackground)` Sets the color used to draw the background of selected items, which cell renderers can use fill selected cells.
`void`	`setSelectionForeground(Color selectionForeground)` Sets the color used to draw the foreground of selected items, which cell renderers can use to render text and graphics.
`void`	`setSelectionInterval(int anchor, int lead)` Selects the specified interval.
`void`	`setSelectionMode(int selectionMode)` Sets the selection mode for the list.
`void`	`setSelectionModel(ListSelectionModel selectionModel)` Sets the `selectionModel` for the list to a non-`null` `ListSelectionModel` implementation.
`void`	`setUI(ListUI ui)` Sets the , the look and feel object that renders this component.
`void`	`setValueIsAdjusting(boolean b)` Sets the selection model's property.
`void`	`setVisibleRowCount(int visibleRowCount)` Sets the property, which has different meanings depending on the layout orientation: For a layout orientation, this sets the preferred number of rows to display without requiring scrolling; for other orientations, it affects the wrapping of cells.
`void`	`updateUI()` Resets the property by setting it to the value provided by the current look and feel.

Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class javax.swing.JComponent


addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, update, validate, validateTree

Methods inherited from class java.awt.Container


add, add, add, add, add, addContainerListener, addImpl, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, update, validate, validateTree

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, 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, getAccessibleContext, 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, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, 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, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, 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

Methods inherited from class java.awt.Component


action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, 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, getAccessibleContext, 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, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, 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, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, 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

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

HORIZONTAL_WRAP

public static final int HORIZONTAL_WRAP

Indicates a "newspaper style" layout with cells flowing horizontally then vertically.

VERTICAL

public static final int VERTICAL

Indicates a vertical layout of cells, in a single column; the default layout.

VERTICAL_WRAP

public static final int VERTICAL_WRAP

Indicates a "newspaper style" layout with cells flowing vertically then horizontally.

Constructor Detail

JList

public JList()

Constructs a JList with an empty, read-only, model.

JList

public JList(ListModel dataModel)

Constructs a {@code JList} that displays elements from the specified, {@code non-null}, model. All {@code JList} constructors delegate to this one.

This constructor registers the list with the {@code ToolTipManager}, allowing for tooltips to be provided by the cell renderers.

Parameters:: dataModel - the model for the list

JList

public JList(Object[] listData)

Constructs a JList that displays the elements in the specified array. This constructor creates a read-only model for the given array, and then delegates to the constructor that takes a {@code ListModel}.

Attempts to pass a {@code null} value to this method results in undefined behavior and, most likely, exceptions. The created model references the given array directly. Attempts to modify the array after constructing the list results in undefined behavior.

Parameters:: listData - the array of Objects to be loaded into the data model, {@code non-null}

JList

public JList(Vector listData)

Constructs a JList that displays the elements in the specified Vector. This constructor creates a read-only model for the given {@code Vector}, and then delegates to the constructor that takes a {@code ListModel}.

Attempts to pass a {@code null} value to this method results in undefined behavior and, most likely, exceptions. The created model references the given {@code Vector} directly. Attempts to modify the {@code Vector} after constructing the list results in undefined behavior.

Parameters:: listData - the Vector to be loaded into the data model, {@code non-null}

Method Detail

addListSelectionListener

public void addListSelectionListener(ListSelectionListener listener)

Adds a listener to the list, to be notified each time a change to the selection occurs; the preferred way of listening for selection state changes. {@code JList} takes care of listening for selection state changes in the selection model, and notifies the given listener of each change. {@code ListSelectionEvent}s sent to the listener have a {@code source} property set to this list.

Parameters:: listener - the {@code ListSelectionListener} to add

addSelectionInterval

public void addSelectionInterval(int anchor,
                                 int lead)

Sets the selection to be the union of the specified interval with current selection. Both the {@code anchor} and {@code lead} indices are included. {@code anchor} doesn't have to be less than or equal to {@code lead}. This is a cover method that delegates to the method of the same name on the list's selection model.

Refer to the documentation of the selection model class being used for details on how values less than {@code 0} are handled.

Parameters:: anchor - the first index to add to the selection; lead - the last index to add to the selection

clearSelection

public void clearSelection()

Clears the selection; after calling this method, {@code isSelectionEmpty} will return {@code true}. This is a cover method that delegates to the method of the same name on the list's selection model.

createSelectionModel

protected ListSelectionModel createSelectionModel()

Returns an instance of {@code DefaultListSelectionModel}; called during construction to initialize the list's selection model property.

Returns:: a {@code DefaultListSelecitonModel}, used to initialize the list's selection model property during construction

ensureIndexIsVisible

public void ensureIndexIsVisible(int index)

Scrolls the list within an enclosing viewport to make the specified cell completely visible. This calls {@code scrollRectToVisible} with the bounds of the specified cell. For this method to work, the {@code JList} must be within a JViewport.

If the given index is outside the list's range of cells, this method results in nothing.

Parameters:: index - the index of the cell to make visible

fireSelectionValueChanged

protected void fireSelectionValueChanged(int firstIndex,
                                         int lastIndex,
                                         boolean isAdjusting)

Notifies {@code ListSelectionListener}s added directly to the list of selection changes made to the selection model. {@code JList} listens for changes made to the selection in the selection model, and forwards notification to listeners added to the list directly, by calling this method.

This method constructs a {@code ListSelectionEvent} with this list as the source, and the specified arguments, and sends it to the registered {@code ListSelectionListeners}.

Parameters:: firstIndex - the first index in the range, {@code <= lastIndex}; lastIndex - the last index in the range, {@code >= firstIndex}; isAdjusting - whether or not this is one in a series of multiple events, where changes are still being made

getAccessibleContext

public AccessibleContext getAccessibleContext()

Gets the {@code AccessibleContext} associated with this {@code JList}. For {@code JList}, the {@code AccessibleContext} takes the form of an {@code AccessibleJList}.

A new {@code AccessibleJList} instance is created if necessary.

Overrides:: getAccessibleContext in class JComponent
Returns:: an {@code AccessibleJList} that serves as the {@code AccessibleContext} of this {@code JList}

getAnchorSelectionIndex

public int getAnchorSelectionIndex()

Returns the anchor selection index. This is a cover method that delegates to the method of the same name on the list's selection model.

Returns:: the anchor selection index

getCellBounds

public Rectangle getCellBounds(int index0,
                               int index1)

Returns the bounding rectangle, in the list's coordinate system, for the range of cells specified by the two indices. These indices can be supplied in any order.

If the smaller index is outside the list's range of cells, this method returns {@code null}. If the smaller index is valid, but the larger index is outside the list's range, the bounds of just the first index is returned. Otherwise, the bounds of the valid range is returned.

This is a cover method that delegates to the method of the same name in the list's {@code ListUI}. It returns {@code null} if the list has no {@code ListUI}.

Parameters:: index0 - the first index in the range; index1 - the second index in the range
Returns:: the bounding rectangle for the range of cells, or {@code null}

getCellRenderer

public ListCellRenderer getCellRenderer()

Returns the object responsible for painting list items.

Returns:: the value of the {@code cellRenderer} property

getDragEnabled

public boolean getDragEnabled()

Returns whether or not automatic drag handling is enabled.

Returns:: the value of the {@code dragEnabled} property

getDropLocation

public final JList.DropLocation getDropLocation()

Returns the location that this component should visually indicate as the drop location during a DnD operation over the component, or {@code null} if no location is to currently be shown.

This method is not meant for querying the drop location from a {@code TransferHandler}, as the drop location is only set after the {@code TransferHandler}'s canImport has returned and has allowed for the location to be shown.

When this property changes, a property change event with name "dropLocation" is fired by the component.

By default, responsibility for listening for changes to this property and indicating the drop location visually lies with the list's {@code ListUI}, which may paint it directly and/or install a cell renderer to do so. Developers wishing to implement custom drop location painting and/or replace the default cell renderer, may need to honor this property.

Returns:: the drop location

getDropMode

public final DropMode getDropMode()

Returns the drop mode for this component.

Returns:: the drop mode for this component

getFirstVisibleIndex

public int getFirstVisibleIndex()

Returns the smallest list index that is currently visible. In a left-to-right {@code componentOrientation}, the first visible cell is found closest to the list's upper-left corner. In right-to-left orientation, it is found closest to the upper-right corner. If nothing is visible or the list is empty, {@code -1} is returned. Note that the returned cell may only be partially visible.

Returns:: the index of the first visible cell

getFixedCellHeight

public int getFixedCellHeight()

Returns the value of the {@code fixedCellHeight} property.

Returns:: the fixed cell height

getFixedCellWidth

public int getFixedCellWidth()

Returns the value of the {@code fixedCellWidth} property.

Returns:: the fixed cell width

getLastVisibleIndex

public int getLastVisibleIndex()

Returns the largest list index that is currently visible. If nothing is visible or the list is empty, {@code -1} is returned. Note that the returned cell may only be partially visible.

Returns:: the index of the last visible cell

getLayoutOrientation

public int getLayoutOrientation()

Returns the layout orientation property for the list: {@code VERTICAL} if the layout is a single column of cells, {@code VERTICAL_WRAP} if the layout is "newspaper style" with the content flowing vertically then horizontally, or {@code HORIZONTAL_WRAP} if the layout is "newspaper style" with the content flowing horizontally then vertically.

Returns:: the value of the {@code layoutOrientation} property

getLeadSelectionIndex

public int getLeadSelectionIndex()

Returns the lead selection index. This is a cover method that delegates to the method of the same name on the list's selection model.

Returns:: the lead selection index

getListSelectionListeners

public ListSelectionListener[] getListSelectionListeners()

Returns an array of all the {@code ListSelectionListener}s added to this {@code JList} by way of {@code addListSelectionListener}.

Returns:: all of the {@code ListSelectionListener}s on this list, or an empty array if no listeners have been added

getMaxSelectionIndex

public int getMaxSelectionIndex()

Returns the largest selected cell index, or {@code -1} if the selection is empty. This is a cover method that delegates to the method of the same name on the list's selection model.

Returns:: the largest selected cell index

getMinSelectionIndex

public int getMinSelectionIndex()

Returns the smallest selected cell index, or {@code -1} if the selection is empty. This is a cover method that delegates to the method of the same name on the list's selection model.

Returns:: the smallest selected cell index, or {@code -1}

getModel

public ListModel getModel()

Returns the data model that holds the list of items displayed by the JList component.

Returns:: the ListModel that provides the displayed list of items

getNextMatch

public int getNextMatch(String prefix,
                        int startIndex,
                        Position.Bias bias)

Returns the next list element whose {@code toString} value starts with the given prefix.

Parameters:: prefix - the string to test for a match; startIndex - the index for starting the search; bias - the search direction, either Position.Bias.Forward or Position.Bias.Backward.
Returns:: the index of the next list element that starts with the prefix; otherwise {@code -1}

getPreferredScrollableViewportSize

public Dimension getPreferredScrollableViewportSize()

Computes the size of viewport needed to display {@code visibleRowCount} rows. The value returned by this method depends on the layout orientation:

{@code VERTICAL}:
This is trivial if both {@code fixedCellWidth} and {@code fixedCellHeight} have been set (either explicitly or by specifying a prototype cell value). The width is simply the {@code fixedCellWidth} plus the list's horizontal insets. The height is the {@code fixedCellHeight} multiplied by the {@code visibleRowCount}, plus the list's vertical insets.

If either {@code fixedCellWidth} or {@code fixedCellHeight} haven't been specified, heuristics are used. If the model is empty, the width is the {@code fixedCellWidth}, if greater than {@code 0}, or a hard-coded value of {@code 256}. The height is the {@code fixedCellHeight} multiplied by {@code visibleRowCount}, if {@code fixedCellHeight} is greater than {@code 0}, otherwise it is a hard-coded value of {@code 16} multiplied by {@code visibleRowCount}.

If the model isn't empty, the width is the preferred size's width, typically the width of the widest list element. The height is the {@code fixedCellHeight} multiplied by the {@code visibleRowCount}, plus the list's vertical insets.

{@code VERTICAL_WRAP} or {@code HORIZONTAL_WRAP}:
This method simply returns the value from {@code getPreferredSize}. The list's {@code ListUI} is expected to override {@code getPreferredSize} to return an appropriate value.

Returns:: a dimension containing the size of the viewport needed to display {@code visibleRowCount} rows

getPrototypeCellValue

public Object getPrototypeCellValue()

Returns the "prototypical" cell value -- a value used to calculate a fixed width and height for cells. This can be {@code null} if there is no such value.

Returns:: the value of the {@code prototypeCellValue} property

getScrollableBlockIncrement

public int getScrollableBlockIncrement(Rectangle visibleRect,
                                       int orientation,
                                       int direction)

Returns the distance to scroll to expose the next or previous block.

For vertical scrolling, the following rules are used:

if scrolling down, returns the distance to scroll so that the last visible element becomes the first completely visible element
if scrolling up, returns the distance to scroll so that the first visible element becomes the last completely visible element
returns {@code visibleRect.height} if the list is empty

For horizontal scrolling, when the layout orientation is either {@code VERTICAL_WRAP} or {@code HORIZONTAL_WRAP}:

if scrolling right, returns the distance to scroll so that the last visible element becomes the first completely visible element
if scrolling left, returns the distance to scroll so that the first visible element becomes the last completely visible element
returns {@code visibleRect.width} if the list is empty

For horizontal scrolling and {@code VERTICAL} orientation, returns {@code visibleRect.width}.

Note that the value of {@code visibleRect} must be the equal to {@code this.getVisibleRect()}.

Parameters:: visibleRect - the view area visible within the viewport; orientation - {@code SwingConstants.HORIZONTAL} or {@code SwingConstants.VERTICAL}; direction - less or equal to zero to scroll up/back, greater than zero for down/forward
Returns:: the "block" increment for scrolling in the specified direction; always positive

getScrollableTracksViewportHeight

public boolean getScrollableTracksViewportHeight()

Returns {@code true} if this {@code JList} is displayed in a {@code JViewport} and the viewport is taller than the list's preferred height, or if the layout orientation is {@code VERTICAL_WRAP} and {@code visibleRowCount <= 0}; otherwise returns {@code false}.

If {@code false}, then don't track the viewport's height. This allows vertical scrolling if the {@code JViewport} is itself embedded in a {@code JScrollPane}.

Returns:: whether or not an enclosing viewport should force the list's height to match its own

getScrollableTracksViewportWidth

public boolean getScrollableTracksViewportWidth()

Returns {@code true} if this {@code JList} is displayed in a {@code JViewport} and the viewport is wider than the list's preferred width, or if the layout orientation is {@code HORIZONTAL_WRAP} and {@code visibleRowCount <= 0}; otherwise returns {@code false}.

If {@code false}, then don't track the viewport's width. This allows horizontal scrolling if the {@code JViewport} is itself embedded in a {@code JScrollPane}.

Returns:: whether or not an enclosing viewport should force the list's width to match its own

getScrollableUnitIncrement

public int getScrollableUnitIncrement(Rectangle visibleRect,
                                      int orientation,
                                      int direction)

Returns the distance to scroll to expose the next or previous row (for vertical scrolling) or column (for horizontal scrolling).

For horizontal scrolling, if the layout orientation is {@code VERTICAL}, then the list's font size is returned (or {@code 1} if the font is {@code null}).

Parameters:: visibleRect - the view area visible within the viewport; orientation - {@code SwingConstants.HORIZONTAL} or {@code SwingConstants.VERTICAL}; direction - less or equal to zero to scroll up/back, greater than zero for down/forward
Returns:: the "unit" increment for scrolling in the specified direction; always positive

getSelectedIndex

public int getSelectedIndex()

Returns the smallest selected cell index; the selection when only a single item is selected in the list. When multiple items are selected, it is simply the smallest selected index. Returns {@code -1} if there is no selection.

This method is a cover that delegates to {@code getMinSelectionIndex}.

Returns:: the smallest selected cell index

getSelectedIndices

public int[] getSelectedIndices()

Returns an array of all of the selected indices, in increasing order.

Returns:: all of the selected indices, in increasing order, or an empty array if nothing is selected

getSelectedValue

public Object getSelectedValue()

Returns the value for the smallest selected cell index; the selected value when only a single item is selected in the list. When multiple items are selected, it is simply the value for the smallest selected index. Returns {@code null} if there is no selection.

This is a convenience method that simply returns the model value for {@code getMinSelectionIndex}.

Returns:: the first selected value

getSelectedValues

public Object[] getSelectedValues()

Returns an array of all the selected values, in increasing order based on their indices in the list.

Returns:: the selected values, or an empty array if nothing is selected

getSelectionBackground

public Color getSelectionBackground()

Returns the color used to draw the background of selected items. {@code DefaultListCellRenderer} uses this color to draw the background of items in the selected state, as do the renderers installed by most {@code ListUI} implementations.

Returns:: the color to draw the background of selected items

getSelectionForeground

public Color getSelectionForeground()

Returns the color used to draw the foreground of selected items. {@code DefaultListCellRenderer} uses this color to draw the foreground of items in the selected state, as do the renderers installed by most {@code ListUI} implementations.

Returns:: the color to draw the foreground of selected items

getSelectionMode

public int getSelectionMode()

Returns the current selection mode for the list. This is a cover method that delegates to the method of the same name on the list's selection model.

Returns:: the current selection mode

getSelectionModel

public ListSelectionModel getSelectionModel()

Returns the current selection model. The selection model maintains the selection state of the list. See the class level documentation for more details.

Returns:: the ListSelectionModel that maintains the list's selections

getToolTipText

public String getToolTipText(MouseEvent event)

Returns the tooltip text to be used for the given event. This overrides {@code JComponent}'s {@code getToolTipText} to first check the cell renderer component for the cell over which the event occurred, returning its tooltip text, if any. This implementation allows you to specify tooltip text on the cell level, by using {@code setToolTipText} on your cell renderer component.

Note: For JList to properly display the tooltips of its renderers in this manner, JList must be a registered component with the ToolTipManager. This registration is done automatically in the constructor. However, if at a later point JList is unregistered, by way of a call to {@code setToolTipText(null)}, tips from the renderers will no longer display.

Overrides:: getToolTipText in class JComponent
Parameters:: event - the {@code MouseEvent} to fetch the tooltip text for

getUI

public ListUI getUI()

Returns the {@code ListUI}, the look and feel object that renders this component.

Returns:: the ListUI object that renders this component

getUIClassID

public String getUIClassID()

Returns {@code "ListUI"}, the UIDefaults key used to look up the name of the {@code javax.swing.plaf.ListUI} class that defines the look and feel for this component.

Overrides:: getUIClassID in class JComponent
Returns:: the string "ListUI"

getValueIsAdjusting

public boolean getValueIsAdjusting()

Returns the value of the selection model's {@code isAdjusting} property.

This is a cover method that delegates to the method of the same name on the list's selection model.

Returns:: the value of the selection model's {@code isAdjusting} property.

getVisibleRowCount

public int getVisibleRowCount()

Returns the value of the {@code visibleRowCount} property. See the documentation for {@link #setVisibleRowCount} for details on how to interpret this value.

Returns:: the value of the {@code visibleRowCount} property.

indexToLocation

public Point indexToLocation(int index)

Returns the origin of the specified item in the list's coordinate system. This method returns {@code null} if the index isn't valid.

This is a cover method that delegates to the method of the same name in the list's {@code ListUI}. It returns {@code null} if the list has no {@code ListUI}.

Parameters:: index - the cell index
Returns:: the origin of the cell, or {@code null}

isSelectedIndex

public boolean isSelectedIndex(int index)

Returns {@code true} if the specified index is selected, else {@code false}. This is a cover method that delegates to the method of the same name on the list's selection model.

Parameters:: index - index to be queried for selection state
Returns:: {@code true} if the specified index is selected, else {@code false}

isSelectionEmpty

public boolean isSelectionEmpty()

Returns {@code true} if nothing is selected, else {@code false}. This is a cover method that delegates to the method of the same name on the list's selection model.

Returns:: {@code true} if nothing is selected, else {@code false}

locationToIndex

public int locationToIndex(Point location)

Returns the cell index closest to the given location in the list's coordinate system. To determine if the cell actually contains the specified location, compare the point against the cell's bounds, as provided by {@code getCellBounds}. This method returns {@code -1} if the model is empty

This is a cover method that delegates to the method of the same name in the list's {@code ListUI}. It returns {@code -1} if the list has no {@code ListUI}.

Parameters:: location - the coordinates of the point
Returns:: the cell index closest to the given location, or {@code -1}

paramString

protected String paramString()

Returns a {@code String} representation of this {@code JList}. This method is intended to be used only for debugging purposes, and the content and format of the returned {@code String} may vary between implementations. The returned {@code String} may be empty, but may not be {@code null}.

Overrides:: paramString in class JComponent
Returns:: a {@code String} representation of this {@code JList}.

removeListSelectionListener

public void removeListSelectionListener(ListSelectionListener listener)

Removes a selection listener from the list.

Parameters:: listener - the {@code ListSelectionListener} to remove

removeSelectionInterval

public void removeSelectionInterval(int index0,
                                    int index1)

Sets the selection to be the set difference of the specified interval and the current selection. Both the {@code index0} and {@code index1} indices are removed. {@code index0} doesn't have to be less than or equal to {@code index1}. This is a cover method that delegates to the method of the same name on the list's selection model.

Refer to the documentation of the selection model class being used for details on how values less than {@code 0} are handled.

Parameters:: index0 - the first index to remove from the selection; index1 - the last index to remove from the selection

setCellRenderer

public void setCellRenderer(ListCellRenderer cellRenderer)

Sets the delegate that is used to paint each cell in the list. The job of a cell renderer is discussed in detail in the class level documentation.

If the {@code prototypeCellValue} property is {@code non-null}, setting the cell renderer also causes the {@code fixedCellWidth} and {@code fixedCellHeight} properties to be re-calculated. Only one PropertyChangeEvent is generated however - for the cellRenderer property.

The default value of this property is provided by the {@code ListUI} delegate, i.e. by the look and feel implementation.

This is a JavaBeans bound property.

Parameters:: cellRenderer - the ListCellRenderer that paints list cells

setDragEnabled

public void setDragEnabled(boolean b)

Turns on or off automatic drag handling. In order to enable automatic drag handling, this property should be set to {@code true}, and the list's {@code TransferHandler} needs to be {@code non-null}. The default value of the {@code dragEnabled} property is {@code false}.

The job of honoring this property, and recognizing a user drag gesture, lies with the look and feel implementation, and in particular, the list's {@code ListUI}. When automatic drag handling is enabled, most look and feels (including those that subclass {@code BasicLookAndFeel}) begin a drag and drop operation whenever the user presses the mouse button over an item and then moves the mouse a few pixels. Setting this property to {@code true} can therefore have a subtle effect on how selections behave.

If a look and feel is used that ignores this property, you can still begin a drag and drop operation by calling {@code exportAsDrag} on the list's {@code TransferHandler}.

Parameters:: b - whether or not to enable automatic drag handling

setDropMode

public final void setDropMode(DropMode dropMode)

Sets the drop mode for this component. For backward compatibility, the default for this property is DropMode.USE_SELECTION. Usage of one of the other modes is recommended, however, for an improved user experience. DropMode.ON, for instance, offers similar behavior of showing items as selected, but does so without affecting the actual selection in the list.

JList supports the following drop modes:

DropMode.USE_SELECTION
DropMode.ON
DropMode.INSERT
DropMode.ON_OR_INSERT

The drop mode is only meaningful if this component has a TransferHandler that accepts drops.

Parameters:: dropMode - the drop mode to use

setFixedCellHeight

public void setFixedCellHeight(int height)

Sets a fixed value to be used for the height of every cell in the list. If {@code height} is -1, cell heights are computed in the {@code ListUI} by applying getPreferredSize to the cell renderer component for each list element.

The default value of this property is {@code -1}.

This is a JavaBeans bound property.

Parameters:: height - the height to be used for for all cells in the list

setFixedCellWidth

public void setFixedCellWidth(int width)

Sets a fixed value to be used for the width of every cell in the list. If {@code width} is -1, cell widths are computed in the {@code ListUI} by applying getPreferredSize to the cell renderer component for each list element.

The default value of this property is {@code -1}.

This is a JavaBeans bound property.

Parameters:: width - the width to be used for all cells in the list

setLayoutOrientation

public void setLayoutOrientation(int layoutOrientation)

Defines the way list cells are layed out. Consider a {@code JList} with five cells. Cells can be layed out in one of the following ways:

 VERTICAL:          0
                    1
                    2
                    3
                    4

 HORIZONTAL_WRAP:   0  1  2
                    3  4

 VERTICAL_WRAP:     0  3
                    1  4
                    2

A description of these layouts follows:

Value	Description
`VERTICAL`	Cells are layed out vertically in a single column.
`HORIZONTAL_WRAP`	Cells are layed out horizontally, wrapping to a new row as necessary. If the {@code visibleRowCount} property is less than or equal to zero, wrapping is determined by the width of the list; otherwise wrapping is done in such a way as to ensure {@code visibleRowCount} rows in the list.
`VERTICAL_WRAP`	Cells are layed out vertically, wrapping to a new column as necessary. If the {@code visibleRowCount} property is less than or equal to zero, wrapping is determined by the height of the list; otherwise wrapping is done at {@code visibleRowCount} rows.

The default value of this property is VERTICAL.

Parameters:: layoutOrientation - the new layout orientation, one of: {@code VERTICAL}, {@code HORIZONTAL_WRAP} or {@code VERTICAL_WRAP}

setListData

public void setListData(Object[] listData)

Constructs a read-only ListModel from an array of objects, and calls {@code setModel} with this model.

Attempts to pass a {@code null} value to this method results in undefined behavior and, most likely, exceptions. The created model references the given array directly. Attempts to modify the array after invoking this method results in undefined behavior.

Parameters:: listData - an array of {@code Objects} containing the items to display in the list

setListData

public void setListData(Vector listData)

Constructs a read-only ListModel from a Vector and calls {@code setModel} with this model.

Attempts to pass a {@code null} value to this method results in undefined behavior and, most likely, exceptions. The created model references the given {@code Vector} directly. Attempts to modify the {@code Vector} after invoking this method results in undefined behavior.

Parameters:: listData - a Vector containing the items to display in the list

setModel

public void setModel(ListModel model)

Sets the model that represents the contents or "value" of the list, notifies property change listeners, and then clears the list's selection.

This is a JavaBeans bound property.

Parameters:: model - the ListModel that provides the list of items for display

setPrototypeCellValue

public void setPrototypeCellValue(Object prototypeCellValue)

Sets the {@code prototypeCellValue} property, and then (if the new value is {@code non-null}), computes the {@code fixedCellWidth} and {@code fixedCellHeight} properties by requesting the cell renderer component for the given value (and index 0) from the cell renderer, and using that component's preferred size.

This method is useful when the list is too long to allow the {@code ListUI} to compute the width/height of each cell, and there is a single cell value that is known to occupy as much space as any of the others, a so-called prototype.

While all three of the {@code prototypeCellValue}, {@code fixedCellHeight}, and {@code fixedCellWidth} properties may be modified by this method, {@code PropertyChangeEvent} notifications are only sent when the {@code prototypeCellValue} property changes.

To see an example which sets this property, see the class description above.

The default value of this property is null.

This is a JavaBeans bound property.

Parameters:: prototypeCellValue - the value on which to base fixedCellWidth and fixedCellHeight

setSelectedIndex

public void setSelectedIndex(int index)

Selects a single cell. Does nothing if the given index is greater than or equal to the model size. This is a convenience method that uses {@code setSelectionInterval} on the selection model. Refer to the documentation for the selection model class being used for details on how values less than {@code 0} are handled.

Parameters:: index - the index of the cell to select

setSelectedIndices

public void setSelectedIndices(int[] indices)

Changes the selection to be the set of indices specified by the given array. Indices greater than or equal to the model size are ignored. This is a convenience method that clears the selection and then uses {@code addSelectionInterval} on the selection model to add the indices. Refer to the documentation of the selection model class being used for details on how values less than {@code 0} are handled.

Parameters:: indices - an array of the indices of the cells to select, {@code non-null}

setSelectedValue

public void setSelectedValue(Object anObject,
                             boolean shouldScroll)

Selects the specified object from the list.

Parameters:: anObject - the object to select; shouldScroll - {@code true} if the list should scroll to display the selected object, if one exists; otherwise {@code false}

setSelectionBackground

public void setSelectionBackground(Color selectionBackground)

Sets the color used to draw the background of selected items, which cell renderers can use fill selected cells. {@code DefaultListCellRenderer} uses this color to fill the background of items in the selected state, as do the renderers installed by most {@code ListUI} implementations.

The default value of this property is defined by the look and feel implementation.

This is a JavaBeans bound property.

Parameters:: selectionBackground - the {@code Color} to use for the background of selected cells

setSelectionForeground

public void setSelectionForeground(Color selectionForeground)

Sets the color used to draw the foreground of selected items, which cell renderers can use to render text and graphics. {@code DefaultListCellRenderer} uses this color to draw the foreground of items in the selected state, as do the renderers installed by most {@code ListUI} implementations.

The default value of this property is defined by the look and feel implementation.

This is a JavaBeans bound property.

Parameters:: selectionForeground - the {@code Color} to use in the foreground for selected list items

setSelectionInterval

public void setSelectionInterval(int anchor,
                                 int lead)

Selects the specified interval. Both {@code anchor} and {@code lead} indices are included. {@code anchor} doesn't have to be less than or equal to {@code lead}. This is a cover method that delegates to the method of the same name on the list's selection model.

Refer to the documentation of the selection model class being used for details on how values less than {@code 0} are handled.

Parameters:: anchor - the first index to select; lead - the last index to select

setSelectionMode

public void setSelectionMode(int selectionMode)

Sets the selection mode for the list. This is a cover method that sets the selection mode directly on the selection model.

The following list describes the accepted selection modes:

{@code ListSelectionModel.SINGLE_SELECTION} - Only one list index can be selected at a time. In this mode, {@code setSelectionInterval} and {@code addSelectionInterval} are equivalent, both replacing the current selection with the index represented by the second argument (the "lead").
{@code ListSelectionModel.SINGLE_INTERVAL_SELECTION} - Only one contiguous interval can be selected at a time. In this mode, {@code addSelectionInterval} behaves like {@code setSelectionInterval} (replacing the current selection}, unless the given interval is immediately adjacent to or overlaps the existing selection, and can be used to grow the selection.
{@code ListSelectionModel.MULTIPLE_INTERVAL_SELECTION} - In this mode, there's no restriction on what can be selected. This mode is the default.

Parameters:: selectionMode - the selection mode

setSelectionModel

public void setSelectionModel(ListSelectionModel selectionModel)

Sets the selectionModel for the list to a non-null ListSelectionModel implementation. The selection model handles the task of making single selections, selections of contiguous ranges, and non-contiguous selections.

This is a JavaBeans bound property.

Parameters:: selectionModel - the ListSelectionModel that implements the selections

setUI

public void setUI(ListUI ui)

Sets the {@code ListUI}, the look and feel object that renders this component.

Parameters:: ui - the ListUI object

setValueIsAdjusting

public void setValueIsAdjusting(boolean b)

Sets the selection model's {@code valueIsAdjusting} property. When {@code true}, upcoming changes to selection should be considered part of a single change. This property is used internally and developers typically need not call this method. For example, when the model is being updated in response to a user drag, the value of the property is set to {@code true} when the drag is initiated and set to {@code false} when the drag is finished. This allows listeners to update only when a change has been finalized, rather than handling all of the intermediate values.

You may want to use this directly if making a series of changes that should be considered part of a single change.

This is a cover method that delegates to the method of the same name on the list's selection model. See the documentation for {@link javax.swing.ListSelectionModel#setValueIsAdjusting} for more details.

Parameters:: b - the new value for the property

setVisibleRowCount

public void setVisibleRowCount(int visibleRowCount)

Sets the {@code visibleRowCount} property, which has different meanings depending on the layout orientation: For a {@code VERTICAL} layout orientation, this sets the preferred number of rows to display without requiring scrolling; for other orientations, it affects the wrapping of cells.

In {@code VERTICAL} orientation:
Setting this property affects the return value of the {@link #getPreferredScrollableViewportSize} method, which is used to calculate the preferred size of an enclosing viewport. See that method's documentation for more details.

In {@code HORIZONTAL_WRAP} and {@code VERTICAL_WRAP} orientations:
This affects how cells are wrapped. See the documentation of {@link #setLayoutOrientation} for more details.

The default value of this property is {@code 8}.

Calling this method with a negative value results in the property being set to {@code 0}.

This is a JavaBeans bound property.

Parameters:: visibleRowCount - an integer specifying the preferred number of rows to display without requiring scrolling

updateUI

public void updateUI()

Resets the {@code ListUI} property by setting it to the value provided by the current look and feel. If the current cell renderer was installed by the developer (rather than the look and feel itself), this also causes the cell renderer and its children to be updated, by calling {@code SwingUtilities.updateComponentTreeUI} on it.

Overrides:: updateUI in class JComponent

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:

The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.

javax.swingclass JList

HORIZONTAL_WRAP

VERTICAL

VERTICAL_WRAP

JList

JList

JList

JList

addListSelectionListener

addSelectionInterval

clearSelection

createSelectionModel

ensureIndexIsVisible

fireSelectionValueChanged

getAccessibleContext

getAnchorSelectionIndex

getCellBounds

getCellRenderer

getDragEnabled

getDropLocation

getDropMode

getFirstVisibleIndex

getFixedCellHeight

getFixedCellWidth

getLastVisibleIndex

getLayoutOrientation

getLeadSelectionIndex

getListSelectionListeners

getMaxSelectionIndex

getMinSelectionIndex

getModel

getNextMatch

getPreferredScrollableViewportSize

getPrototypeCellValue

getScrollableBlockIncrement

getScrollableTracksViewportHeight

getScrollableTracksViewportWidth

getScrollableUnitIncrement

getSelectedIndex

getSelectedIndices

getSelectedValue

getSelectedValues

getSelectionBackground

getSelectionForeground

getSelectionMode

getSelectionModel

getToolTipText

getUI

getUIClassID

getValueIsAdjusting

getVisibleRowCount

indexToLocation

isSelectedIndex

isSelectionEmpty

locationToIndex

paramString

removeListSelectionListener

removeSelectionInterval

setCellRenderer

setDragEnabled

setDropMode

setFixedCellHeight

setFixedCellWidth

setLayoutOrientation

setListData

setListData

setModel

setPrototypeCellValue

setSelectedIndex

setSelectedIndices

setSelectedValue

setSelectionBackground

setSelectionForeground

setSelectionInterval

setSelectionMode

setSelectionModel

setUI

setValueIsAdjusting

setVisibleRowCount

updateUI

javax.swing
class JList