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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
|
package net.miginfocom.swt;
/*
* License (BSD):
* ==============
*
* Copyright (c) 2004, Mikael Grev, MiG InfoCom AB. (miglayout (at) miginfocom (dot) com)
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list
* of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this
* list of conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution.
* Neither the name of the MiG InfoCom AB nor the names of its contributors may be
* used to endorse or promote products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
* OF SUCH DAMAGE.
*
* @version 1.0
* @author Mikael Grev, MiG InfoCom AB
* Date: 2006-sep-08
*/
import net.miginfocom.layout.*;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.swt.widgets.*;
import org.eclipse.swt.widgets.Composite;
import java.io.*;
import java.util.*;
/** A very flexbile layout manager.
* <p>
* Read the documentation that came with this layout manager for information on usage.
*/
public final class MigLayout extends Layout implements Externalizable
{
// ******** Instance part ********
/** The component to string constraints mappings.
*/
private final Map<Control, Object> scrConstrMap = new IdentityHashMap<Control, Object>(8);
/** Hold the serializable text representation of the constraints.
*/
private Object layoutConstraints = "", colConstraints = "", rowConstraints = ""; // Should never be null!
// ******** Transient part ********
private transient ContainerWrapper cacheParentW = null;
private transient final Map<ComponentWrapper, CC> ccMap = new HashMap<ComponentWrapper, CC>(8);
private transient LC lc = null;
private transient AC colSpecs = null, rowSpecs = null;
private transient Grid grid = null;
private transient java.util.Timer debugTimer = null;
private transient long curDelay = -1;
private transient int lastModCount = PlatformDefaults.getModCount();
private transient int lastHash = -1;
private transient ArrayList<LayoutCallback> callbackList = null;
/** Constructor with no constraints.
*/
public MigLayout()
{
this("", "", "");
}
/** Constructor.
* @param layoutConstraints The constraints that concern the whole layout. <code>null</code> will be treated as "".
*/
public MigLayout(String layoutConstraints)
{
this(layoutConstraints, "", "");
}
/** Constructor.
* @param layoutConstraints The constraints that concern the whole layout. <code>null</code> will be treated as "".
* @param colConstraints The constraints for the columns in the grid. <code>null</code> will be treated as "".
*/
public MigLayout(String layoutConstraints, String colConstraints)
{
this(layoutConstraints, colConstraints, "");
}
/** Constructor.
* @param layoutConstraints The constraints that concern the whole layout. <code>null</code> will be treated as "".
* @param colConstraints The constraints for the columns in the grid. <code>null</code> will be treated as "".
* @param rowConstraints The constraints for the rows in the grid. <code>null</code> will be treated as "".
*/
public MigLayout(String layoutConstraints, String colConstraints, String rowConstraints)
{
setLayoutConstraints(layoutConstraints);
setColumnConstraints(colConstraints);
setRowConstraints(rowConstraints);
}
/** Constructor.
* @param layoutConstraints The constraints that concern the whole layout. <code>null</code> will be treated as an empty cosntraint.
*/
public MigLayout(LC layoutConstraints)
{
this(layoutConstraints, null, null);
}
/** Constructor.
* @param layoutConstraints The constraints that concern the whole layout. <code>null</code> will be treated as an empty cosntraint.
* @param colConstraints The constraints for the columns in the grid. <code>null</code> will be treated as an empty constraint.
*/
public MigLayout(LC layoutConstraints, AC colConstraints)
{
this(layoutConstraints, colConstraints, null);
}
/** Constructor.
* @param layoutConstraints The constraints that concern the whole layout. <code>null</code> will be treated as an empty cosntraint.
* @param colConstraints The constraints for the columns in the grid. <code>null</code> will be treated as an empty constraint.
* @param rowConstraints The constraints for the rows in the grid. <code>null</code> will be treated as an empty constraint.
*/
public MigLayout(LC layoutConstraints, AC colConstraints, AC rowConstraints)
{
setLayoutConstraints(layoutConstraints);
setColumnConstraints(colConstraints);
setRowConstraints(rowConstraints);
}
/** Returns layout constraints eighter as a <code>String</code> or {@link net.miginfocom.layout.LC} depending what was sent in
* to the constructor or set with {@link #setLayoutConstraints(Object)}.
* @return The layout constraints eighter as a <code>String</code> or {@link net.miginfocom.layout.LC} depending what was sent in
* to the constructor or set with {@link #setLayoutConstraints(Object)}. Never <code>null</code>.
*/
public Object getLayoutConstraints()
{
return layoutConstraints;
}
/** Sets the layout constraints for the layout manager instance as a String.
* <p>
* See the class JavaDocs for information on how this string is formatted.
* @param s The layout constraints as a String representation. <code>null</code> is converted to <code>""</code> for storage.
* @throws RuntimeException if the constaint was not valid.
*/
public void setLayoutConstraints(Object s)
{
if (s == null || s instanceof String) {
s = ConstraintParser.prepare((String) s);
lc = ConstraintParser.parseLayoutConstraint((String) s);
} else if (s instanceof LC) {
lc = (LC) s;
} else {
throw new IllegalArgumentException("Illegal constraint type: " + s.getClass().toString());
}
layoutConstraints = s;
grid = null;
}
/** Returns the column layout constraints either as a <code>String</code> or {@link net.miginfocom.layout.AC}.
* @return The column constraints eighter as a <code>String</code> or {@link net.miginfocom.layout.LC} depending what was sent in
* to the constructor or set with {@link #setLayoutConstraints(Object)}. Never <code>null</code>.
*/
public Object getColumnConstraints()
{
return colConstraints;
}
/** Sets the column layout constraints for the layout manager instance as a String.
* <p>
* See the class JavaDocs for information on how this string is formatted.
* @param constr The column layout constraints as a String representation. <code>null</code> is converted to <code>""</code> for storage.
* @throws RuntimeException if the constaint was not valid.
*/
public void setColumnConstraints(Object constr)
{
if (constr == null || constr instanceof String) {
constr = ConstraintParser.prepare((String) constr);
colSpecs = ConstraintParser.parseColumnConstraints((String) constr);
} else if (constr instanceof AC) {
colSpecs = (AC) constr;
} else {
throw new IllegalArgumentException("Illegal constraint type: " + constr.getClass().toString());
}
colConstraints = constr;
grid = null;
}
/** Returns the row layout constraints as a String representation. This string is the exact string as set with {@link #setRowConstraints(Object)}
* or sent into the constructor.
* <p>
* See the class JavaDocs for information on how this string is formatted.
* @return The row layout constraints as a String representation. Never <code>null</code>.
*/
public Object getRowConstraints()
{
return rowConstraints;
}
/** Sets the row layout constraints for the layout manager instance as a String.
* <p>
* See the class JavaDocs for information on how this string is formatted.
* @param constr The row layout constraints as a String representation. <code>null</code> is converted to <code>""</code> for storage.
* @throws RuntimeException if the constaint was not valid.
*/
public void setRowConstraints(Object constr)
{
if (constr == null || constr instanceof String) {
constr = ConstraintParser.prepare((String) constr);
rowSpecs = ConstraintParser.parseRowConstraints((String) constr);
} else if (constr instanceof AC) {
rowSpecs = (AC) constr;
} else {
throw new IllegalArgumentException("Illegal constraint type: " + constr.getClass().toString());
}
rowConstraints = constr;
grid = null;
}
/** Returns the component constraints as a String representation. This string is the exact string as set with {@link #setComponentConstraints(org.eclipse.swt.widgets.Control, Object)}
* or set when adding the component to the parent component.
* <p>
* See the class JavaDocs for information on how this string is formatted.
* @param comp The component to return the constraints for.
* @return The component constraints as a String representation ir <code>null</code> if the component is not registered
* with this layout manager. The returned values is wither a String or a {@link net.miginfocom.layout.CC}
* depending on what constraint was sent in when the component was added. May be <code>null</code>.
*/
public Object getComponentConstraints(Control comp)
{
return scrConstrMap.get(comp);
}
/** Sets the component constraint for the component that already must be handleded by this layout manager.
* <p>
* See the class JavaDocs for information on how this string is formatted.
* @param constr The component constraints as a String or {@link net.miginfocom.layout.CC}. <code>null</code> is ok.
* @param comp The component to set the constraints for.
* @throws RuntimeException if the constaint was not valid.
* @throws IllegalArgumentException If the component is not handlering the component.
*/
public void setComponentConstraints(Control comp, Object constr)
{
setComponentConstraintsImpl(comp, constr, false);
}
/** Sets the component constraint for the component that already must be handleded by this layout manager.
* <p>
* See the class JavaDocs for information on how this string is formatted.
* @param constr The component constraints as a String or {@link net.miginfocom.layout.CC}. <code>null</code> is ok.
* @param comp The component to set the constraints for.
* @throws RuntimeException if the constaint was not valid.
* @throws IllegalArgumentException If the component is not handling the component.
*/
private void setComponentConstraintsImpl(Control comp, Object constr, boolean noCheck)
{
if (noCheck == false && scrConstrMap.containsKey(comp) == false)
throw new IllegalArgumentException("Component must already be added to parent!");
ComponentWrapper cw = new SwtComponentWrapper(comp);
if (constr == null || constr instanceof String) {
String cStr = ConstraintParser.prepare((String) constr);
scrConstrMap.put(comp, constr);
ccMap.put(cw, ConstraintParser.parseComponentConstraint(cStr));
} else if (constr instanceof CC) {
scrConstrMap.put(comp, constr);
ccMap.put(cw, (CC) constr);
} else {
throw new IllegalArgumentException("Constraint must be String or ComponentConstraint: " + constr.getClass().toString());
}
grid = null;
}
/** Returns if this layout manager is currently managing this component.
* @param c The component to check. If <code>null</code> then <code>false</code> will be returned.
* @return If this layout manager is currently managing this component.
*/
public boolean isManagingComponent(Control c)
{
return scrConstrMap.containsKey(c);
}
/** Adds the callback function that will be called at different stages of the layout cylce.
* @param callback The callback. Not <code>null</code>.
*/
public void addLayoutCallback(LayoutCallback callback)
{
if (callback == null)
throw new NullPointerException();
if (callbackList == null)
callbackList = new ArrayList<LayoutCallback>(1);
callbackList.add(callback);
}
/** Removes the callback if it exists.
* @param callback The callback. May be <code>null</code>.
*/
public void removeLayoutCallback(LayoutCallback callback)
{
if (callbackList != null)
callbackList.remove(callback);
}
/** Sets the debugging state for this layout manager instance. If debug is turned on a timer will repaint the last laid out parent
* with debug information on top.
* <p>
* Red fill and dashed darked red outline is used to indicate occupied cells in the grid. Blue dashed outline indicate indicate
* component bounds set.
* <p>
* Note that debug can also be set on the layout constraints. There it will be persisted. The calue set here will not. See the class
* JavaDocs for information.
* @param b <code>true</code> means debug is turned on.
*/
private synchronized void setDebug(final ComponentWrapper parentW, boolean b)
{
if (b && (debugTimer == null || curDelay != lc.getDebugMillis())) {
if (debugTimer != null)
debugTimer.cancel();
TimerTask debugTask = new TimerTask() {
public void run()
{
Display.getDefault ().asyncExec(new Runnable () {
public void run () {
grid.paintDebug();
}
});
}
};
debugTimer = new Timer(true);
curDelay = lc.getDebugMillis();
debugTimer.schedule(debugTask, curDelay, curDelay);
ContainerWrapper pCW = parentW.getParent();
Composite parent = pCW != null ? (Composite) pCW.getComponent() : null;
if (parent != null)
parent.layout();
} else if (!b && debugTimer != null) {
debugTimer.cancel();
debugTimer = null;
}
}
/** Returns the current debugging state.
* @return The current debugging state.
*/
private boolean getDebug()
{
return debugTimer != null;
}
/** Check if something has changed and if so recrete it to the cached objects.
* @param parent The parent that is the target for this layout manager.
*/
private final void checkCache(Composite parent)
{
if (parent == null)
return;
checkConstrMap(parent);
ContainerWrapper par = checkParent(parent);
// Check if the grid is valid
int mc = PlatformDefaults.getModCount();
if (lastModCount != mc) {
grid = null;
lastModCount = mc;
}
int hash = parent.getSize().hashCode();
for (Iterator<ComponentWrapper> it = ccMap.keySet().iterator(); it.hasNext();)
hash += it.next().getLayoutHashCode();
if (hash != lastHash) {
grid = null;
lastHash = hash;
}
setDebug(par, lc.getDebugMillis() > 0);
if (grid == null)
grid = new Grid(par, lc, rowSpecs, colSpecs, ccMap, callbackList);
}
private boolean checkConstrMap(Composite parent)
{
Control[] comps = parent.getChildren();
boolean changed = comps.length != scrConstrMap.size();
if (changed == false) {
for (int i = 0; i < comps.length; i++) {
Control c = comps[i];
if (scrConstrMap.get(c) != c.getLayoutData()) {
changed = true;
break;
}
}
}
if (changed) {
scrConstrMap.clear();
for (int i = 0; i < comps.length; i++) {
Control c = comps[i];
setComponentConstraintsImpl(c, c.getLayoutData(), true);
}
}
return changed;
}
private final ContainerWrapper checkParent(Composite parent)
{
if (parent == null)
return null;
if (cacheParentW == null || cacheParentW.getComponent() != parent)
cacheParentW = new SwtContainerWrapper(parent);
return cacheParentW;
}
public float getLayoutAlignmentX(Composite parent)
{
return lc != null && lc.getAlignX() != null ? lc.getAlignX().getPixels(1, checkParent(parent), null) : 0;
}
public float getLayoutAlignmentY(Composite parent)
{
return lc != null && lc.getAlignY() != null ? lc.getAlignY().getPixels(1, checkParent(parent), null) : 0;
}
protected Point computeSize(Composite parent, int wHint, int hHint, boolean flushCache)
{
checkCache(parent);
int w = LayoutUtil.getSizeSafe(grid != null ? grid.getWidth() : null, LayoutUtil.PREF);
int h = LayoutUtil.getSizeSafe(grid != null ? grid.getHeight() : null, LayoutUtil.PREF);
return new Point(w, h);
}
protected void layout(Composite parent, boolean flushCache)
{
checkCache(parent);
Rectangle r = parent.getClientArea();
int[] b = new int[] {r.x, r.y, r.width, r.height};
final boolean layoutAgain = grid.layout(b, lc.getAlignX(), lc.getAlignY(), getDebug(), true);
if (layoutAgain) {
grid = null;
checkCache(parent);
grid.layout(b, lc.getAlignX(), lc.getAlignY(), getDebug(), false);
}
}
protected boolean flushCache(Control control)
{
if (lc.isNoCache())
grid = null;
return true;
}
// ************************************************
// Persistence Delegate and Serializable combined.
// ************************************************
private Object readResolve() throws ObjectStreamException
{
return LayoutUtil.getSerializedObject(this);
}
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
{
LayoutUtil.setSerializedObject(this, LayoutUtil.readAsXML(in));
}
public void writeExternal(ObjectOutput out) throws IOException
{
if (getClass() == MigLayout.class)
LayoutUtil.writeAsXML(out, this);
}
}
|