source: josm/trunk/src/org/openstreetmap/josm/gui/dialogs/DialogsPanel.java@ 8510

Last change on this file since 8510 was 8510, checked in by Don-vip, 10 years ago

checkstyle: enable relevant whitespace checks and fix them
  • Property svn:eol-style set to native
File size: 11.4 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.dialogs;
3
4import java.awt.Dimension;
5import java.util.ArrayList;
6import java.util.List;
7
8import javax.swing.BoxLayout;
9import javax.swing.JPanel;
10import javax.swing.JSplitPane;
11
12import org.openstreetmap.josm.gui.widgets.MultiSplitLayout.Divider;
13import org.openstreetmap.josm.gui.widgets.MultiSplitLayout.Leaf;
14import org.openstreetmap.josm.gui.widgets.MultiSplitLayout.Node;
15import org.openstreetmap.josm.gui.widgets.MultiSplitLayout.Split;
16import org.openstreetmap.josm.gui.widgets.MultiSplitPane;
17import org.openstreetmap.josm.tools.CheckParameterUtil;
18import org.openstreetmap.josm.tools.Destroyable;
19
20public class DialogsPanel extends JPanel implements Destroyable {
21 protected List<ToggleDialog> allDialogs = new ArrayList<>();
22 protected MultiSplitPane mSpltPane = new MultiSplitPane();
23 protected static final int DIVIDER_SIZE = 5;
24
25 /**
26 * Panels that are added to the multisplitpane.
27 */
28 private List<JPanel> panels = new ArrayList<>();
29
30 private final JSplitPane parent;
31
32 public DialogsPanel(JSplitPane parent) {
33 this.parent = parent;
34 }
35
36 public boolean initialized = false; // read only from outside
37
38 public void initialize(List<ToggleDialog> pAllDialogs) {
39 if (initialized)
40 throw new IllegalStateException();
41 initialized = true;
42 allDialogs = new ArrayList<>();
43
44 for (ToggleDialog dialog: pAllDialogs) {
45 add(dialog, false);
46 }
47
48 this.add(mSpltPane);
49 reconstruct(Action.ELEMENT_SHRINKS, null);
50 }
51
52 public void add(ToggleDialog dlg) {
53 add(dlg, true);
54 }
55
56 public void add(ToggleDialog dlg, boolean doReconstruct) {
57 allDialogs.add(dlg);
58 int i = allDialogs.size() - 1;
59 dlg.setDialogsPanel(this);
60 dlg.setVisible(false);
61 final JPanel p = new JPanel() {
62 /**
63 * Honoured by the MultiSplitPaneLayout when the
64 * entire Window is resized.
65 */
66 @Override
67 public Dimension getMinimumSize() {
68 return new Dimension(0, 40);
69 }
70 };
71 p.setLayout(new BoxLayout(p, BoxLayout.Y_AXIS));
72 p.setVisible(false);
73
74 mSpltPane.add(p, "L"+i);
75 panels.add(p);
76
77 if (dlg.isDialogShowing()) {
78 dlg.showDialog();
79 if (dlg.isDialogInCollapsedView()) {
80 dlg.isCollapsed = false; // pretend to be in Default view, this will be set back by collapse()
81 dlg.collapse();
82 }
83 if (doReconstruct) {
84 reconstruct(Action.INVISIBLE_TO_DEFAULT, dlg);
85 }
86 dlg.showNotify();
87 } else {
88 dlg.hideDialog();
89 }
90 }
91
92 /**
93 * What action was performed to trigger the reconstruction
94 */
95 public enum Action {
96 INVISIBLE_TO_DEFAULT,
97 COLLAPSED_TO_DEFAULT,
98 /* INVISIBLE_TO_COLLAPSED, does not happen */
99 ELEMENT_SHRINKS /* else. (Remaining elements have more space.) */
100 }
101 /**
102 * Reconstruct the view, if the configurations of dialogs has changed.
103 * @param action what happened, so the reconstruction is necessary
104 * @param triggeredBy the dialog that caused the reconstruction
105 */
106 public void reconstruct(Action action, ToggleDialog triggeredBy) {
107
108 final int N = allDialogs.size();
109
110 /**
111 * reset the panels
112 */
113 for (JPanel p: panels) {
114 p.removeAll();
115 p.setVisible(false);
116 }
117
118 /**
119 * Add the elements to their respective panel.
120 *
121 * Each panel contains one dialog in default view and zero or more
122 * collapsed dialogs on top of it. The last panel is an exception
123 * as it can have collapsed dialogs at the bottom as well.
124 * If there are no dialogs in default view, show the collapsed ones
125 * in the last panel anyway.
126 */
127 JPanel p = panels.get(N-1); // current Panel (start with last one)
128 int k = -1; // indicates that the current Panel index is N-1, but no default-view-Dialog has been added to this Panel yet.
129 for (int i = N-1; i >= 0; --i) {
130 final ToggleDialog dlg = allDialogs.get(i);
131 if (dlg.isDialogInDefaultView()) {
132 if (k == -1) {
133 k = N-1;
134 } else {
135 --k;
136 p = panels.get(k);
137 }
138 p.add(dlg, 0);
139 p.setVisible(true);
140 } else if (dlg.isDialogInCollapsedView()) {
141 p.add(dlg, 0);
142 p.setVisible(true);
143 }
144 }
145
146 if (k == -1) {
147 k = N-1;
148 }
149 final int numPanels = N - k;
150
151 /**
152 * Determine the panel geometry
153 */
154 if (action == Action.ELEMENT_SHRINKS) {
155 for (int i = 0; i < N; ++i) {
156 final ToggleDialog dlg = allDialogs.get(i);
157 if (dlg.isDialogInDefaultView()) {
158 final int ph = dlg.getPreferredHeight();
159 final int ah = dlg.getSize().height;
160 dlg.setPreferredSize(new Dimension(Integer.MAX_VALUE, ah < 20 ? ph : ah));
161 }
162 }
163 } else {
164 CheckParameterUtil.ensureParameterNotNull(triggeredBy, "triggeredBy");
165
166 int sumP = 0; // sum of preferred heights of dialogs in default view (without the triggering dialog)
167 int sumA = 0; // sum of actual heights of dialogs in default view (without the triggering dialog)
168 int sumC = 0; // sum of heights of all collapsed dialogs (triggering dialog is never collapsed)
169
170 for (ToggleDialog dlg: allDialogs) {
171 if (dlg.isDialogInDefaultView()) {
172 if (dlg != triggeredBy) {
173 sumP += dlg.getPreferredHeight();
174 sumA += dlg.getHeight();
175 }
176 } else if (dlg.isDialogInCollapsedView()) {
177 sumC += dlg.getHeight();
178 }
179 }
180
181 /**
182 * If we add additional dialogs on startup (e.g. geoimage), they may
183 * not have an actual height yet.
184 * In this case we simply reset everything to it's preferred size.
185 */
186 if (sumA == 0) {
187 reconstruct(Action.ELEMENT_SHRINKS, null);
188 return;
189 }
190
191 /** total Height */
192 final int H = mSpltPane.getMultiSplitLayout().getModel().getBounds().getSize().height;
193
194 /** space, that is available for dialogs in default view (after the reconfiguration) */
195 final int s2 = H - (numPanels - 1) * DIVIDER_SIZE - sumC;
196
197 final int hp_trig = triggeredBy.getPreferredHeight();
198 if (hp_trig <= 0) throw new IllegalStateException(); // Must be positive
199
200 /** The new dialog gets a fair share */
201 final int hn_trig = hp_trig * s2 / (hp_trig + sumP);
202 triggeredBy.setPreferredSize(new Dimension(Integer.MAX_VALUE, hn_trig));
203
204 /** This is remainig for the other default view dialogs */
205 final int R = s2 - hn_trig;
206
207 /**
208 * Take space only from dialogs that are relatively large
209 */
210 int D_m = 0; // additional space needed by the small dialogs
211 int D_p = 0; // available space from the large dialogs
212 for (int i = 0; i < N; ++i) {
213 final ToggleDialog dlg = allDialogs.get(i);
214 if (dlg.isDialogInDefaultView() && dlg != triggeredBy) {
215 final int ha = dlg.getSize().height; // current
216 final int h0 = ha * R / sumA; // proportional shrinking
217 final int he = dlg.getPreferredHeight() * s2 / (sumP + hp_trig); // fair share
218 if (h0 < he) { // dialog is relatively small
219 int hn = Math.min(ha, he); // shrink less, but do not grow
220 D_m += hn - h0;
221 } else { // dialog is relatively large
222 D_p += h0 - he;
223 }
224 }
225 }
226 /** adjust, without changing the sum */
227 for (int i = 0; i < N; ++i) {
228 final ToggleDialog dlg = allDialogs.get(i);
229 if (dlg.isDialogInDefaultView() && dlg != triggeredBy) {
230 final int ha = dlg.getHeight();
231 final int h0 = ha * R / sumA;
232 final int he = dlg.getPreferredHeight() * s2 / (sumP + hp_trig);
233 if (h0 < he) {
234 int hn = Math.min(ha, he);
235 dlg.setPreferredSize(new Dimension(Integer.MAX_VALUE, hn));
236 } else {
237 int d;
238 try {
239 d = (h0-he) * D_m / D_p;
240 } catch (ArithmeticException e) { /* D_p may be zero - nothing wrong with that. */
241 d = 0;
242 }
243 dlg.setPreferredSize(new Dimension(Integer.MAX_VALUE, h0 - d));
244 }
245 }
246 }
247 }
248
249 /**
250 * create Layout
251 */
252 final List<Node> ch = new ArrayList<>();
253
254 for (int i = k; i <= N-1; ++i) {
255 if (i != k) {
256 ch.add(new Divider());
257 }
258 Leaf l = new Leaf("L"+i);
259 l.setWeight(1.0 / numPanels);
260 ch.add(l);
261 }
262
263 if (numPanels == 1) {
264 Node model = ch.get(0);
265 mSpltPane.getMultiSplitLayout().setModel(model);
266 } else {
267 Split model = new Split();
268 model.setRowLayout(false);
269 model.setChildren(ch);
270 mSpltPane.getMultiSplitLayout().setModel(model);
271 }
272
273 mSpltPane.getMultiSplitLayout().setDividerSize(DIVIDER_SIZE);
274 mSpltPane.getMultiSplitLayout().setFloatingDividers(true);
275 mSpltPane.revalidate();
276
277 /**
278 * Hide the Panel, if there is nothing to show
279 */
280 if (numPanels == 1 && panels.get(N-1).getComponents().length == 0) {
281 parent.setDividerSize(0);
282 this.setVisible(false);
283 } else {
284 if (this.getWidth() != 0) { // only if josm started with hidden panel
285 this.setPreferredSize(new Dimension(this.getWidth(), 0));
286 }
287 this.setVisible(true);
288 parent.setDividerSize(5);
289 parent.resetToPreferredSizes();
290 }
291 }
292
293 @Override
294 public void destroy() {
295 for (ToggleDialog t : allDialogs) {
296 t.destroy();
297 }
298 }
299
300 /**
301 * Replies the instance of a toggle dialog of type <code>type</code> managed by this
302 * map frame
303 *
304 * @param <T> toggle dialog type
305 * @param type the class of the toggle dialog, i.e. UserListDialog.class
306 * @return the instance of a toggle dialog of type <code>type</code> managed by this
307 * map frame; null, if no such dialog exists
308 *
309 */
310 public <T> T getToggleDialog(Class<T> type) {
311 for (ToggleDialog td : allDialogs) {
312 if (type.isInstance(td))
313 return type.cast(td);
314 }
315 return null;
316 }
317}
Note: See TracBrowser for help on using the repository browser.