javax.swing.plaf.basic

Class BasicListUI

java.lang.Object

javax.swing.plaf.ComponentUI

javax.swing.plaf.ListUI

javax.swing.plaf.basic.BasicListUI

public class BasicListUI
extends javax.swing.plaf.ListUI

The Basic Look and Feel UI delegate for the JList.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BasicListUI.FocusHandler A helper class which listens for FocusEvents from the JList.
class	BasicListUI.ListDataHandler A helper class which listens for ListDataEvents generated by the JList's ListModel.
class	BasicListUI.ListSelectionHandler A helper class which listens for ListSelectionEvents from the JList's ListSelectionModel.
class	BasicListUI.MouseInputHandler A helper class which listens for MouseEvents from the JList.
class	BasicListUI.PropertyChangeHandler Helper class which listens to PropertyChangeEvents from the JList.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	cellHeight The height of a single cell in the list.
protected int[]	cellHeights An array of varying heights of cells in the list, in cases where each cell might have a different height.
protected static int	cellRendererChanged A constant to indicate that the cellRenderer has changed.
protected int	cellWidth The width of a single cell in the list.
protected static int	fixedCellHeightChanged A constant to indicate that the fixedCellHeight has changed.
protected static int	fixedCellWidthChanged A constant to indicate that the fixedCellWidth has changed.
protected java.awt.event.FocusListener	focusListener The current focus listener.
protected static int	fontChanged A constant to indicate that the font has changed.
protected javax.swing.JList	list Saved reference to the list this UI was created for.
protected javax.swing.event.ListDataListener	listDataListener The data listener listening to the model.
protected javax.swing.event.ListSelectionListener	listSelectionListener The selection listener listening to the selection model.
protected static int	modelChanged A constant to indicate that the model has changed.
protected javax.swing.event.MouseInputListener	mouseInputListener The mouse listener listening to the list.
protected java.beans.PropertyChangeListener	propertyChangeListener The property change listener listening to the list.
protected static int	prototypeCellValueChanged A constant to indicate that the prototypeCellValue has changed.
protected javax.swing.CellRendererPane	rendererPane The CellRendererPane that is used for painting.
protected static int	selectionModelChanged A constant to indicate that the selection model has changed.
protected int	updateLayoutStateNeeded A bitmask that indicates which properties of the JList have changed.

Constructor Summary

Constructors

Constructor and Description
BasicListUI() Creates a new BasicListUI object.

Method Summary

Methods

Modifier and Type	Method and Description
protected int	convertRowToY(int row) Calculate the Y coordinate of the upper edge of a particular row, considering the Y coordinate 0 to occur at the top of the list.
protected int	convertYToRow(int y0) Calculate the row number containing a particular Y coordinate, considering the Y coodrinate 0 to occur at the top of the list.
protected java.awt.event.FocusListener	createFocusListener() Creates and returns the focus listener for this UI.
protected javax.swing.event.ListDataListener	createListDataListener() Creates and returns the list data listener for this UI.
protected javax.swing.event.ListSelectionListener	createListSelectionListener() Creates and returns the list selection listener for this UI.
protected javax.swing.event.MouseInputListener	createMouseInputListener() Creates and returns the mouse input listener for this UI.
protected java.beans.PropertyChangeListener	createPropertyChangeListener() Creates and returns the property change listener for this UI.
static javax.swing.plaf.ComponentUI	createUI(javax.swing.JComponent c) Creates a new BasicListUI for the component.
java.awt.Rectangle	getCellBounds(javax.swing.JList l, int index1, int index2) Calculate the bounds of a particular cell, considering the upper left corner of the list as the origin position (0,0).
java.awt.Dimension	getPreferredSize(javax.swing.JComponent c) Gets the size this list would prefer to assume.
protected int	getRowHeight(int row) Calculate the height of a particular row.
java.awt.Point	indexToLocation(javax.swing.JList l, int index) Determines the location of the specified cell.
protected void	installDefaults() Installs various default settings (mostly colors) from the UIDefaults into the JList
protected void	installKeyboardActions() Installs keyboard actions for this UI in the JList.
protected void	installListeners() Attaches all the listeners we have in the UI class to the JList, its model and its selection model.
void	installUI(javax.swing.JComponent c) Installs the various aspects of the UI in the JList.
int	locationToIndex(javax.swing.JList l, java.awt.Point location) Computes the index of a list cell given a point within the list.
protected void	maybeUpdateLayoutState() Calls updateLayoutState() if updateLayoutStateNeeded is nonzero, then resets updateLayoutStateNeeded to zero.
void	paint(java.awt.Graphics g, javax.swing.JComponent c) Paints the list by repeatedly calling paintCell(java.awt.Graphics, int, java.awt.Rectangle, javax.swing.ListCellRenderer, javax.swing.ListModel, javax.swing.ListSelectionModel, int) for each visible cell in the list.
protected void	paintCell(java.awt.Graphics g, int row, java.awt.Rectangle bounds, javax.swing.ListCellRenderer rend, javax.swing.ListModel data, javax.swing.ListSelectionModel sel, int lead) Paints a single cell in the list.
protected void	selectNextIndex() Selects the next list item and force it to be visible.
protected void	selectPreviousIndex() Selects the previous list item and force it to be visible.
protected void	uninstallDefaults() Resets to null those defaults which were installed in installDefaults()
protected void	uninstallKeyboardActions() Uninstalls keyboard actions for this UI in the JList.
protected void	uninstallListeners() Detaches all the listeners we attached in installListeners().
void	uninstallUI(javax.swing.JComponent c) Uninstalls all the aspects of the UI which were installed in installUI(javax.swing.JComponent).
protected void	updateLayoutState() Recomputes the cellHeights, cellHeight, and cellWidth properties by examining the variouis properties of the JList.

Methods inherited from class javax.swing.plaf.ComponentUI

contains, getAccessibleChild, getAccessibleChildrenCount, getMaximumSize, getMinimumSize, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

modelChanged

protected static final int modelChanged

A constant to indicate that the model has changed.

See Also:

Constant Field Values

selectionModelChanged

protected static final int selectionModelChanged

A constant to indicate that the selection model has changed.

See Also:

Constant Field Values

fontChanged

protected static final int fontChanged

A constant to indicate that the font has changed.

See Also:

Constant Field Values

fixedCellWidthChanged

protected static final int fixedCellWidthChanged

A constant to indicate that the fixedCellWidth has changed.

See Also:

Constant Field Values

fixedCellHeightChanged

protected static final int fixedCellHeightChanged

A constant to indicate that the fixedCellHeight has changed.

See Also:

Constant Field Values

prototypeCellValueChanged

protected static final int prototypeCellValueChanged

A constant to indicate that the prototypeCellValue has changed.

See Also:

Constant Field Values

cellRendererChanged

protected static final int cellRendererChanged

A constant to indicate that the cellRenderer has changed.

See Also:

Constant Field Values

focusListener

protected java.awt.event.FocusListener focusListener

The current focus listener.

listDataListener

protected javax.swing.event.ListDataListener listDataListener

The data listener listening to the model.

listSelectionListener

protected javax.swing.event.ListSelectionListener listSelectionListener

The selection listener listening to the selection model.

mouseInputListener

protected javax.swing.event.MouseInputListener mouseInputListener

The mouse listener listening to the list.

propertyChangeListener

protected java.beans.PropertyChangeListener propertyChangeListener

The property change listener listening to the list.

list

protected javax.swing.JList list

Saved reference to the list this UI was created for.

cellHeight

protected int cellHeight

The height of a single cell in the list. This field is used when the fixedCellHeight property of the list is set. Otherwise this field is set to -1 and cellHeights is used instead.

cellWidth

protected int cellWidth

The width of a single cell in the list.

cellHeights

protected int[] cellHeights

An array of varying heights of cells in the list, in cases where each cell might have a different height. This field is used when the fixedCellHeight property of the list is not set. Otherwise this field is null and cellHeight is used.

updateLayoutStateNeeded

protected int updateLayoutStateNeeded

A bitmask that indicates which properties of the JList have changed. When nonzero, indicates that the UI class is out of date with respect to the underlying list, and must recalculate the list layout before painting or performing size calculations.

See Also:

modelChanged, selectionModelChanged, fontChanged, fixedCellWidthChanged, fixedCellHeightChanged, prototypeCellValueChanged, cellRendererChanged

rendererPane

protected javax.swing.CellRendererPane rendererPane

The CellRendererPane that is used for painting.

Constructor Detail

BasicListUI

public BasicListUI()

Creates a new BasicListUI object.

Method Detail

createUI

public static javax.swing.plaf.ComponentUI createUI(javax.swing.JComponent c)

Creates a new BasicListUI for the component.

Parameters:

c - The component to create a UI for

Returns:

A new UI

getRowHeight

protected int getRowHeight(int row)

Calculate the height of a particular row. If there is a fixed cellHeight, return it; otherwise return the specific row height requested from the cellHeights array. If the requested row is invalid, return -1.

Parameters:

row - The row to get the height of

Returns:

The height, in pixels, of the specified row

getCellBounds

public java.awt.Rectangle getCellBounds(javax.swing.JList l,
                               int index1,
                               int index2)

Calculate the bounds of a particular cell, considering the upper left corner of the list as the origin position (0,0).

Specified by:

getCellBounds in class javax.swing.plaf.ListUI

Parameters:

l - Ignored; calculates over this.list

index1 - The first row to include in the bounds

index2 - The last row to incude in the bounds

Returns:

A rectangle encompassing the range of rows between index1 and index2 inclusive, or null such a rectangle couldn't be calculated for the given indexes.

convertRowToY

protected int convertRowToY(int row)

Calculate the Y coordinate of the upper edge of a particular row, considering the Y coordinate 0 to occur at the top of the list.

Parameters:

row - The row to calculate the Y coordinate of

Returns:

The Y coordinate of the specified row, or -1 if the specified row number is invalid

convertYToRow

protected int convertYToRow(int y0)

Calculate the row number containing a particular Y coordinate, considering the Y coodrinate 0 to occur at the top of the list.

Parameters:

y0 - The Y coordinate to calculate the row number for

Returns:

The row number containing the specified Y value, or -1 if the list model is empty

updateLayoutState

protected void updateLayoutState()

Recomputes the cellHeights, cellHeight, and cellWidth properties by examining the variouis properties of the JList.

maybeUpdateLayoutState

protected void maybeUpdateLayoutState()

Calls updateLayoutState() if updateLayoutStateNeeded is nonzero, then resets updateLayoutStateNeeded to zero.

installDefaults

protected void installDefaults()

Installs various default settings (mostly colors) from the UIDefaults into the JList

See Also:

uninstallDefaults()

uninstallDefaults

protected void uninstallDefaults()

Resets to null those defaults which were installed in installDefaults()

installListeners

protected void installListeners()

Attaches all the listeners we have in the UI class to the JList, its model and its selection model.

See Also:

uninstallListeners()

uninstallListeners

protected void uninstallListeners()

Detaches all the listeners we attached in installListeners().

installKeyboardActions

protected void installKeyboardActions()

Installs keyboard actions for this UI in the JList.

uninstallKeyboardActions

protected void uninstallKeyboardActions()

Uninstalls keyboard actions for this UI in the JList.

installUI

public void installUI(javax.swing.JComponent c)

Installs the various aspects of the UI in the JList. In particular, calls installDefaults(), installListeners() and installKeyboardActions(). Also saves a reference to the provided component, cast to a JList.

Overrides:

installUI in class javax.swing.plaf.ComponentUI

Parameters:

c - The JList to install the UI into

See Also:

ComponentUI.uninstallUI(javax.swing.JComponent), JComponent.setUI(javax.swing.plaf.ComponentUI), JComponent.updateUI()

uninstallUI

public void uninstallUI(javax.swing.JComponent c)

Uninstalls all the aspects of the UI which were installed in installUI(javax.swing.JComponent). When finished uninstalling, drops the saved reference to the JList.

Overrides:

uninstallUI in class javax.swing.plaf.ComponentUI

Parameters:

c - Ignored; the UI is uninstalled from the JList reference saved during the call to installUI(javax.swing.JComponent)

See Also:

ComponentUI.installUI(javax.swing.JComponent), JComponent.setUI(javax.swing.plaf.ComponentUI), JComponent.updateUI()

getPreferredSize

public java.awt.Dimension getPreferredSize(javax.swing.JComponent c)

Gets the size this list would prefer to assume. This is calculated by calling getCellBounds(javax.swing.JList, int, int) over the entire list.

Overrides:

getPreferredSize in class javax.swing.plaf.ComponentUI

Parameters:

c - Ignored; uses the saved JList reference

Returns:

DOCUMENT ME!

paintCell

protected void paintCell(java.awt.Graphics g,
             int row,
             java.awt.Rectangle bounds,
             javax.swing.ListCellRenderer rend,
             javax.swing.ListModel data,
             javax.swing.ListSelectionModel sel,
             int lead)

Paints a single cell in the list.

Parameters:

g - The graphics context to paint in

row - The row number to paint

bounds - The bounds of the cell to paint, assuming a coordinate system beginning at (0,0) in the upper left corner of the list

rend - A cell renderer to paint with

data - The data to provide to the cell renderer

sel - A selection model to provide to the cell renderer

lead - The lead selection index of the list

paint

public void paint(java.awt.Graphics g,
         javax.swing.JComponent c)

Paints the list by repeatedly calling paintCell(java.awt.Graphics, int, java.awt.Rectangle, javax.swing.ListCellRenderer, javax.swing.ListModel, javax.swing.ListSelectionModel, int) for each visible cell in the list.

Overrides:

paint in class javax.swing.plaf.ComponentUI

Parameters:

g - The graphics context to paint with

c - Ignored; uses the saved JList reference

locationToIndex

public int locationToIndex(javax.swing.JList l,
                  java.awt.Point location)

Computes the index of a list cell given a point within the list. If the location lies outside the bounds of the list, the greatest index in the list model is returned.

Specified by:

locationToIndex in class javax.swing.plaf.ListUI

Parameters:

l - the list which on which the computation is based on

location - the coordinates

Returns:

the index of the list item that is located at the given coordinates or -1 if the list model is empty

indexToLocation

public java.awt.Point indexToLocation(javax.swing.JList l,
                             int index)

Description copied from class: javax.swing.plaf.ListUI

Determines the location of the specified cell.

Specified by:

indexToLocation in class javax.swing.plaf.ListUI

Parameters:

l - the JList for which this delegate object provides the pluggable user interface.

index - the zero-based index of the cell whose location shall be determined.

Returns:

the position of the top left corner of the cell in the JList coordinate system, or null if cell does not designate a valid cell.

createFocusListener

protected java.awt.event.FocusListener createFocusListener()

Creates and returns the focus listener for this UI.

Returns:

the focus listener for this UI

createListDataListener

protected javax.swing.event.ListDataListener createListDataListener()

Creates and returns the list data listener for this UI.

Returns:

the list data listener for this UI

createListSelectionListener

protected javax.swing.event.ListSelectionListener createListSelectionListener()

Creates and returns the list selection listener for this UI.

Returns:

the list selection listener for this UI

createMouseInputListener

protected javax.swing.event.MouseInputListener createMouseInputListener()

Creates and returns the mouse input listener for this UI.

Returns:

the mouse input listener for this UI

createPropertyChangeListener

protected java.beans.PropertyChangeListener createPropertyChangeListener()

Creates and returns the property change listener for this UI.

Returns:

the property change listener for this UI

selectNextIndex

protected void selectNextIndex()

Selects the next list item and force it to be visible.

selectPreviousIndex

protected void selectPreviousIndex()

Selects the previous list item and force it to be visible.