1 /*
2  * Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 
26 package javax.swing.plaf;
27 
28 import javax.swing.JSplitPane;
29 import java.awt.Graphics;
30 
31 /**
32  * Pluggable look and feel interface for JSplitPane.
33  *
34  * @author Scott Violet
35  */
36 public abstract class SplitPaneUI extends ComponentUI
37 {
38     /**
39      * Constructor for subclasses to call.
40      */
SplitPaneUI()41     protected SplitPaneUI() {}
42 
43     /**
44      * Messaged to relayout the JSplitPane based on the preferred size
45      * of the children components.
46      *
47      * @param jc a {@code JSplitPane}
48      */
resetToPreferredSizes(JSplitPane jc)49     public abstract void resetToPreferredSizes(JSplitPane jc);
50 
51     /**
52      * Sets the location of the divider to location.
53      *
54      * @param jc a {@code JSplitPane}
55      * @param location an integer specifying the location of the divider
56      */
setDividerLocation(JSplitPane jc, int location)57     public abstract void setDividerLocation(JSplitPane jc, int location);
58 
59     /**
60      * Returns the location of the divider.
61      *
62      * @param jc a {@code JSplitPane}
63      * @return an integer specifying the location of the divider
64      */
getDividerLocation(JSplitPane jc)65     public abstract int getDividerLocation(JSplitPane jc);
66 
67     /**
68      * Returns the minimum possible location of the divider.
69      *
70      * @param jc a {@code JSplitPane}
71      * @return and integer specifying the minimum location of the divider
72      */
getMinimumDividerLocation(JSplitPane jc)73     public abstract int getMinimumDividerLocation(JSplitPane jc);
74 
75     /**
76      * Returns the maximum possible location of the divider.
77      *
78      * @param jc a {@code JSplitPane}
79      * @return an integer specifying the maximum location of the divider
80      */
getMaximumDividerLocation(JSplitPane jc)81     public abstract int getMaximumDividerLocation(JSplitPane jc);
82 
83     /**
84      * Messaged after the JSplitPane the receiver is providing the look
85      * and feel for paints its children.
86      *
87      * @param jc a {@code JSplitPane}
88      * @param g the {@code Graphics} context
89      */
finishedPaintingChildren(JSplitPane jc, Graphics g)90     public abstract void finishedPaintingChildren(JSplitPane jc, Graphics g);
91 }
92