libjava/javax/swing/plaf/TabbedPaneUI.java

   1 /* TabbedPaneUI.java --
   2    Copyright (C) 2002, 2003, 2004  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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 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.Rectangle;
  42
  43 import javax.swing.JTabbedPane;
  44
  45 /**
  46  * An abstract base class for delegates that implement the pluggable
  47  * look and feel for a <code>JTabbedPane</code>.
  48  *
  49  * @see javax.swing.JTabbedPane
  50  *
  51  * @author Andrew Selkirk (aselkirk@sympatico.ca)
  52  * @author Sascha Brawer (brawer@dandelis.ch)
  53  */
  54 public abstract class TabbedPaneUI
  55   extends ComponentUI
  56 {
  57   /**
  58    * Constructs a new <code>TabbedPaneUI</code>.
  59    */
  60   public TabbedPaneUI()
  61   {
  62   }
  63
  64
  65   /**
  66    * Determines which tab lies at a given position.
  67    *
  68    * @param pane the <code>JTabbedPane</code> for which this
  69    *        delegate object provides the user interface.
  70    *
  71    * @param x the horizontal position, where zero is the left
  72    *        edge of <code>pane</code>.
  73    *
  74    * @param y the vertical position, where zero is the top
  75    *        edge of <code>pane</code>.
  76    *
  77    * @return the zero-based index of the tab, or -1 if no
  78    *         tab is at the specified position.
  79    */
  80   public abstract int tabForCoordinate(JTabbedPane pane,
  81                                        int x, int y);
  82
  83
  84   /**
  85    * Calculates the bounding box of a tab.
  86    *
  87    * @param pane the <code>JTabbedPane</code> for which this
  88    *        delegate object provides the user interface.
  89    *
  90    * @param index the index of the tab, which must be an integer
  91    *        in the range <code>[0 .. pane.getTabCount() - 1]</code>.
  92    *
  93    * @return the bounding box of the <code>index</code>-th tab,
  94    *         in the coordinate system of <code>pane</code>.
  95    */
  96   public abstract Rectangle getTabBounds(JTabbedPane pane, int index);
  97
  98
  99   /**
 100    * Determines how many runs are used to display tabs.
 101    *
 102    * @param pane the <code>JTabbedPane</code> for which this
 103    *        delegate object provides the user interface.
 104    *
 105    * @return the number of tab runs.
 106    *
 107    * @see javax.swing.JTabbedPane#getTabRunCount()
 108    */
 109   public abstract int getTabRunCount(JTabbedPane pane);
 110 }
 111