1 /* SplitPaneUI.java -- 2 Copyright (C) 2002, 2003 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 package javax.swing.plaf; 39 40 41 import java.awt.Graphics; 42 import javax.swing.JSplitPane; 43 44 45 /** 46 * An abstract base class for delegates that implement the pluggable 47 * look and feel for a <code>JSplitPane</code>. 48 * 49 * @see javax.swing.JSplitPane 50 * 51 * @author Andrew Selkirk (aselkirk@sympatico.ca) 52 * @author Sascha Brawer (brawer@dandelis.ch) 53 */ 54 public abstract class SplitPaneUI 55 extends ComponentUI 56 { 57 /** 58 * Constructs a new <code>SplitPaneUI</code>. 59 */ SplitPaneUI()60 public SplitPaneUI() 61 { 62 } 63 64 65 /** 66 * Moves the divider to the location which best respects 67 * the preferred sizes of the children. 68 * 69 * @param pane the <code>JSplitPane</code> for thich this 70 * delegate provides the look and feel. 71 */ resetToPreferredSizes(JSplitPane pane)72 public abstract void resetToPreferredSizes(JSplitPane pane); 73 74 75 /** 76 * Moves the divider to the specified location. 77 * 78 * @param pane the <code>JSplitPane</code> for thich this 79 * delegate provides the look and feel. 80 * 81 * @param location the new location of the divider. 82 */ setDividerLocation(JSplitPane pane, int location)83 public abstract void setDividerLocation(JSplitPane pane, 84 int location); 85 86 87 /** 88 * Determines the current location of the divider. 89 * 90 * @param pane the <code>JSplitPane</code> for thich this 91 * delegate provides the look and feel. 92 * 93 * @return the current location of the divider. 94 */ getDividerLocation(JSplitPane pane)95 public abstract int getDividerLocation(JSplitPane pane); 96 97 98 /** 99 * 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 */ getMinimumDividerLocation(JSplitPane pane)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 */ getMaximumDividerLocation(JSplitPane pane)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 */ finishedPaintingChildren(JSplitPane pane, Graphics g)131 public abstract void finishedPaintingChildren(JSplitPane pane, 132 Graphics g); 133 } 134