-
Notifications
You must be signed in to change notification settings - Fork 5.4k
/
GridBagLayout.java
2235 lines (2077 loc) · 88.7 KB
/
GridBagLayout.java
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
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 1995, 2019, 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. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* 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.
*/
package java.awt;
import java.util.Hashtable;
import java.util.Arrays;
/**
* The {@code GridBagLayout} class is a flexible layout
* manager that aligns components vertically, horizontally or along their
* baseline without requiring that the components be of the same size.
* Each {@code GridBagLayout} object maintains a dynamic,
* rectangular grid of cells, with each component occupying
* one or more cells, called its <em>display area</em>.
* <p>
* Each component managed by a {@code GridBagLayout} is associated with
* an instance of {@link GridBagConstraints}. The constraints object
* specifies where a component's display area should be located on the grid
* and how the component should be positioned within its display area. In
* addition to its constraints object, the {@code GridBagLayout} also
* considers each component's minimum and preferred sizes in order to
* determine a component's size.
* <p>
* The overall orientation of the grid depends on the container's
* {@link ComponentOrientation} property. For horizontal left-to-right
* orientations, grid coordinate (0,0) is in the upper left corner of the
* container with x increasing to the right and y increasing downward. For
* horizontal right-to-left orientations, grid coordinate (0,0) is in the upper
* right corner of the container with x increasing to the left and y
* increasing downward.
* <p>
* To use a grid bag layout effectively, you must customize one or more
* of the {@code GridBagConstraints} objects that are associated
* with its components. You customize a {@code GridBagConstraints}
* object by setting one or more of its instance variables:
*
* <dl>
* <dt>{@link GridBagConstraints#gridx},
* {@link GridBagConstraints#gridy}
* <dd>Specifies the cell containing the leading corner of the component's
* display area, where the cell at the origin of the grid has address
* <code>gridx = 0</code>,
* <code>gridy = 0</code>. For horizontal left-to-right layout,
* a component's leading corner is its upper left. For horizontal
* right-to-left layout, a component's leading corner is its upper right.
* Use {@code GridBagConstraints.RELATIVE} (the default value)
* to specify that the component be placed immediately following
* (along the x axis for {@code gridx} or the y axis for
* {@code gridy}) the component that was added to the container
* just before this component was added.
* <dt>{@link GridBagConstraints#gridwidth},
* {@link GridBagConstraints#gridheight}
* <dd>Specifies the number of cells in a row (for {@code gridwidth})
* or column (for {@code gridheight})
* in the component's display area.
* The default value is 1.
* Use {@code GridBagConstraints.REMAINDER} to specify
* that the component's display area will be from {@code gridx}
* to the last cell in the row (for {@code gridwidth})
* or from {@code gridy} to the last cell in the column
* (for {@code gridheight}).
*
* Use {@code GridBagConstraints.RELATIVE} to specify
* that the component's display area will be from {@code gridx}
* to the next to the last cell in its row (for {@code gridwidth})
* or from {@code gridy} to the next to the last cell in its
* column (for {@code gridheight}).
*
* <dt>{@link GridBagConstraints#fill}
* <dd>Used when the component's display area
* is larger than the component's requested size
* to determine whether (and how) to resize the component.
* Possible values are
* {@code GridBagConstraints.NONE} (the default),
* {@code GridBagConstraints.HORIZONTAL}
* (make the component wide enough to fill its display area
* horizontally, but don't change its height),
* {@code GridBagConstraints.VERTICAL}
* (make the component tall enough to fill its display area
* vertically, but don't change its width), and
* {@code GridBagConstraints.BOTH}
* (make the component fill its display area entirely).
* <dt>{@link GridBagConstraints#ipadx},
* {@link GridBagConstraints#ipady}
* <dd>Specifies the component's internal padding within the layout,
* how much to add to the minimum size of the component.
* The width of the component will be at least its minimum width
* plus {@code ipadx} pixels. Similarly, the height of
* the component will be at least the minimum height plus
* {@code ipady} pixels.
* <dt>{@link GridBagConstraints#insets}
* <dd>Specifies the component's external padding, the minimum
* amount of space between the component and the edges of its display area.
* <dt>{@link GridBagConstraints#anchor}
* <dd>Specifies where the component should be positioned in its display area.
* There are three kinds of possible values: absolute, orientation-relative,
* and baseline-relative.
* Orientation relative values are interpreted relative to the container's
* {@code ComponentOrientation} property while absolute values
* are not. Baseline relative values are calculated relative to the
* baseline. Valid values are:
*
* <ul>
* <li>Absolute Values:
* <ul>
* <li>{@code GridBagConstraints.NORTH}
* <li>{@code GridBagConstraints.SOUTH}
* <li>{@code GridBagConstraints.WEST}
* <li>{@code GridBagConstraints.EAST}
* <li>{@code GridBagConstraints.NORTHWEST}
* <li>{@code GridBagConstraints.NORTHEAST}
* <li>{@code GridBagConstraints.SOUTHWEST}
* <li>{@code GridBagConstraints.SOUTHEAST}
* <li>{@code GridBagConstraints.CENTER} (the default)
* </ul>
* <li>Orientation Relative Values:
* <ul >
* <li>{@code GridBagConstraints.PAGE_START}
* <li>{@code GridBagConstraints.PAGE_END}
* <li>{@code GridBagConstraints.LINE_START}
* <li>{@code GridBagConstraints.LINE_END}
* <li>{@code GridBagConstraints.FIRST_LINE_START}
* <li>{@code GridBagConstraints.FIRST_LINE_END}
* <li>{@code GridBagConstraints.LAST_LINE_START}
* <li>{@code GridBagConstraints.LAST_LINE_END}
* </ul>
* <li>Baseline Relative Values:
* <ul>
* <li>{@code GridBagConstraints.BASELINE}
* <li>{@code GridBagConstraints.BASELINE_LEADING}
* <li>{@code GridBagConstraints.BASELINE_TRAILING}
* <li>{@code GridBagConstraints.ABOVE_BASELINE}
* <li>{@code GridBagConstraints.ABOVE_BASELINE_LEADING}
* <li>{@code GridBagConstraints.ABOVE_BASELINE_TRAILING}
* <li>{@code GridBagConstraints.BELOW_BASELINE}
* <li>{@code GridBagConstraints.BELOW_BASELINE_LEADING}
* <li>{@code GridBagConstraints.BELOW_BASELINE_TRAILING}
* </ul>
* </ul>
* <dt>{@link GridBagConstraints#weightx},
* {@link GridBagConstraints#weighty}
* <dd>Used to determine how to distribute space, which is
* important for specifying resizing behavior.
* Unless you specify a weight for at least one component
* in a row ({@code weightx}) and column ({@code weighty}),
* all the components clump together in the center of their container.
* This is because when the weight is zero (the default),
* the {@code GridBagLayout} object puts any extra space
* between its grid of cells and the edges of the container.
* </dl>
* <p>
* Each row may have a baseline; the baseline is determined by the
* components in that row that have a valid baseline and are aligned
* along the baseline (the component's anchor value is one of {@code
* BASELINE}, {@code BASELINE_LEADING} or {@code BASELINE_TRAILING}).
* If none of the components in the row has a valid baseline, the row
* does not have a baseline.
* <p>
* If a component spans rows it is aligned either to the baseline of
* the start row (if the baseline-resize behavior is {@code
* CONSTANT_ASCENT}) or the end row (if the baseline-resize behavior
* is {@code CONSTANT_DESCENT}). The row that the component is
* aligned to is called the <em>prevailing row</em>.
* <p>
* The following figure shows a baseline layout and includes a
* component that spans rows:
* <p style="text-align: center">
* <img src="doc-files/GridBagLayout-baseline.png"
* alt="The following text describes this graphic (Figure 1).">
* </p>
* This layout consists of three components:
* <ul><li>A panel that starts in row 0 and ends in row 1. The panel
* has a baseline-resize behavior of {@code CONSTANT_DESCENT} and has
* an anchor of {@code BASELINE}. As the baseline-resize behavior
* is {@code CONSTANT_DESCENT} the prevailing row for the panel is
* row 1.
* <li>Two buttons, each with a baseline-resize behavior of
* {@code CENTER_OFFSET} and an anchor of {@code BASELINE}.
* </ul>
* Because the second button and the panel share the same prevailing row,
* they are both aligned along their baseline.
* <p>
* Components positioned using one of the baseline-relative values resize
* differently than when positioned using an absolute or orientation-relative
* value. How components change is dictated by how the baseline of the
* prevailing row changes. The baseline is anchored to the
* bottom of the display area if any components with the same prevailing row
* have a baseline-resize behavior of {@code CONSTANT_DESCENT},
* otherwise the baseline is anchored to the top of the display area.
* The following rules dictate the resize behavior:
* <ul>
* <li>Resizable components positioned above the baseline can only
* grow as tall as the baseline. For example, if the baseline is at 100
* and anchored at the top, a resizable component positioned above the
* baseline can never grow more than 100 units.
* <li>Similarly, resizable components positioned below the baseline can
* only grow as high as the difference between the display height and the
* baseline.
* <li>Resizable components positioned on the baseline with a
* baseline-resize behavior of {@code OTHER} are only resized if
* the baseline at the resized size fits within the display area. If
* the baseline is such that it does not fit within the display area
* the component is not resized.
* <li>Components positioned on the baseline that do not have a
* baseline-resize behavior of {@code OTHER}
* can only grow as tall as {@code display height - baseline + baseline of component}.
* </ul>
* If you position a component along the baseline, but the
* component does not have a valid baseline, it will be vertically centered
* in its space. Similarly if you have positioned a component relative
* to the baseline and none of the components in the row have a valid
* baseline the component is vertically centered.
* <p>
* The following figures show ten components (all buttons)
* managed by a grid bag layout. Figure 2 shows the layout for a horizontal,
* left-to-right container and Figure 3 shows the layout for a horizontal,
* right-to-left container.
*
* <div style="margin:0 auto;width:680px;text-align:center;font-weight:bold">
* <div style="float:left">
* <p><img src="doc-files/GridBagLayout-1.gif"
* alt="The preceding text describes this graphic (Figure 2)."
* style="margin: 7px 10px;">
* <p>Figure 2: Horizontal, Left-to-Right
* </div>
* <div style="float:right">
* <p><img src="doc-files/GridBagLayout-2.gif"
* alt="The preceding text describes this graphic (Figure 3)."
* style="margin: 7px 10px;">
* <p>Figure 3: Horizontal, Right-to-Left
* </div>
* <br style="clear:both;">
* </div>
* <p>
* Each of the ten components has the {@code fill} field
* of its associated {@code GridBagConstraints} object
* set to {@code GridBagConstraints.BOTH}.
* In addition, the components have the following non-default constraints:
*
* <ul>
* <li>Button1, Button2, Button3: <code>weightx = 1.0</code>
* <li>Button4: <code>weightx = 1.0</code>,
* <code>gridwidth = GridBagConstraints.REMAINDER</code>
* <li>Button5: <code>gridwidth = GridBagConstraints.REMAINDER</code>
* <li>Button6: <code>gridwidth = GridBagConstraints.RELATIVE</code>
* <li>Button7: <code>gridwidth = GridBagConstraints.REMAINDER</code>
* <li>Button8: <code>gridheight = 2</code>,
* <code>weighty = 1.0</code>
* <li>Button9, Button 10:
* <code>gridwidth = GridBagConstraints.REMAINDER</code>
* </ul>
* <p>
* Here is the code that implements the example shown above:
*
* <hr><blockquote><pre>
* import java.awt.*;
* import java.util.*;
* import java.applet.Applet;
*
* public class GridBagEx1 extends Applet {
*
* protected void makebutton(String name,
* GridBagLayout gridbag,
* GridBagConstraints c) {
* Button button = new Button(name);
* gridbag.setConstraints(button, c);
* add(button);
* }
*
* public void init() {
* GridBagLayout gridbag = new GridBagLayout();
* GridBagConstraints c = new GridBagConstraints();
*
* setFont(new Font("SansSerif", Font.PLAIN, 14));
* setLayout(gridbag);
*
* c.fill = GridBagConstraints.BOTH;
* c.weightx = 1.0;
* makebutton("Button1", gridbag, c);
* makebutton("Button2", gridbag, c);
* makebutton("Button3", gridbag, c);
*
* c.gridwidth = GridBagConstraints.REMAINDER; //end row
* makebutton("Button4", gridbag, c);
*
* c.weightx = 0.0; //reset to the default
* makebutton("Button5", gridbag, c); //another row
*
* c.gridwidth = GridBagConstraints.RELATIVE; //next-to-last in row
* makebutton("Button6", gridbag, c);
*
* c.gridwidth = GridBagConstraints.REMAINDER; //end row
* makebutton("Button7", gridbag, c);
*
* c.gridwidth = 1; //reset to the default
* c.gridheight = 2;
* c.weighty = 1.0;
* makebutton("Button8", gridbag, c);
*
* c.weighty = 0.0; //reset to the default
* c.gridwidth = GridBagConstraints.REMAINDER; //end row
* c.gridheight = 1; //reset to the default
* makebutton("Button9", gridbag, c);
* makebutton("Button10", gridbag, c);
*
* setSize(300, 100);
* }
*
* public static void main(String args[]) {
* Frame f = new Frame("GridBag Layout Example");
* GridBagEx1 ex1 = new GridBagEx1();
*
* ex1.init();
*
* f.add("Center", ex1);
* f.pack();
* f.setSize(f.getPreferredSize());
* f.show();
* }
* }
* </pre></blockquote><hr>
*
* @author Doug Stein
* @author Bill Spitzak (orignial NeWS & OLIT implementation)
* @see java.awt.GridBagConstraints
* @see java.awt.GridBagLayoutInfo
* @see java.awt.ComponentOrientation
* @since 1.0
*/
public class GridBagLayout implements LayoutManager2,
java.io.Serializable {
static final int EMPIRICMULTIPLIER = 2;
/**
* This field is no longer used to reserve arrays and kept for backward
* compatibility. Previously, this was
* the maximum number of grid positions (both horizontal and
* vertical) that could be laid out by the grid bag layout.
* Current implementation doesn't impose any limits
* on the size of a grid.
*/
protected static final int MAXGRIDSIZE = 512;
/**
* The smallest grid that can be laid out by the grid bag layout.
*/
protected static final int MINSIZE = 1;
/**
* The preferred grid size that can be laid out by the grid bag layout.
*/
protected static final int PREFERREDSIZE = 2;
/**
* This hashtable maintains the association between
* a component and its gridbag constraints.
* The Keys in {@code comptable} are the components and the
* values are the instances of {@code GridBagConstraints}.
*
* @serial
* @see java.awt.GridBagConstraints
*/
protected Hashtable<Component,GridBagConstraints> comptable;
/**
* This field holds a gridbag constraints instance
* containing the default values, so if a component
* does not have gridbag constraints associated with
* it, then the component will be assigned a
* copy of the {@code defaultConstraints}.
*
* @serial
* @see #getConstraints(Component)
* @see #setConstraints(Component, GridBagConstraints)
* @see #lookupConstraints(Component)
*/
protected GridBagConstraints defaultConstraints;
/**
* This field holds the layout information
* for the gridbag. The information in this field
* is based on the most recent validation of the
* gridbag.
* If {@code layoutInfo} is {@code null}
* this indicates that there are no components in
* the gridbag or if there are components, they have
* not yet been validated.
*
* @serial
* @see #getLayoutInfo(Container, int)
*/
protected GridBagLayoutInfo layoutInfo;
/**
* This field holds the overrides to the column minimum
* width. If this field is non-{@code null} the values are
* applied to the gridbag after all of the minimum columns
* widths have been calculated.
* If columnWidths has more elements than the number of
* columns, columns are added to the gridbag to match
* the number of elements in columnWidth.
*
* @serial
* @see #getLayoutDimensions()
*/
public int[] columnWidths;
/**
* This field holds the overrides to the row minimum
* heights. If this field is non-{@code null} the values are
* applied to the gridbag after all of the minimum row
* heights have been calculated.
* If {@code rowHeights} has more elements than the number of
* rows, rows are added to the gridbag to match
* the number of elements in {@code rowHeights}.
*
* @serial
* @see #getLayoutDimensions()
*/
public int[] rowHeights;
/**
* This field holds the overrides to the column weights.
* If this field is non-{@code null} the values are
* applied to the gridbag after all of the columns
* weights have been calculated.
* If {@code columnWeights[i] >} weight for column i, then
* column i is assigned the weight in {@code columnWeights[i]}.
* If {@code columnWeights} has more elements than the number
* of columns, the excess elements are ignored - they do
* not cause more columns to be created.
*
* @serial
*/
public double[] columnWeights;
/**
* This field holds the overrides to the row weights.
* If this field is non-{@code null} the values are
* applied to the gridbag after all of the rows
* weights have been calculated.
* If {@code rowWeights[i] > } weight for row i, then
* row i is assigned the weight in {@code rowWeights[i]}.
* If {@code rowWeights} has more elements than the number
* of rows, the excess elements are ignored - they do
* not cause more rows to be created.
*
* @serial
*/
public double[] rowWeights;
/**
* The component being positioned. This is set before calling into
* {@code adjustForGravity}.
*/
private Component componentAdjusting;
/**
* Creates a grid bag layout manager.
*/
public GridBagLayout () {
comptable = new Hashtable<Component,GridBagConstraints>();
defaultConstraints = new GridBagConstraints();
}
/**
* Sets the constraints for the specified component in this layout.
* @param comp the component to be modified
* @param constraints the constraints to be applied
*/
public void setConstraints(Component comp, GridBagConstraints constraints) {
comptable.put(comp, (GridBagConstraints)constraints.clone());
}
/**
* Gets the constraints for the specified component. A copy of
* the actual {@code GridBagConstraints} object is returned.
* @param comp the component to be queried
* @return the constraint for the specified component in this
* grid bag layout; a copy of the actual constraint
* object is returned
*/
public GridBagConstraints getConstraints(Component comp) {
GridBagConstraints constraints = comptable.get(comp);
if (constraints == null) {
setConstraints(comp, defaultConstraints);
constraints = comptable.get(comp);
}
return (GridBagConstraints)constraints.clone();
}
/**
* Retrieves the constraints for the specified component.
* The return value is not a copy, but is the actual
* {@code GridBagConstraints} object used by the layout mechanism.
* <p>
* If {@code comp} is not in the {@code GridBagLayout},
* a set of default {@code GridBagConstraints} are returned.
* A {@code comp} value of {@code null} is invalid
* and returns {@code null}.
*
* @param comp the component to be queried
* @return the constraints for the specified component
*/
protected GridBagConstraints lookupConstraints(Component comp) {
GridBagConstraints constraints = comptable.get(comp);
if (constraints == null) {
setConstraints(comp, defaultConstraints);
constraints = comptable.get(comp);
}
return constraints;
}
/**
* Removes the constraints for the specified component in this layout
* @param comp the component to be modified
*/
private void removeConstraints(Component comp) {
comptable.remove(comp);
}
/**
* Determines the origin of the layout area, in the graphics coordinate
* space of the target container. This value represents the pixel
* coordinates of the top-left corner of the layout area regardless of
* the {@code ComponentOrientation} value of the container. This
* is distinct from the grid origin given by the cell coordinates (0,0).
* Most applications do not call this method directly.
* @return the graphics origin of the cell in the top-left
* corner of the layout grid
* @see java.awt.ComponentOrientation
* @since 1.1
*/
public Point getLayoutOrigin () {
Point origin = new Point(0,0);
if (layoutInfo != null) {
origin.x = layoutInfo.startx;
origin.y = layoutInfo.starty;
}
return origin;
}
/**
* Determines column widths and row heights for the layout grid.
* <p>
* Most applications do not call this method directly.
* @return an array of two arrays, containing the widths
* of the layout columns and
* the heights of the layout rows
* @since 1.1
*/
public int [][] getLayoutDimensions () {
if (layoutInfo == null)
return new int[2][0];
int[][] dim = new int [2][];
dim[0] = new int[layoutInfo.width];
dim[1] = new int[layoutInfo.height];
System.arraycopy(layoutInfo.minWidth, 0, dim[0], 0, layoutInfo.width);
System.arraycopy(layoutInfo.minHeight, 0, dim[1], 0, layoutInfo.height);
return dim;
}
/**
* Determines the weights of the layout grid's columns and rows.
* Weights are used to calculate how much a given column or row
* stretches beyond its preferred size, if the layout has extra
* room to fill.
* <p>
* Most applications do not call this method directly.
* @return an array of two arrays, representing the
* horizontal weights of the layout columns
* and the vertical weights of the layout rows
* @since 1.1
*/
public double [][] getLayoutWeights () {
if (layoutInfo == null)
return new double[2][0];
double[][] weights = new double [2][];
weights[0] = new double[layoutInfo.width];
weights[1] = new double[layoutInfo.height];
System.arraycopy(layoutInfo.weightX, 0, weights[0], 0, layoutInfo.width);
System.arraycopy(layoutInfo.weightY, 0, weights[1], 0, layoutInfo.height);
return weights;
}
/**
* Determines which cell in the layout grid contains the point
* specified by <code>(x, y)</code>. Each cell is identified
* by its column index (ranging from 0 to the number of columns
* minus 1) and its row index (ranging from 0 to the number of
* rows minus 1).
* <p>
* If the <code>(x, y)</code> point lies
* outside the grid, the following rules are used.
* The column index is returned as zero if {@code x} lies to the
* left of the layout for a left-to-right container or to the right of
* the layout for a right-to-left container. The column index is returned
* as the number of columns if {@code x} lies
* to the right of the layout in a left-to-right container or to the left
* in a right-to-left container.
* The row index is returned as zero if {@code y} lies above the
* layout, and as the number of rows if {@code y} lies
* below the layout. The orientation of a container is determined by its
* {@code ComponentOrientation} property.
* @param x the <i>x</i> coordinate of a point
* @param y the <i>y</i> coordinate of a point
* @return an ordered pair of indexes that indicate which cell
* in the layout grid contains the point
* (<i>x</i>, <i>y</i>).
* @see java.awt.ComponentOrientation
* @since 1.1
*/
public Point location(int x, int y) {
Point loc = new Point(0,0);
int i, d;
if (layoutInfo == null)
return loc;
d = layoutInfo.startx;
if (!rightToLeft) {
for (i=0; i<layoutInfo.width; i++) {
d += layoutInfo.minWidth[i];
if (d > x)
break;
}
} else {
for (i=layoutInfo.width-1; i>=0; i--) {
if (d > x)
break;
d += layoutInfo.minWidth[i];
}
i++;
}
loc.x = i;
d = layoutInfo.starty;
for (i=0; i<layoutInfo.height; i++) {
d += layoutInfo.minHeight[i];
if (d > y)
break;
}
loc.y = i;
return loc;
}
/**
* Has no effect, since this layout manager does not use a per-component string.
*/
public void addLayoutComponent(String name, Component comp) {
}
/**
* Adds the specified component to the layout, using the specified
* {@code constraints} object. Note that constraints
* are mutable and are, therefore, cloned when cached.
*
* @param comp the component to be added
* @param constraints an object that determines how
* the component is added to the layout
* @exception IllegalArgumentException if {@code constraints}
* is not a {@code GridBagConstraint}
*/
public void addLayoutComponent(Component comp, Object constraints) {
if (constraints instanceof GridBagConstraints) {
setConstraints(comp, (GridBagConstraints)constraints);
} else if (constraints != null) {
throw new IllegalArgumentException("cannot add to layout: constraints must be a GridBagConstraint");
}
}
/**
* Removes the specified component from this layout.
* <p>
* Most applications do not call this method directly.
* @param comp the component to be removed.
* @see java.awt.Container#remove(java.awt.Component)
* @see java.awt.Container#removeAll()
*/
public void removeLayoutComponent(Component comp) {
removeConstraints(comp);
}
/**
* Determines the preferred size of the {@code parent}
* container using this grid bag layout.
* <p>
* Most applications do not call this method directly.
*
* @param parent the container in which to do the layout
* @see java.awt.Container#getPreferredSize
* @return the preferred size of the {@code parent}
* container
*/
public Dimension preferredLayoutSize(Container parent) {
GridBagLayoutInfo info = getLayoutInfo(parent, PREFERREDSIZE);
return getMinSize(parent, info);
}
/**
* Determines the minimum size of the {@code parent} container
* using this grid bag layout.
* <p>
* Most applications do not call this method directly.
* @param parent the container in which to do the layout
* @see java.awt.Container#doLayout
* @return the minimum size of the {@code parent} container
*/
public Dimension minimumLayoutSize(Container parent) {
GridBagLayoutInfo info = getLayoutInfo(parent, MINSIZE);
return getMinSize(parent, info);
}
/**
* Returns the maximum dimensions for this layout given the components
* in the specified target container.
* @param target the container which needs to be laid out
* @see Container
* @see #minimumLayoutSize(Container)
* @see #preferredLayoutSize(Container)
* @return the maximum dimensions for this layout
*/
public Dimension maximumLayoutSize(Container target) {
return new Dimension(Integer.MAX_VALUE, Integer.MAX_VALUE);
}
/**
* Returns the alignment along the x axis. This specifies how
* the component would like to be aligned relative to other
* components. The value should be a number between 0 and 1
* where 0 represents alignment along the origin, 1 is aligned
* the furthest away from the origin, 0.5 is centered, etc.
*
* @return the value {@code 0.5f} to indicate centered
*/
public float getLayoutAlignmentX(Container parent) {
return 0.5f;
}
/**
* Returns the alignment along the y axis. This specifies how
* the component would like to be aligned relative to other
* components. The value should be a number between 0 and 1
* where 0 represents alignment along the origin, 1 is aligned
* the furthest away from the origin, 0.5 is centered, etc.
*
* @return the value {@code 0.5f} to indicate centered
*/
public float getLayoutAlignmentY(Container parent) {
return 0.5f;
}
/**
* Invalidates the layout, indicating that if the layout manager
* has cached information it should be discarded.
*/
public void invalidateLayout(Container target) {
}
/**
* Lays out the specified container using this grid bag layout.
* This method reshapes components in the specified container in
* order to satisfy the constraints of this {@code GridBagLayout}
* object.
* <p>
* Most applications do not call this method directly.
* @param parent the container in which to do the layout
* @see java.awt.Container
* @see java.awt.Container#doLayout
*/
public void layoutContainer(Container parent) {
arrangeGrid(parent);
}
/**
* Returns a string representation of this grid bag layout's values.
* @return a string representation of this grid bag layout.
*/
public String toString() {
return getClass().getName();
}
/**
* Print the layout information. Useful for debugging.
*/
/* DEBUG
*
* protected void dumpLayoutInfo(GridBagLayoutInfo s) {
* int x;
*
* System.out.println("Col\tWidth\tWeight");
* for (x=0; x<s.width; x++) {
* System.out.println(x + "\t" +
* s.minWidth[x] + "\t" +
* s.weightX[x]);
* }
* System.out.println("Row\tHeight\tWeight");
* for (x=0; x<s.height; x++) {
* System.out.println(x + "\t" +
* s.minHeight[x] + "\t" +
* s.weightY[x]);
* }
* }
*/
/**
* Print the layout constraints. Useful for debugging.
*/
/* DEBUG
*
* protected void dumpConstraints(GridBagConstraints constraints) {
* System.out.println(
* "wt " +
* constraints.weightx +
* " " +
* constraints.weighty +
* ", " +
*
* "box " +
* constraints.gridx +
* " " +
* constraints.gridy +
* " " +
* constraints.gridwidth +
* " " +
* constraints.gridheight +
* ", " +
*
* "min " +
* constraints.minWidth +
* " " +
* constraints.minHeight +
* ", " +
*
* "pad " +
* constraints.insets.bottom +
* " " +
* constraints.insets.left +
* " " +
* constraints.insets.right +
* " " +
* constraints.insets.top +
* " " +
* constraints.ipadx +
* " " +
* constraints.ipady);
* }
*/
/**
* Fills in an instance of {@code GridBagLayoutInfo} for the
* current set of managed children. This requires three passes through the
* set of children:
*
* <ol>
* <li>Figure out the dimensions of the layout grid.
* <li>Determine which cells the components occupy.
* <li>Distribute the weights and min sizes among the rows/columns.
* </ol>
*
* This also caches the minsizes for all the children when they are
* first encountered (so subsequent loops don't need to ask again).
* <p>
* This method should only be used internally by
* {@code GridBagLayout}.
*
* @param parent the layout container
* @param sizeflag either {@code PREFERREDSIZE} or
* {@code MINSIZE}
* @return the {@code GridBagLayoutInfo} for the set of children
* @since 1.4
*/
protected GridBagLayoutInfo getLayoutInfo(Container parent, int sizeflag) {
return GetLayoutInfo(parent, sizeflag);
}
/*
* Calculate maximum array sizes to allocate arrays without ensureCapacity
* we may use preCalculated sizes in whole class because of upper estimation of
* maximumArrayXIndex and maximumArrayYIndex.
*/
private long[] preInitMaximumArraySizes(Container parent){
Component[] components = parent.getComponents();
Component comp;
GridBagConstraints constraints;
int curX, curY;
int curWidth, curHeight;
int preMaximumArrayXIndex = 0;
int preMaximumArrayYIndex = 0;
long [] returnArray = new long[2];
for (int compId = 0 ; compId < components.length ; compId++) {
comp = components[compId];
if (!comp.isVisible()) {
continue;
}
constraints = lookupConstraints(comp);
curX = constraints.gridx;
curY = constraints.gridy;
curWidth = constraints.gridwidth;
curHeight = constraints.gridheight;
// -1==RELATIVE, means that column|row equals to previously added component,
// since each next Component with gridx|gridy == RELATIVE starts from
// previous position, so we should start from previous component which
// already used in maximumArray[X|Y]Index calculation. We could just increase
// maximum by 1 to handle situation when component with gridx=-1 was added.
if (curX < 0){
curX = ++preMaximumArrayYIndex;
}
if (curY < 0){
curY = ++preMaximumArrayXIndex;
}
// gridwidth|gridheight may be equal to RELATIVE (-1) or REMAINDER (0)
// in any case using 1 instead of 0 or -1 should be sufficient to for
// correct maximumArraySizes calculation
if (curWidth <= 0){
curWidth = 1;
}
if (curHeight <= 0){
curHeight = 1;
}
preMaximumArrayXIndex = Math.max(curY + curHeight, preMaximumArrayXIndex);
preMaximumArrayYIndex = Math.max(curX + curWidth, preMaximumArrayYIndex);
} //for (components) loop
// Must specify index++ to allocate well-working arrays.
/* fix for 4623196.
* now return long array instead of Point
*/
returnArray[0] = preMaximumArrayXIndex;
returnArray[1] = preMaximumArrayYIndex;
return returnArray;
} //PreInitMaximumSizes
/**
* This method is obsolete and supplied for backwards
* compatibility only; new code should call {@link
* #getLayoutInfo(java.awt.Container, int) getLayoutInfo} instead.
*
* Fills in an instance of {@code GridBagLayoutInfo} for the
* current set of managed children. This method is the same
* as {@code getLayoutInfo}; refer to {@code getLayoutInfo}
* description for details.
*
* @param parent the layout container
* @param sizeflag either {@code PREFERREDSIZE} or {@code MINSIZE}
* @return the {@code GridBagLayoutInfo} for the set of children
*/
protected GridBagLayoutInfo GetLayoutInfo(Container parent, int sizeflag) {
synchronized (parent.getTreeLock()) {
GridBagLayoutInfo r;
Component comp;
GridBagConstraints constraints;
Dimension d;
Component[] components = parent.getComponents();
// Code below will address index curX+curWidth in the case of yMaxArray, weightY
// ( respectively curY+curHeight for xMaxArray, weightX ) where
// curX in 0 to preInitMaximumArraySizes.y
// Thus, the maximum index that could
// be calculated in the following code is curX+curX.
// EmpericMultier equals 2 because of this.
int layoutWidth, layoutHeight;
int []xMaxArray;
int []yMaxArray;
int compindex, i, k, px, py, pixels_diff, nextSize;
int curX = 0; // constraints.gridx