JavaTM 2 Platform
Standard Ed. 5.0

javax.swing.plaf
Class ListUI

java.lang.Object
  extended by javax.swing.plaf.ComponentUI
      extended by javax.swing.plaf.ListUI
Direct Known Subclasses:
BasicListUI, MultiListUI

public abstract class ListUI
extends ComponentUI

The JList pluggable look and feel delegate. This interface adds methods that allow the JList component to map locations, e.g. mouse coordinates, to list cells and from cell indices to the bounds of the cell.


Constructor Summary
ListUI()
           
 
Method Summary
abstract  Rectangle getCellBounds(JList list, int index1, int index2)
          Returns the bounds of the specified item in JList coordinates, null if index isn't valid.
abstract  Point indexToLocation(JList list, int index)
          Returns the origin of the specified item in JList coordinates, null if index isn't valid.
abstract  int locationToIndex(JList list, Point location)
          Convert a point in JList coordinates to the closest index of the cell at that location.
 
Methods inherited from class javax.swing.plaf.ComponentUI
contains, createUI, getAccessibleChild, getAccessibleChildrenCount, getMaximumSize, getMinimumSize, getPreferredSize, installUI, paint, uninstallUI, update
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ListUI

public ListUI()
Method Detail

locationToIndex

public abstract int locationToIndex(JList list,
                                    Point location)
Convert a point in JList coordinates to the closest index of the cell at that location. To determine if the cell actually contains the specified location use a combination of this method and getCellBounds. Returns -1 if the model is empty.

Parameters:
location - The JList relative coordinates of the cell
Returns:
The index of the cell at location, or -1.

indexToLocation

public abstract Point indexToLocation(JList list,
                                      int index)
Returns the origin of the specified item in JList coordinates, null if index isn't valid.

Parameters:
index - The index of the JList cell.
Returns:
The origin of the index'th cell.

getCellBounds

public abstract Rectangle getCellBounds(JList list,
                                        int index1,
                                        int index2)
Returns the bounds of the specified item in JList coordinates, null if index isn't valid.

Parameters:
index - The index of the JList cell.
Returns:
The bounds of the index'th cell.

JavaTM 2 Platform
Standard Ed. 5.0

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.