source: josm/trunk/src/org/openstreetmap/josm/gui/io/ChangesetManagementPanel.java@ 8308

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

fix potential NPEs and Sonar issues related to serialization
  • Property svn:eol-style set to native
File size: 12.3 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.io;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.awt.Dimension;
7import java.awt.GridBagConstraints;
8import java.awt.GridBagLayout;
9import java.awt.Insets;
10import java.awt.event.ActionEvent;
11import java.awt.event.ItemEvent;
12import java.awt.event.ItemListener;
13import java.util.Collections;
14
15import javax.swing.AbstractAction;
16import javax.swing.BorderFactory;
17import javax.swing.ButtonGroup;
18import javax.swing.JButton;
19import javax.swing.JCheckBox;
20import javax.swing.JPanel;
21import javax.swing.JRadioButton;
22import javax.swing.event.ListDataEvent;
23import javax.swing.event.ListDataListener;
24
25import org.openstreetmap.josm.Main;
26import org.openstreetmap.josm.data.osm.Changeset;
27import org.openstreetmap.josm.data.osm.ChangesetCache;
28import org.openstreetmap.josm.gui.widgets.JMultilineLabel;
29import org.openstreetmap.josm.gui.widgets.JosmComboBox;
30import org.openstreetmap.josm.tools.CheckParameterUtil;
31import org.openstreetmap.josm.tools.ImageProvider;
32
33/**
34 * ChangesetManagementPanel allows to configure changeset to be used in the next
35 * upload.
36 *
37 * It is displayed as one of the configuration panels in the {@link UploadDialog}.
38 *
39 * ChangesetManagementPanel is a source for {@link java.beans.PropertyChangeEvent}s. Clients can listen
40 * to
41 * <ul>
42 * <li>{@link #SELECTED_CHANGESET_PROP} - the new value in the property change event is
43 * the changeset selected by the user. The value is null if the user didn't select a
44 * a changeset or if he chosed to use a new changeset.</li>
45 * <li> {@link #CLOSE_CHANGESET_AFTER_UPLOAD} - the new value is a boolean value indicating
46 * whether the changeset should be closed after the next upload</li>
47 * </ul>
48 */
49public class ChangesetManagementPanel extends JPanel implements ListDataListener{
50 public static final String SELECTED_CHANGESET_PROP = ChangesetManagementPanel.class.getName() + ".selectedChangeset";
51 public static final String CLOSE_CHANGESET_AFTER_UPLOAD = ChangesetManagementPanel.class.getName() + ".closeChangesetAfterUpload";
52
53 private JRadioButton rbUseNew;
54 private JRadioButton rbExisting;
55 private JosmComboBox<Changeset> cbOpenChangesets;
56 private JCheckBox cbCloseAfterUpload;
57 private OpenChangesetComboBoxModel model;
58 private transient ChangesetCommentModel changesetCommentModel;
59
60 /**
61 * builds the GUI
62 */
63 protected void build() {
64 setLayout(new GridBagLayout());
65 GridBagConstraints gc = new GridBagConstraints();
66 setBorder(BorderFactory.createEmptyBorder(3,3,3,3));
67
68 ButtonGroup bgUseNewOrExisting = new ButtonGroup();
69
70 gc.gridwidth = 4;
71 gc.gridx = 0;
72 gc.gridy = 0;
73 gc.fill = GridBagConstraints.HORIZONTAL;
74 gc.weightx = 1.0;
75 gc.weighty = 0.0;
76 gc.insets = new Insets(0, 0, 5, 0);
77 add(new JMultilineLabel(tr("Please decide what changeset the data is uploaded to and whether to close the changeset after the next upload.")), gc);
78
79 gc.gridwidth = 4;
80 gc.gridy = 1;
81 gc.fill = GridBagConstraints.HORIZONTAL;
82 gc.weightx = 1.0;
83 gc.weighty = 0.0;
84 gc.insets = new Insets(0,0,0,0);
85 gc.anchor = GridBagConstraints.FIRST_LINE_START;
86 rbUseNew = new JRadioButton(tr("Upload to a new changeset"));
87 rbUseNew.setToolTipText(tr("Open a new changeset and use it in the next upload"));
88 bgUseNewOrExisting.add(rbUseNew);
89 add(rbUseNew, gc);
90
91 gc.gridx = 0;
92 gc.gridy = 2;
93 gc.gridwidth = 1;
94 gc.weightx = 0.0;
95 gc.fill = GridBagConstraints.HORIZONTAL;
96 rbExisting = new JRadioButton(tr("Upload to an existing changeset"));
97 rbExisting.setToolTipText(tr("Upload data to an already existing and open changeset"));
98 bgUseNewOrExisting.add(rbExisting);
99 add(rbExisting, gc);
100
101 gc.gridx = 1;
102 gc.gridy = 2;
103 gc.gridwidth = 1;
104 gc.weightx = 1.0;
105 model = new OpenChangesetComboBoxModel();
106 ChangesetCache.getInstance().addChangesetCacheListener(model);
107 cbOpenChangesets = new JosmComboBox<>(model);
108 cbOpenChangesets.setToolTipText(tr("Select an open changeset"));
109 cbOpenChangesets.setRenderer(new ChangesetCellRenderer());
110 cbOpenChangesets.addItemListener(new ChangesetListItemStateListener());
111 Dimension d = cbOpenChangesets.getPreferredSize();
112 d.width = 200;
113 cbOpenChangesets.setPreferredSize(d);
114 d.width = 100;
115 cbOpenChangesets.setMinimumSize(d);
116 model.addListDataListener(this);
117 add(cbOpenChangesets, gc);
118
119 gc.gridx = 2;
120 gc.gridy = 2;
121 gc.weightx = 0.0;
122 gc.gridwidth = 1;
123 gc.weightx = 0.0;
124 JButton btnRefresh = new JButton(new RefreshAction());
125 btnRefresh.setMargin(new Insets(0,0,0,0));
126 add(btnRefresh, gc);
127
128 gc.gridx = 3;
129 gc.gridy = 2;
130 gc.gridwidth = 1;
131 CloseChangesetAction closeChangesetAction = new CloseChangesetAction();
132 JButton btnClose = new JButton(closeChangesetAction);
133 btnClose.setMargin(new Insets(0,0,0,0));
134 cbOpenChangesets.addItemListener(closeChangesetAction);
135 rbExisting.addItemListener(closeChangesetAction);
136 add(btnClose, gc);
137
138 gc.gridx = 0;
139 gc.gridy = 3;
140 gc.gridwidth = 4;
141 gc.weightx = 1.0;
142 cbCloseAfterUpload = new JCheckBox(tr("Close changeset after upload"));
143 cbCloseAfterUpload.setToolTipText(tr("Select to close the changeset after the next upload"));
144 add(cbCloseAfterUpload, gc);
145 cbCloseAfterUpload.setSelected(Main.pref.getBoolean("upload.changeset.close", true));
146 cbCloseAfterUpload.addItemListener(new CloseAfterUploadItemStateListener());
147
148 gc.gridx = 0;
149 gc.gridy = 5;
150 gc.gridwidth = 4;
151 gc.weightx = 1.0;
152 gc.weighty = 1.0;
153 gc.fill = GridBagConstraints.BOTH;
154 add(new JPanel(), gc);
155
156 rbUseNew.getModel().addItemListener(new RadioButtonHandler());
157 rbExisting.getModel().addItemListener(new RadioButtonHandler());
158 }
159
160 /**
161 * Creates a new panel
162 *
163 * @param changesetCommentModel the changeset comment model. Must not be null.
164 * @throws IllegalArgumentException if {@code changesetCommentModel} is null
165 */
166 public ChangesetManagementPanel(ChangesetCommentModel changesetCommentModel) {
167 CheckParameterUtil.ensureParameterNotNull(changesetCommentModel, "changesetCommentModel");
168 this.changesetCommentModel = changesetCommentModel;
169 build();
170 refreshGUI();
171 }
172
173 protected void refreshGUI() {
174 rbExisting.setEnabled(model.getSize() > 0);
175 if (model.getSize() == 0) {
176 if (!rbUseNew.isSelected()) {
177 rbUseNew.setSelected(true);
178 }
179 }
180 cbOpenChangesets.setEnabled(model.getSize() > 0 && rbExisting.isSelected());
181 }
182
183 /**
184 * Sets the changeset to be used in the next upload
185 *
186 * @param cs the changeset
187 */
188 public void setSelectedChangesetForNextUpload(Changeset cs) {
189 int idx = model.getIndexOf(cs);
190 if (idx >=0) {
191 rbExisting.setSelected(true);
192 model.setSelectedItem(cs);
193 }
194 }
195
196 /**
197 * Replies the currently selected changeset. null, if no changeset is
198 * selected or if the user has chosen to use a new changeset.
199 *
200 * @return the currently selected changeset. null, if no changeset is
201 * selected.
202 */
203 public Changeset getSelectedChangeset() {
204 if (rbUseNew.isSelected())
205 return null;
206 return (Changeset)cbOpenChangesets.getSelectedItem();
207 }
208
209 /**
210 * Determines if the user has chosen to close the changeset after the next upload.
211 * @return {@code true} if the user has chosen to close the changeset after the next upload
212 */
213 public boolean isCloseChangesetAfterUpload() {
214 return cbCloseAfterUpload.isSelected();
215 }
216
217 /* ---------------------------------------------------------------------------- */
218 /* Interface ListDataListener */
219 /* ---------------------------------------------------------------------------- */
220 @Override
221 public void contentsChanged(ListDataEvent e) {
222 refreshGUI();
223 }
224
225 @Override
226 public void intervalAdded(ListDataEvent e) {
227 refreshGUI();
228 }
229
230 @Override
231 public void intervalRemoved(ListDataEvent e) {
232 refreshGUI();
233 }
234
235 /**
236 * Listens to changes in the selected changeset and fires property
237 * change events.
238 *
239 */
240 class ChangesetListItemStateListener implements ItemListener {
241 @Override
242 public void itemStateChanged(ItemEvent e) {
243 Changeset cs = (Changeset)cbOpenChangesets.getSelectedItem();
244 if (cs == null) return;
245 if (rbExisting.isSelected()) {
246 firePropertyChange(SELECTED_CHANGESET_PROP, null, cs);
247 }
248 }
249 }
250
251 /**
252 * Listens to changes in "close after upload" flag and fires
253 * property change events.
254 *
255 */
256 class CloseAfterUploadItemStateListener implements ItemListener {
257 @Override
258 public void itemStateChanged(ItemEvent e) {
259 if (e.getItemSelectable() != cbCloseAfterUpload)
260 return;
261 switch(e.getStateChange()) {
262 case ItemEvent.SELECTED:
263 firePropertyChange(CLOSE_CHANGESET_AFTER_UPLOAD, false, true);
264 Main.pref.put("upload.changeset.close", true);
265 break;
266 case ItemEvent.DESELECTED:
267 firePropertyChange(CLOSE_CHANGESET_AFTER_UPLOAD, true, false);
268 Main.pref.put("upload.changeset.close", false);
269 break;
270 }
271 }
272 }
273
274 /**
275 * Listens to changes in the two radio buttons rbUseNew and rbUseExisting.
276 *
277 */
278 class RadioButtonHandler implements ItemListener {
279 @Override
280 public void itemStateChanged(ItemEvent e) {
281 if (rbUseNew.isSelected()) {
282 cbOpenChangesets.setEnabled(false);
283 firePropertyChange(SELECTED_CHANGESET_PROP, null, null);
284 } else if (rbExisting.isSelected()) {
285 cbOpenChangesets.setEnabled(true);
286 if (cbOpenChangesets.getSelectedItem() == null) {
287 model.selectFirstChangeset();
288 }
289 Changeset cs = (Changeset)cbOpenChangesets.getSelectedItem();
290 if (cs == null) return;
291 changesetCommentModel.setComment(cs.get("comment"));
292 firePropertyChange(SELECTED_CHANGESET_PROP, null, cs);
293 }
294 }
295 }
296
297 /**
298 * Refreshes the list of open changesets
299 *
300 */
301 class RefreshAction extends AbstractAction {
302 public RefreshAction() {
303 putValue(SHORT_DESCRIPTION, tr("Load the list of your open changesets from the server"));
304 putValue(SMALL_ICON, ImageProvider.get("dialogs", "refresh"));
305 }
306
307 @Override
308 public void actionPerformed(ActionEvent e) {
309 DownloadOpenChangesetsTask task = new DownloadOpenChangesetsTask(ChangesetManagementPanel.this);
310 Main.worker.submit(task);
311 }
312 }
313
314 /**
315 * Closes the currently selected changeset
316 *
317 */
318 class CloseChangesetAction extends AbstractAction implements ItemListener{
319 public CloseChangesetAction() {
320 putValue(SMALL_ICON, ImageProvider.get("closechangeset"));
321 putValue(SHORT_DESCRIPTION, tr("Close the currently selected open changeset"));
322 refreshEnabledState();
323 }
324
325 @Override
326 public void actionPerformed(ActionEvent e) {
327 Changeset cs = (Changeset)cbOpenChangesets.getSelectedItem();
328 if (cs == null) return;
329 CloseChangesetTask task = new CloseChangesetTask(Collections.singletonList(cs));
330 Main.worker.submit(task);
331 }
332
333 protected void refreshEnabledState() {
334 setEnabled(
335 cbOpenChangesets.getModel().getSize() > 0
336 && cbOpenChangesets.getSelectedItem() != null
337 && rbExisting.isSelected()
338 );
339 }
340
341 @Override
342 public void itemStateChanged(ItemEvent e) {
343 refreshEnabledState();
344 }
345 }
346}
Note: See TracBrowser for help on using the repository browser.