Class BasicListUI

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.

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.

protected static final int cellRendererChanged

A constant to indicate that the cellRenderer has changed.

Field Value:

64

protected int cellWidth

The width of a single cell in the list.

protected static final int fixedCellHeightChanged

A constant to indicate that the fixedCellHeight has changed.

Field Value:

16

protected static final int fixedCellWidthChanged

A constant to indicate that the fixedCellWidth has changed.

Field Value:

8

protected FocusListener focusListener

The current focus listener.

protected static final int fontChanged

A constant to indicate that the font has changed.

Field Value:

4

protected JList list

Saved reference to the list this UI was created for.

protected ListDataListener listDataListener

The data listener listening to the model.

protected ListSelectionListener listSelectionListener

The selection listener listening to the selection model.

protected static final int modelChanged

A constant to indicate that the model has changed.

Field Value:

1

protected MouseInputListener mouseInputListener

The mouse listener listening to the list.

protected PropertyChangeListener propertyChangeListener

The property change listener listening to the list.

protected static final int prototypeCellValueChanged

A constant to indicate that the prototypeCellValue has changed.

Field Value:

32

protected CellRendererPane rendererPane

The CellRendererPane that is used for painting.

protected static final int selectionModelChanged

A constant to indicate that the selection model has changed.

Field Value:

2

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

public BasicListUI()

Creates a new BasicListUI object.

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

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

protected FocusListener createFocusListener()

Creates and returns the focus listener for this UI.

Returns:

the focus listener for this UI

protected ListDataListener createListDataListener()

Creates and returns the list data listener for this UI.

Returns:

the list data listener for this UI

protected ListSelectionListener createListSelectionListener()

Creates and returns the list selection listener for this UI.

Returns:

the list selection listener for this UI

protected MouseInputListener createMouseInputListener()

Creates and returns the mouse input listener for this UI.

Returns:

the mouse input listener for this UI

protected PropertyChangeListener createPropertyChangeListener()

Creates and returns the property change listener for this UI.

Returns:

the property change listener for this UI

public static ComponentUI createUI(JComponent c)

Creates a new BasicListUI for the component.

Overrides:

createUI in interface ComponentUI

Parameters:

c - The component to create a UI for

Returns:

A new UI

public Rectangle getCellBounds(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).

Overrides:

getCellBounds in interface 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

public Dimension getPreferredSize(JComponent c)

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

Overrides:

getPreferredSize in interface ComponentUI

Parameters:

c - Ignored; uses the saved JList reference

Returns:

DOCUMENT ME!

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

public Point indexToLocation(JList l,
                             int index)

Overrides:

indexToLocation in interface ListUI

protected void installDefaults()

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

See Also:

uninstallDefaults()

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.

See Also:

uninstallListeners()

public void installUI(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 interface ComponentUI

Parameters:

c - The JList to install the UI into

public int locationToIndex(JList l,
                           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.

Overrides:

locationToIndex in interface 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

protected void maybeUpdateLayoutState()

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

public void paint(Graphics g,
                  JComponent c)

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

Overrides:

paint in interface ComponentUI

Parameters:

g - The graphics context to paint with

c - Ignored; uses the saved JList reference

protected void paintCell(Graphics g,
                         int row,
                         Rectangle bounds,
                         ListCellRenderer rend,
                         ListModel data,
                         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

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().

public void uninstallUI(JComponent c)

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

Overrides:

uninstallUI in interface ComponentUI

Parameters:

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

protected void updateLayoutState()

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