public class javax.swing.plaf.basic
BasicListUI


Show All Login
Java SE 6
  
Extends: ComponentUI > ListUI
Inner classes: BasicListUI.MouseInputHandler, BasicListUI.FocusHandler, BasicListUI.ListSelectionHandler, BasicListUI.ListDataHandler, BasicListUI.PropertyChangeHandler
Details
An extensible implementation of ListUI.

BasicListUI instances cannot be shared between multiple lists.
version1.121 07/11/06


Fields
protected JList list
protected CellRendererPane rendererPane
protected FocusListener focusListener
protected MouseInputListener mouseInputListener
protected ListSelectionListener listSelectionListener
protected ListDataListener listDataListener
protected PropertyChangeListener propertyChangeListener
protected int[] cellHeights
protected int cellHeight
protected int cellWidth
protected int updateLayoutStateNeeded
final protected static int modelChanged
final protected static int selectionModelChanged
final protected static int fontChanged
final protected static int fixedCellWidthChanged
final protected static int fixedCellHeightChanged
final protected static int prototypeCellValueChanged
final protected static int cellRendererChanged

Constructors
public BasicListUI()

Methods
protected int convertRowToY(int row) Details
Return the JList relative Y coordinate of the origin of the specified row or -1 if row isn't valid.
returnThe Y coordinate of the origin of row, or -1.
See also getRowHeight, updateLayoutState
protected int convertYToRow(int y0) Details
Convert the JList relative coordinate to the row that contains it, based on the current layout. If y0 doesn't fall within any row, return -1.
returnThe row that contains y0, or -1.
See also getRowHeight, updateLayoutState
protected FocusListener createFocusListener()
protected ListDataListener createListDataListener() Details
Creates an instance of ListDataListener that's added to the JLists by model as needed. Subclasses can override this method to return a custom ListDataListener, e.g.
 class MyListUI extends BasicListUI {
    protected ListDataListener createListDataListener() {
        return new MyListDataListener();
    }
    public class MyListDataListener extends ListDataHandler {
        public void contentsChanged(ListDataEvent e) {
            // do some extra work when the models contents change
            super.contentsChange(e);
        }
    }
 }
 
See also javax.swing.event.ListDataListener, getModel, installUI
protected ListSelectionListener createListSelectionListener() Details
Creates an instance of ListSelectionHandler that's added to the JLists by selectionModel as needed. Subclasses can override this method to return a custom ListSelectionListener, e.g.
 class MyListUI extends BasicListUI {
    protected ListSelectionListener createListSelectionListener() {
        return new MySelectionListener();
    }
    public class MySelectionListener extends ListSelectionHandler {
        public void valueChanged(ListSelectionEvent e) {
            // do some extra work when the selection changes
            super.valueChange(e);
        }
    }
 }
 
See also javax.swing.plaf.basic.BasicListUI.ListSelectionHandler, installUI
protected MouseInputListener createMouseInputListener() Details
Creates a delegate that implements MouseInputListener. The delegate is added to the corresponding java.awt.Component listener lists at installUI() time. Subclasses can override this method to return a custom MouseInputListener, e.g.
 class MyListUI extends BasicListUI {
    protected MouseInputListener createMouseInputListener() {
        return new MyMouseInputHandler();
    }
    public class MyMouseInputHandler extends MouseInputHandler {
        public void mouseMoved(MouseEvent e) {
            // do some extra work when the mouse moves
            super.mouseMoved(e);
        }
    }
 }
 
See also javax.swing.plaf.basic.BasicListUI.MouseInputHandler, installUI
protected PropertyChangeListener createPropertyChangeListener() Details
Creates an instance of PropertyChangeHandler that's added to the JList by installUI(). Subclasses can override this method to return a custom PropertyChangeListener, e.g.
 class MyListUI extends BasicListUI {
    protected PropertyChangeListener createPropertyChangeListener() {
        return new MyPropertyChangeListener();
    }
    public class MyPropertyChangeListener extends PropertyChangeHandler {
        public void propertyChange(PropertyChangeEvent e) {
            if (e.getPropertyName().equals("model")) {
                // do some extra work when the model changes
            }
            super.propertyChange(e);
        }
    }
 }
 
See also java.beans.PropertyChangeListener, installUI
public static ComponentUI createUI(JComponent list) Details
Returns a new instance of BasicListUI. BasicListUI delegates are allocated one per JList.
returnA new ListUI implementation for the Windows look and feel.
public Point indexToLocation(JList list, int index)
Returns the origin in the given JList, of the specified item, in the list's coordinate system. Returns null if the index isn't valid.
protected void installDefaults() Details
Initialize JList properties, e.g. font, foreground, and background, and add the CellRendererPane. The font, foreground, and background properties are only set if their current value is either null or a UIResource, other properties are set if the current value is null.
See also uninstallDefaults, installUI, javax.swing.CellRendererPane
protected void installKeyboardActions() Details
Registers the keyboard bindings on the JList that the BasicListUI is associated with. This method is called at installUI() time.
See also installUI
protected void installListeners() Details
Create and install the listeners for the JList, its model, and its selectionModel. This method is called at installUI() time.
See also installUI, uninstallListeners
public void installUI(JComponent c) Details
Initializes this.list by calling installDefaults(), installListeners(), and installKeyboardActions() in order.
See also installDefaults, installListeners, installKeyboardActions
public int locationToIndex(JList list, Point location) Details
Returns the cell index in the specified JList 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 getCellBounds. This method returns -1 if the list's model is empty.
ThrowsNullPointerException: if location is null
protected void maybeUpdateLayoutState() Details
If updateLayoutStateNeeded is non zero, call updateLayoutState() and reset updateLayoutStateNeeded. This method should be called by methods before doing any computation based on the geometry of the list. For example it's the first call in paint() and getPreferredSize().
See also updateLayoutState
public void paint(Graphics g, JComponent c) Details
Paint the rows that intersect the Graphics objects clipRect. This method calls paintCell as necessary. Subclasses may want to override these methods.
See also paintCell
protected void paintCell(Graphics g, int row, Rectangle rowBounds, ListCellRenderer cellRenderer, ListModel dataModel, ListSelectionModel selModel, int leadIndex) Details
Paint one List cell: compute the relevant state, get the "rubber stamp" cell renderer component, and then use the CellRendererPane to paint it. Subclasses may want to override this method rather than paint().
See also paint
protected void selectNextIndex() Details
Selected the previous row and force it to be visible.
See also ensureIndexIsVisible
protected void selectPreviousIndex() Details
Selected the previous row and force it to be visible.
See also ensureIndexIsVisible
protected void uninstallDefaults() Details
Set the JList properties that haven't been explicitly overridden to null. A property is considered overridden if its current value is not a UIResource.
See also installDefaults, uninstallUI, javax.swing.CellRendererPane
protected void uninstallKeyboardActions() Details
Unregisters keyboard actions installed from installKeyboardActions. This method is called at uninstallUI() time - subclassess should ensure that all of the keyboard actions registered at installUI time are removed here.
See also installUI
protected void uninstallListeners() Details
Remove the listeners for the JList, its model, and its selectionModel. All of the listener fields, are reset to null here. This method is called at uninstallUI() time, it should be kept in sync with installListeners.
See also uninstallUI, installListeners
public void uninstallUI(JComponent c) Details
Uninitializes this.list by calling uninstallListeners(), uninstallKeyboardActions(), and uninstallDefaults() in order. Sets this.list to null.
See also uninstallListeners, uninstallKeyboardActions, uninstallDefaults
protected void updateLayoutState() Details
Recompute the value of cellHeight or cellHeights based and cellWidth, based on the current font and the current values of fixedCellWidth, fixedCellHeight, and prototypeCellValue.
See also maybeUpdateLayoutState

Properties
public int getBaseline(JComponent c, int width, int height) Details
Returns the baseline.
ThrowsNullPointerException: if c is null
ThrowsIllegalArgumentException: if width or height is < 0
since1.6
See also getBaseline(int, int)
public Component.BaselineResizeBehavior getBaselineResizeBehavior(JComponent c) Details
Returns an enum indicating how the baseline of the component changes as the size changes.
ThrowsNullPointerException: if c is null
since1.6
See also getBaseline(int, int)
public Rectangle getCellBounds(JList list, int index1, int index2)
Returns the bounding rectangle, in the given list's coordinate system, for the range of cells specified by the two indices. The indices can be supplied in any order.

If the smaller index is outside the list's range of cells, this method returns 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.

public Dimension getPreferredSize(JComponent c) Details
The preferredSize of the list depends upon the layout orientation.
Layout OrientationPreferred Size
JList.VERTICAL The preferredSize of the list is total height of the rows and the maximum width of the cells. If JList.fixedCellHeight is specified then the total height of the rows is just (cellVerticalMargins + fixedCellHeight) * model.getSize() where rowVerticalMargins is the space we allocate for drawing the yellow focus outline. Similarly if fixedCellWidth is specified then we just use that.
JList.VERTICAL_WRAP If the visible row count is greater than zero, the preferredHeight is the maximum cell height * visibleRowCount. If the visible row count is <= 0, the preferred height is either the current height of the list, or the maximum cell height, whichever is bigger. The preferred width is than the maximum cell width * number of columns needed. Where the number of columns needs is list.height / max cell height. Max cell height is either the fixed cell height, or is determined by iterating through all the cells to find the maximum height from the ListCellRenderer.
JList.HORIZONTAL_WRAP If the visible row count is greater than zero, the preferredHeight is the maximum cell height * adjustedRowCount. Where visibleRowCount is used to determine the number of columns. Because this lays out horizontally the number of rows is then determined from the column count. For example, lets say you have a model with 10 items and the visible row count is 8. The number of columns needed to display this is 2, but you no longer need 8 rows to display this, you only need 5, thus the adjustedRowCount is 5.

If the visible row count is <= 0, the preferred height is dictated by the number of columns, which will be as many as can fit in the width of the JList (width / max cell width), with at least one column. The preferred height then becomes the model size / number of columns * maximum cell height. Max cell height is either the fixed cell height, or is determined by iterating through all the cells to find the maximum height from the ListCellRenderer.

The above specifies the raw preferred width and height. The resulting preferred width is the above width + insets.left + insets.right and the resulting preferred height is the above height + insets.top + insets.bottom. Where the Insets are determined from list.getInsets().
cThe JList component.
returnThe total size of the list.
protected int getRowHeight(int row) Details
Returns the height of the specified row based on the current layout.
returnThe specified row height or -1 if row isn't valid.
See also convertYToRow, convertRowToY, updateLayoutState