BasicListUI JDK 1.6)

Methods

public boolean contains (JComponent c, int x, int y) [Inherited From ComponentUI]

Returns true if the specified x,y location is contained within the look and feel's defined shape of the specified component.

Returns true if the specified x,y location is
contained within the look and feel's defined shape of the specified
component. x and y are defined to be relative
to the coordinate system of the specified component. Although
a component's bounds is constrained to a rectangle,
this method provides the means for defining a non-rectangular
shape within those bounds for the purpose of hit detection.
Parameters:
- c - the component where the x,y location is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
- x - the x coordinate of the point
- y - the y coordinate of the point
See Also: JComponent.contains(int, int), Component.contains(int, int),

protected int convertRowToY (int row)

Return the JList relative Y coordinate of the origin of the specified row or -1 if row isn't valid.

protected int convertYToRow (int y0)

Convert the JList relative coordinate to the row that contains it, based on the current layout.

protected FocusListener createFocusListener ()

protected ListDataListener createListDataListener ()

Creates an instance of ListDataListener that's added to the JLists by model as needed.

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: ListDataListener, JList.getModel(), BasicListUI.installUI(javax.swing.JComponent),

protected ListSelectionListener createListSelectionListener ()

Creates an instance of ListSelectionHandler that's added to the JLists by selectionModel as needed.

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: BasicListUI.ListSelectionHandler, BasicListUI.installUI(javax.swing.JComponent),

protected MouseInputListener createMouseInputListener ()

Creates a delegate that implements MouseInputListener.

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: BasicListUI.MouseInputHandler, BasicListUI.installUI(javax.swing.JComponent),

protected PropertyChangeListener createPropertyChangeListener ()

Creates an instance of PropertyChangeHandler that's added to the JList by installUI().

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: PropertyChangeListener, BasicListUI.installUI(javax.swing.JComponent),

publicstatic ComponentUI createUI (JComponent list) [Overrides ComponentUI]

Returns a new instance of BasicListUI.

public Accessible getAccessibleChild (JComponent c, int i) [Inherited From ComponentUI]

Returns the ith Accessible child of the object.

Returns the ith Accessible child of the object. UIs might need to override this if they present areas on the screen that can be viewed as components, but actual components are not used for presenting those areas.

Note: As of v1.3, it is recommended that developers call Component.AccessibleAWTComponent.getAccessibleChild() instead of this method.
Returns: the ith Accessible child of the object
Parameters:
- i - zero-based index of child
See Also: ComponentUI.getAccessibleChildrenCount(javax.swing.JComponent),

public int getAccessibleChildrenCount (JComponent c) [Inherited From ComponentUI]

Returns the number of accessible children in the object.

Returns the number of accessible children in the object. If all
of the children of this object implement Accessible,
this
method should return the number of children of this object.
UIs might wish to override this if they present areas on the
screen that can be viewed as components, but actual components
are not used for presenting those areas.

Note: As of v1.3, it is recommended that developers call
Component.AccessibleAWTComponent.getAccessibleChildrenCount() instead
of this method.
Returns: the number of accessible children in the object
See Also: ComponentUI.getAccessibleChild(javax.swing.JComponent, int),

public int getBaseline (JComponent c, int width, int height) [Overrides ComponentUI]

Returns the baseline.

public BaselineResizeBehavior getBaselineResizeBehavior (JComponent c) [Overrides ComponentUI]

Returns an enum indicating how the baseline of the component changes as the size changes.

public Rectangle getCellBounds (JList list, int index1, int index2) [Specified in ListUI]

Returns the bounding rectangle, in the given list's coordinate system, for the range of cells specified by the two indices.

pack-private InputMap getInputMap (int condition)

public Dimension getMaximumSize (JComponent c) [Inherited From ComponentUI]

Returns the specified component's maximum size appropriate for the look and feel.

Returns the specified component's maximum size appropriate for
the look and feel. If null is returned, the maximum
size will be calculated by the component's layout manager instead
(this is the preferred approach for any component with a specific
layout manager installed). The default implementation of this
method invokes getPreferredSize and returns that value.
Returns: a Dimension object or null
Parameters:
- c - the component whose maximum size is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
See Also: JComponent.getMaximumSize(), LayoutManager2.maximumLayoutSize(java.awt.Container),

public Dimension getMinimumSize (JComponent c) [Inherited From ComponentUI]

Returns the specified component's minimum size appropriate for the look and feel.

Returns the specified component's minimum size appropriate for
the look and feel. If null is returned, the minimum
size will be calculated by the component's layout manager instead
(this is the preferred approach for any component with a specific
layout manager installed). The default implementation of this
method invokes getPreferredSize and returns that value.
Returns: a Dimension object or null
Parameters:
- c - the component whose minimum size is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
See Also: JComponent.getMinimumSize(), LayoutManager.minimumLayoutSize(java.awt.Container), ComponentUI.getPreferredSize(javax.swing.JComponent),

public Dimension getPreferredSize (JComponent c) [Overrides ComponentUI]

The preferredSize of the list depends upon the layout orientation.

Layout Orientation	Preferred 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().
Returns: The total size of the list.
Parameters:
- c - The JList component.

protected int getRowHeight (int row)

Returns the height of the specified row based on the current layout.

public Point indexToLocation (JList list, int index) [Specified in ListUI]

Returns the origin in the given JList, of the specified item, in the list's coordinate system.

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

Initialize JList properties, e.g.

protected void installKeyboardActions ()

Registers the keyboard bindings on the JList that the BasicListUI is associated with.

Registers the keyboard bindings on the JList that the
BasicListUI is associated with. This method is called at
installUI() time.
See Also: BasicListUI.installUI(javax.swing.JComponent),

protected void installListeners ()

Create and install the listeners for the JList, its model, and its selectionModel.

public void installUI (JComponent c) [Overrides ComponentUI]

Initializes this.list by calling installDefaults(), installListeners(), and installKeyboardActions() in order.

Initializes this.list by calling installDefaults(),
installListeners(), and installKeyboardActions()
in order.
See Also: BasicListUI.installDefaults(), BasicListUI.installListeners(), BasicListUI.installKeyboardActions(),

pack-privatestatic void loadActionMap (LazyActionMap map)

public int locationToIndex (JList list, Point location) [Specified in ListUI]

Returns the cell index in the specified JList closest to the given location in the list's coordinate system.

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.
Throws:
- NullPointerException - {@inheritDoc}

protected void maybeUpdateLayoutState ()

If updateLayoutStateNeeded is non zero, call updateLayoutState() and reset updateLayoutStateNeeded.

public void paint (Graphics g, JComponent c) [Overrides ComponentUI]

Paint the rows that intersect the Graphics objects clipRect.

protected void paintCell (Graphics g, int row, Rectangle rowBounds, ListCellRenderer cellRenderer, ListModel dataModel, ListSelectionModel selModel, int leadIndex)

Paint one List cell: compute the relevant state, get the "rubber stamp" cell renderer component, and then use the CellRendererPane to paint it.

protected void selectNextIndex ()

Selected the previous row and force it to be visible.

protected void selectPreviousIndex ()

Selected the previous row and force it to be visible.

protected void uninstallDefaults ()

Set the JList properties that haven't been explicitly overridden to null.

protected void uninstallKeyboardActions ()

Unregisters keyboard actions installed from installKeyboardActions.

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: BasicListUI.installUI(javax.swing.JComponent),

protected void uninstallListeners ()

Remove the listeners for the JList, its model, and its selectionModel.

public void uninstallUI (JComponent c) [Overrides ComponentUI]

Uninitializes this.list by calling uninstallListeners(), uninstallKeyboardActions(), and uninstallDefaults() in order.

Uninitializes this.list by calling uninstallListeners(),
uninstallKeyboardActions(), and uninstallDefaults()
in order. Sets this.list to null.
See Also: BasicListUI.uninstallListeners(), BasicListUI.uninstallKeyboardActions(), BasicListUI.uninstallDefaults(),

public void update (Graphics g, JComponent c) [Inherited From ComponentUI]

Notifies this UI delegate that it's time to paint the specified component.

Notifies this UI delegate that it's time to paint the specified
component. This method is invoked by JComponent
when the specified component is being painted.
By default this method will fill the specified component with
its background color (if its opaque property is
true) and then immediately call paint.
In general this method need not be overridden by subclasses;
all look-and-feel rendering code should reside in the paint
method.
Parameters:
- g - the Graphics context in which to paint
- c - the component being painted; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
See Also: ComponentUI.paint(java.awt.Graphics, javax.swing.JComponent), JComponent.paintComponent(java.awt.Graphics),

protected void updateLayoutState ()

Recompute the value of cellHeight or cellHeights based and cellWidth, based on the current font and the current values of fixedCellWidth, fixedCellHeight, and prototypeCellValue.