001/* TabbedPaneUI.java --
002   Copyright (C) 2002, 2003, 2004  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package javax.swing.plaf;
040
041import java.awt.Rectangle;
042
043import javax.swing.JTabbedPane;
044
045/**
046 * An abstract base class for delegates that implement the pluggable
047 * look and feel for a <code>JTabbedPane</code>.
048 *
049 * @see javax.swing.JTabbedPane
050 *
051 * @author Andrew Selkirk (aselkirk@sympatico.ca)
052 * @author Sascha Brawer (brawer@dandelis.ch)
053 */
054public abstract class TabbedPaneUI extends ComponentUI
055{
056  /**
057   * Constructs a new <code>TabbedPaneUI</code>.
058   */
059  public TabbedPaneUI()
060  {
061    // Nothing to do here.
062  }
063  
064  
065  /**
066   * Determines which tab lies at a given position.
067   *
068   * @param pane the <code>JTabbedPane</code> for which this
069   *        delegate object provides the user interface.
070   *
071   * @param x the horizontal position, where zero is the left
072   *        edge of <code>pane</code>.
073   *
074   * @param y the vertical position, where zero is the top
075   *        edge of <code>pane</code>.
076   *
077   * @return the zero-based index of the tab, or -1 if no
078   *         tab is at the specified position.
079   */
080  public abstract int tabForCoordinate(JTabbedPane pane,
081                                       int x, int y);
082  
083
084  /**
085   * Calculates the bounding box of a tab.
086   *
087   * @param pane the <code>JTabbedPane</code> for which this
088   *        delegate object provides the user interface.
089   *
090   * @param index the index of the tab, which must be an integer
091   *        in the range <code>[0 .. pane.getTabCount() - 1]</code>.
092   *
093   * @return the bounding box of the <code>index</code>-th tab,
094   *         in the coordinate system of <code>pane</code>.
095   */
096  public abstract Rectangle getTabBounds(JTabbedPane pane, int index);
097
098
099  /**
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