1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
/*
* Copyright (c) 2023, 2024, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
import java.awt.Component;
import java.awt.Dimension;
import java.awt.GraphicsConfiguration;
import java.awt.Insets;
import java.awt.Point;
import java.awt.Window;
import java.util.List;
import static java.awt.GraphicsEnvironment.getLocalGraphicsEnvironment;
import static java.awt.Toolkit.getDefaultToolkit;
/**
* A utility class which provides standard window layouts for multi-window
* manual tests using the {@link PassFailJFrame} framework.
* The layout methods {@code right-} and {@code bottom-} implement the
* {@link PassFailJFrame.PositionWindows PositionWindows} interface and
* can be used directly or via builder methods.
* <p>
* There are several helper methods, such as
* {@link #getScreenCenter() getScreenCenter}, which could help you
* implement customized windows layouts.
*/
public final class WindowLayouts {
/** Private constructor to prevent instantiating the utility class. */
private WindowLayouts() {
}
/** A gap between windows. (Local copy makes expressions shorter.) */
private static final int WINDOW_GAP = PassFailJFrame.WINDOW_GAP;
/**
* Lays out the window list in one row to the right of
* the instruction frame. The top of the windows is aligned to
* that of the instruction frame.
*
* @param windows the list of windows to lay out
* @param instructionUI information about the instruction frame
*/
public static void rightOneRow(final List<Window> windows,
final PassFailJFrame.InstructionUI instructionUI) {
layoutRow(instructionUI.getLocation().x
+ instructionUI.getSize().width
+ WINDOW_GAP,
instructionUI.getLocation().y,
windows);
}
/**
* Lays out the window list in one column to the right of
* the instruction frame. The top of the first window is aligned to
* that of the instruction frame.
*
* @param windows the list of windows to lay out
* @param instructionUI information about the instruction frame
*/
public static void rightOneColumn(final List<Window> windows,
final PassFailJFrame.InstructionUI instructionUI) {
layoutColumn(instructionUI.getLocation().x
+ instructionUI.getSize().width
+ WINDOW_GAP,
instructionUI.getLocation().y,
windows);
}
/**
* Lays out the window list in one column to the right of
* the instruction frame centering the stack of the windows.
*
* @param windows the list of windows to lay out
* @param instructionUI information about the instruction frame
*/
public static void rightOneColumnCentered(final List<Window> windows,
final PassFailJFrame.InstructionUI instructionUI) {
layoutColumn(instructionUI.getLocation().x
+ instructionUI.getSize().width
+ WINDOW_GAP,
getScreenCenter().y
- getWindowListHeight(windows) / 2,
windows);
}
/**
* Lays out the window list in one row to the bottom of
* the instruction frame. The left of the first window is aligned to
* that of the instruction frame.
*
* @param windows the list of windows to lay out
* @param instructionUI information about the instruction frame
*/
public static void bottomOneRow(final List<Window> windows,
final PassFailJFrame.InstructionUI instructionUI) {
layoutRow(instructionUI.getLocation().x,
instructionUI.getLocation().y
+ instructionUI.getSize().height
+ WINDOW_GAP,
windows);
}
/**
* Lays out the window list in one row to the bottom of
* the instruction frame centering the row of the windows.
*
* @param windows the list of windows to lay out
* @param instructionUI information about the instruction frame
*/
public static void bottomOneRowCentered(final List<Window> windows,
final PassFailJFrame.InstructionUI instructionUI) {
layoutRow(getScreenCenter().x
- getWindowListWidth(windows) / 2,
instructionUI.getLocation().y
+ instructionUI.getSize().height
+ WINDOW_GAP,
windows);
}
/**
* Lays out the window list in one column to the bottom of
* the instruction frame. The left of the first window is aligned to
* that of the instruction frame.
*
* @param windows the list of windows to lay out
* @param instructionUI information about the instruction frame
*/
public static void bottomOneColumn(final List<Window> windows,
final PassFailJFrame.InstructionUI instructionUI) {
layoutColumn(instructionUI.getLocation().x,
instructionUI.getLocation().y
+ instructionUI.getSize().height
+ WINDOW_GAP,
windows);
}
/**
* Lays out the window list in one row starting at
* ({@code x0}, {@code y}).
*
* @param x0 the starting <var>x</var> coordinate of the windows
* @param y the <var>y</var> coordinate of the windows
* @param windows the list of windows to lay out
*/
public static void layoutRow(final int x0,
final int y,
final List<Window> windows) {
int x = x0;
for (Window w : windows) {
w.setLocation(x, y);
x += w.getWidth() + WINDOW_GAP;
}
}
/**
* Lays out the window list in one column starting at
* ({@code x}, {@code y0}).
*
* @param x the <var>x</var> coordinate of the windows
* @param y0 the starting <var>y</var> coordinate of the windows
* @param windows the list of windows to lay out
*/
public static void layoutColumn(final int x,
final int y0,
final List<Window> windows) {
int y = y0;
for (Window w : windows) {
w.setLocation(x, y);
y += w.getHeight() + WINDOW_GAP;
}
}
/**
* {@return the center point of the main screen}
*/
public static Point getScreenCenter() {
GraphicsConfiguration gc = getLocalGraphicsEnvironment()
.getDefaultScreenDevice()
.getDefaultConfiguration();
Dimension size = gc.getBounds()
.getSize();
Insets insets = getDefaultToolkit()
.getScreenInsets(gc);
return new Point((size.width - insets.left - insets.right) / 2,
(size.height - insets.top - insets.bottom) / 2);
}
/**
* {@return width of the windows in the list, taking into account
* the gap between windows}
*
* @param windows the list of windows to get the width of
*/
public static int getWindowListWidth(final List<Window> windows) {
return windows.stream()
.mapToInt(Component::getWidth)
.sum()
+ WINDOW_GAP * (windows.size() - 1);
}
/**
* {@return height of the windows in the list, taking into account
* the gap between windows}
*
* @param windows the list of windows to get the height of
*/
public static int getWindowListHeight(final List<Window> windows) {
return windows.stream()
.mapToInt(Component::getHeight)
.sum()
+ WINDOW_GAP * (windows.size() - 1);
}
}
|
