Methods
Modifier and Type
Method and Description
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, isSelectionEmpty
will return true
.
protected ListSelectionModel
createSelectionModel()
Returns an instance of DefaultListSelectionModel
; 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 ListSelectionListener
s added directly to the list
of selection changes made to the selection model.
AccessibleContext
getAccessibleContext()
Gets the AccessibleContext
associated with this JList
.
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<? super E>
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 null
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 fixedCellHeight
property.
int
getFixedCellWidth()
Returns the value of the fixedCellWidth
property.
int
getLastVisibleIndex()
Returns the largest list index that is currently visible.
int
getLayoutOrientation()
Returns the layout orientation property for the list: VERTICAL
if the layout is a single column of cells, VERTICAL_WRAP
if the
layout is “newspaper style” with the content flowing vertically then
horizontally, or HORIZONTAL_WRAP
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 ListSelectionListener
s added
to this JList
by way of addListSelectionListener
.
int
getMaxSelectionIndex()
Returns the largest selected cell index, or -1
if the selection
is empty.
int
getMinSelectionIndex()
Returns the smallest selected cell index, or -1
if the selection
is empty.
ListModel<E>
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 toString
value
starts with the given prefix.
Dimension
getPreferredScrollableViewportSize()
Computes the size of viewport needed to display visibleRowCount
rows.
E
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 true
if this JList
is displayed in a
JViewport
and the viewport is taller than the list’s
preferred height, or if the layout orientation is VERTICAL_WRAP
and visibleRowCount <= 0
; otherwise returns false
.
boolean
getScrollableTracksViewportWidth()
Returns true
if this JList
is displayed in a
JViewport
and the viewport is wider than the list’s
preferred width, or if the layout orientation is HORIZONTAL_WRAP
and visibleRowCount <= 0
; otherwise returns false
.
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.
E
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()
Deprecated.
As of JDK 1.7, replaced by getSelectedValuesList()
List<E>
getSelectedValuesList()
Returns a list of all the selected items, 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 ListUI
, the look and feel object that
renders this component.
String
getUIClassID()
Returns "ListUI"
, the UIDefaults
key used to look
up the name of the javax.swing.plaf.ListUI
class that defines
the look and feel for this component.
boolean
getValueIsAdjusting()
Returns the value of the selection model’s isAdjusting
property.
int
getVisibleRowCount()
Returns the value of the visibleRowCount
property.
Point
indexToLocation(int index)
Returns the origin of the specified item in the list’s coordinate
system.
boolean
isSelectedIndex(int index)
Returns true
if the specified index is selected,
else false
.
boolean
isSelectionEmpty()
Returns true
if nothing is selected, else false
.
int
locationToIndex(Point location)
Returns the cell index closest to the given location in the list’s
coordinate system.
protected String
paramString()
Returns a String
representation of this JList
.
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<? super E> 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(E[] listData)
Constructs a read-only ListModel
from an array of items,
and calls setModel
with this model.
void
setListData(Vector<? extends E> listData)
Constructs a read-only ListModel
from a Vector
and calls setModel
with this model.
void
setModel(ListModel<E> 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(E prototypeCellValue)
Sets the prototypeCellValue
property, and then (if the new value
is non-null
), computes the fixedCellWidth
and
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.
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 ListUI
, the look and feel object that
renders this component.
void
setValueIsAdjusting(boolean b)
Sets the selection model’s valueIsAdjusting
property.
void
setVisibleRowCount(int visibleRowCount)
Sets the visibleRowCount
property, which has different meanings
depending on the layout orientation: For a VERTICAL
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 ListUI
property by setting it to the value provided
by the current look and feel.