Source for javax.swing.plaf.ListUI

   1: /* ListUI.java --
   2:    Copyright (C) 2002, 2003, 2004, 2005  Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.swing.plaf;
  40: 
  41: import java.awt.Point;
  42: import java.awt.Rectangle;
  43: 
  44: import javax.swing.JList;
  45: 
  46: /**
  47:  * An abstract base class for delegates that implement the pluggable
  48:  * look and feel for a <code>JList</code>.
  49:  *
  50:  * @author Sascha Brawer (brawer@dandelis.ch)
  51:  */
  52: public abstract class ListUI extends ComponentUI
  53: {
  54:   /**
  55:    * Constructs a new <code>ListUI</code>.
  56:    */
  57:   public ListUI()
  58:   {
  59:     // Nothing to do here.
  60:   }
  61: 
  62: 
  63:   /**
  64:    * Determines the cell index which is the closest to the specified
  65:    * location. The find out whether the returned cell actually
  66:    * contains the location, the caller should also use {@link
  67:    * #getCellBounds}.
  68:    *
  69:    * @param list the <code>JList</code> for which this delegate object
  70:    *        provides the pluggable user interface.
  71:    *
  72:    * @param location a point in the <code>JList</code> coordinate
  73:    *        system.
  74:    *
  75:    * @return the index of the closest cell, or -1 if the list model
  76:    *         is empty.
  77:    */
  78:   public abstract int locationToIndex(JList list, Point location);
  79: 
  80: 
  81:   /**
  82:    * Determines the location of the specified cell.
  83:    *
  84:    * @param list the <code>JList</code> for which this delegate object
  85:    *        provides the pluggable user interface.
  86:    *
  87:    * @param index the zero-based index of the cell whose location shall be
  88:    *        determined.
  89:    *
  90:    * @return the position of the top left corner of the cell in the
  91:    *         <code>JList</code> coordinate system, or <code>null</code>
  92:    *         if <code>cell</code> does not designate a valid cell.
  93:    */
  94:   public abstract Point indexToLocation(JList list, int index);
  95: 
  96: 
  97:   /**
  98:    * Determines the bounding box of the rectangle spanned by
  99:    * two list indices.
 100:    *
 101:    * @param list the <code>JList</code> for which this delegate object
 102:    *        provides the pluggable user interface.
 103:    *
 104:    * @param index1 the zero-based index of the first cell.
 105:    *
 106:    * @param index2 the zero-based index of the second cell.
 107:    *
 108:    * @return the spanned rectangle, or <code>null</code> if either
 109:    *         <code>index1</code> or <code>index2</code> does not
 110:    *         designate a valid cell.
 111:    */
 112:   public abstract Rectangle getCellBounds(JList list,
 113:                                           int index1, int index2);
 114: }