001/* SplitPaneUI.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.Graphics;
042
043import javax.swing.JSplitPane;
044
045/**
046 * An abstract base class for delegates that implement the pluggable
047 * look and feel for a <code>JSplitPane</code>.
048 *
049 * @see javax.swing.JSplitPane
050 *
051 * @author Andrew Selkirk (aselkirk@sympatico.ca)
052 * @author Sascha Brawer (brawer@dandelis.ch)
053 */
054public abstract class SplitPaneUI extends ComponentUI
055{
056  /**
057   * Constructs a new <code>SplitPaneUI</code>.
058   */
059  public SplitPaneUI()
060  {
061    // Nothing to do here.
062  }
063
064
065  /**
066   * Moves the divider to the location which best respects
067   * the preferred sizes of the children.
068   *
069   * @param pane the <code>JSplitPane</code> for thich this
070   *        delegate provides the look and feel.
071   */
072  public abstract void resetToPreferredSizes(JSplitPane pane);
073
074
075  /**
076   * Moves the divider to the specified location.
077   *
078   * @param pane the <code>JSplitPane</code> for thich this
079   *        delegate provides the look and feel.
080   *
081   * @param location the new location of the divider.
082   */
083  public abstract void setDividerLocation(JSplitPane pane,
084                                          int location);
085
086
087  /**
088   * Determines the current location of the divider.
089   *
090   * @param pane the <code>JSplitPane</code> for thich this
091   *        delegate provides the look and feel.
092   *
093   * @return the current location of the divider.
094   */
095  public abstract int getDividerLocation(JSplitPane pane);
096
097
098  /**
099   * Determines the minimum location of the divider.
100   *
101   * @param pane the <code>JSplitPane</code> for thich this
102   *        delegate provides the look and feel.
103   *
104   * @return the leftmost (or topmost) possible location
105   *         of the divider.
106   */
107  public abstract int getMinimumDividerLocation(JSplitPane pane);
108
109
110  /**
111   * Determines the maximum location of the divider.
112   *
113   * @param pane the <code>JSplitPane</code> for thich this
114   *        delegate provides the look and feel.
115   *
116   * @return the bottommost (or rightmost) possible location
117   *         of the divider.
118   */
119  public abstract int getMaximumDividerLocation(JSplitPane pane);
120
121
122  /**
123   * Called by the <code>JSplitPane</code> after it has finished
124   * painting its children.
125   *
126   * @param pane the <code>JSplitPane</code> for thich this
127   *        delegate provides the look and feel.
128   *
129   * @param g the Graphics used for painting.
130   */
131  public abstract void finishedPaintingChildren(JSplitPane pane,
132                                                Graphics g);
133}