author | ddehaven |
Tue, 19 Aug 2014 10:32:16 -0700 | |
changeset 26037 | 508779ce6619 |
parent 26013 | jdk/src/share/classes/javax/swing/plaf/SplitPaneUI.java@83b99f14245f |
parent 25859 | jdk/src/share/classes/javax/swing/plaf/SplitPaneUI.java@3317bb8137f4 |
permissions | -rw-r--r-- |
2 | 1 |
/* |
26013
83b99f14245f
8042284: Add block tags for @return and @param to swing plaf classes
ssides
parents:
5506
diff
changeset
|
2 |
* Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved. |
2 | 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 |
|
5506 | 7 |
* published by the Free Software Foundation. Oracle designates this |
2 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5506 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
2 | 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 |
* |
|
5506 | 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. |
|
2 | 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 |
* Messaged to relayout the JSplitPane based on the preferred size |
|
40 |
* of the children components. |
|
26013
83b99f14245f
8042284: Add block tags for @return and @param to swing plaf classes
ssides
parents:
5506
diff
changeset
|
41 |
* |
83b99f14245f
8042284: Add block tags for @return and @param to swing plaf classes
ssides
parents:
5506
diff
changeset
|
42 |
* @param jc a {@code JSplitPane} |
2 | 43 |
*/ |
44 |
public abstract void resetToPreferredSizes(JSplitPane jc); |
|
45 |
||
46 |
/** |
|
47 |
* Sets the location of the divider to location. |
|
26013
83b99f14245f
8042284: Add block tags for @return and @param to swing plaf classes
ssides
parents:
5506
diff
changeset
|
48 |
* |
83b99f14245f
8042284: Add block tags for @return and @param to swing plaf classes
ssides
parents:
5506
diff
changeset
|
49 |
* @param jc a {@code JSplitPane} |
83b99f14245f
8042284: Add block tags for @return and @param to swing plaf classes
ssides
parents:
5506
diff
changeset
|
50 |
* @param location an integer specifying the location of the divider |
2 | 51 |
*/ |
52 |
public abstract void setDividerLocation(JSplitPane jc, int location); |
|
53 |
||
54 |
/** |
|
55 |
* Returns the location of the divider. |
|
26013
83b99f14245f
8042284: Add block tags for @return and @param to swing plaf classes
ssides
parents:
5506
diff
changeset
|
56 |
* |
83b99f14245f
8042284: Add block tags for @return and @param to swing plaf classes
ssides
parents:
5506
diff
changeset
|
57 |
* @param jc a {@code JSplitPane} |
83b99f14245f
8042284: Add block tags for @return and @param to swing plaf classes
ssides
parents:
5506
diff
changeset
|
58 |
* @return an integer specifying the location of the divider |
2 | 59 |
*/ |
60 |
public abstract int getDividerLocation(JSplitPane jc); |
|
61 |
||
62 |
/** |
|
63 |
* Returns the minimum possible location of the divider. |
|
26013
83b99f14245f
8042284: Add block tags for @return and @param to swing plaf classes
ssides
parents:
5506
diff
changeset
|
64 |
* |
83b99f14245f
8042284: Add block tags for @return and @param to swing plaf classes
ssides
parents:
5506
diff
changeset
|
65 |
* @param jc a {@code JSplitPane} |
83b99f14245f
8042284: Add block tags for @return and @param to swing plaf classes
ssides
parents:
5506
diff
changeset
|
66 |
* @return and integer specifying the minimum location of the divider |
2 | 67 |
*/ |
68 |
public abstract int getMinimumDividerLocation(JSplitPane jc); |
|
69 |
||
70 |
/** |
|
71 |
* Returns the maximum possible location of the divider. |
|
26013
83b99f14245f
8042284: Add block tags for @return and @param to swing plaf classes
ssides
parents:
5506
diff
changeset
|
72 |
* |
83b99f14245f
8042284: Add block tags for @return and @param to swing plaf classes
ssides
parents:
5506
diff
changeset
|
73 |
* @param jc a {@code JSplitPane} |
83b99f14245f
8042284: Add block tags for @return and @param to swing plaf classes
ssides
parents:
5506
diff
changeset
|
74 |
* @return an integer specifying the maximum location of the divider |
2 | 75 |
*/ |
76 |
public abstract int getMaximumDividerLocation(JSplitPane jc); |
|
77 |
||
78 |
/** |
|
79 |
* Messaged after the JSplitPane the receiver is providing the look |
|
80 |
* and feel for paints its children. |
|
26013
83b99f14245f
8042284: Add block tags for @return and @param to swing plaf classes
ssides
parents:
5506
diff
changeset
|
81 |
* |
83b99f14245f
8042284: Add block tags for @return and @param to swing plaf classes
ssides
parents:
5506
diff
changeset
|
82 |
* @param jc a {@code JSplitPane} |
83b99f14245f
8042284: Add block tags for @return and @param to swing plaf classes
ssides
parents:
5506
diff
changeset
|
83 |
* @param g the {@code Graphics} context |
2 | 84 |
*/ |
85 |
public abstract void finishedPaintingChildren(JSplitPane jc, Graphics g); |
|
86 |
} |