source: josm/trunk/src/org/openstreetmap/josm/gui/dialogs/RelationListDialog.java@ 6038

Last change on this file since 6038 was 6038, checked in by akks, 11 years ago

fix #8829: relation was often hanging JOSM after 6036 + better highlighting
  • Property svn:eol-style set to native
File size: 25.2 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.dialogs;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.awt.BorderLayout;
7import java.awt.Color;
8import java.awt.Component;
9import java.awt.event.ActionEvent;
10import java.awt.event.KeyEvent;
11import java.awt.event.MouseEvent;
12import java.util.ArrayList;
13import java.util.Arrays;
14import java.util.Collection;
15import java.util.Collections;
16import java.util.HashSet;
17import java.util.List;
18import java.util.Set;
19
20import javax.swing.AbstractAction;
21import javax.swing.AbstractListModel;
22import javax.swing.DefaultListSelectionModel;
23import javax.swing.FocusManager;
24import javax.swing.JComponent;
25import javax.swing.JList;
26import javax.swing.JPanel;
27import javax.swing.JPopupMenu;
28import javax.swing.JScrollPane;
29import javax.swing.KeyStroke;
30import javax.swing.ListSelectionModel;
31import javax.swing.UIManager;
32import javax.swing.event.DocumentEvent;
33import javax.swing.event.DocumentListener;
34import javax.swing.event.ListSelectionEvent;
35import javax.swing.event.ListSelectionListener;
36
37import org.openstreetmap.josm.Main;
38import org.openstreetmap.josm.actions.relation.AddSelectionToRelations;
39import org.openstreetmap.josm.actions.relation.DeleteRelationsAction;
40import org.openstreetmap.josm.actions.relation.DownloadMembersAction;
41import org.openstreetmap.josm.actions.relation.DownloadSelectedIncompleteMembersAction;
42import org.openstreetmap.josm.actions.relation.DuplicateRelationAction;
43import org.openstreetmap.josm.actions.relation.EditRelationAction;
44import org.openstreetmap.josm.actions.relation.SelectMembersAction;
45import org.openstreetmap.josm.actions.relation.SelectRelationAction;
46import org.openstreetmap.josm.actions.search.SearchCompiler;
47import org.openstreetmap.josm.data.osm.DataSet;
48import org.openstreetmap.josm.data.osm.OsmPrimitive;
49import org.openstreetmap.josm.data.osm.Relation;
50import org.openstreetmap.josm.data.osm.event.AbstractDatasetChangedEvent;
51import org.openstreetmap.josm.data.osm.event.DataChangedEvent;
52import org.openstreetmap.josm.data.osm.event.DataSetListener;
53import org.openstreetmap.josm.data.osm.event.DatasetEventManager;
54import org.openstreetmap.josm.data.osm.event.DatasetEventManager.FireMode;
55import org.openstreetmap.josm.data.osm.event.NodeMovedEvent;
56import org.openstreetmap.josm.data.osm.event.PrimitivesAddedEvent;
57import org.openstreetmap.josm.data.osm.event.PrimitivesRemovedEvent;
58import org.openstreetmap.josm.data.osm.event.RelationMembersChangedEvent;
59import org.openstreetmap.josm.data.osm.event.TagsChangedEvent;
60import org.openstreetmap.josm.data.osm.event.WayNodesChangedEvent;
61import org.openstreetmap.josm.gui.DefaultNameFormatter;
62import org.openstreetmap.josm.gui.MapView;
63import org.openstreetmap.josm.gui.MapView.LayerChangeListener;
64import org.openstreetmap.josm.gui.OsmPrimitivRenderer;
65import org.openstreetmap.josm.gui.PopupMenuHandler;
66import org.openstreetmap.josm.gui.SideButton;
67import org.openstreetmap.josm.gui.dialogs.relation.RelationEditor;
68import org.openstreetmap.josm.gui.layer.Layer;
69import org.openstreetmap.josm.gui.layer.OsmDataLayer;
70import org.openstreetmap.josm.gui.util.HighlightHelper;
71import org.openstreetmap.josm.gui.widgets.DisableShortcutsOnFocusGainedTextField;
72import org.openstreetmap.josm.gui.widgets.JosmTextField;
73import org.openstreetmap.josm.gui.widgets.PopupMenuLauncher;
74import org.openstreetmap.josm.tools.ImageProvider;
75import org.openstreetmap.josm.tools.InputMapUtils;
76import org.openstreetmap.josm.tools.Predicate;
77import org.openstreetmap.josm.tools.Shortcut;
78import org.openstreetmap.josm.tools.Utils;
79
80/**
81 * A dialog showing all known relations, with buttons to add, edit, and
82 * delete them.
83 *
84 * We don't have such dialogs for nodes, segments, and ways, because those
85 * objects are visible on the map and can be selected there. Relations are not.
86 */
87public class RelationListDialog extends ToggleDialog implements DataSetListener {
88 /** The display list. */
89 private final JList displaylist;
90 /** the list model used */
91 private final RelationListModel model;
92
93 private final NewAction newAction;
94
95 /** the popup menu and its handler */
96 private final JPopupMenu popupMenu = new JPopupMenu();
97 private final PopupMenuHandler popupMenuHandler = new PopupMenuHandler(popupMenu);
98
99 private final JosmTextField filter;
100
101 // Actions
102 /** the edit action */
103 private final EditRelationAction editAction = new EditRelationAction();
104 /** the delete action */
105 private final DeleteRelationsAction deleteRelationsAction = new DeleteRelationsAction();
106 /** the duplicate action */
107 private final DuplicateRelationAction duplicateAction = new DuplicateRelationAction();
108 private final DownloadMembersAction downloadMembersAction = new DownloadMembersAction();
109 private final DownloadSelectedIncompleteMembersAction downloadSelectedIncompleteMembersAction = new DownloadSelectedIncompleteMembersAction();
110 private final SelectMembersAction selectMembersAction = new SelectMembersAction(false);
111 private final SelectMembersAction addMembersToSelectionAction = new SelectMembersAction(true);
112 private final SelectRelationAction selectRelationAction = new SelectRelationAction(false);
113 private final SelectRelationAction addRelationToSelectionAction = new SelectRelationAction(true);
114 /** add all selected primitives to the given relations */
115 private final AddSelectionToRelations addSelectionToRelations = new AddSelectionToRelations();
116
117 HighlightHelper highlightHelper = new HighlightHelper();
118
119 /**
120 * Constructs <code>RelationListDialog</code>
121 */
122 public RelationListDialog() {
123 super(tr("Relations"), "relationlist", tr("Open a list of all relations."),
124 Shortcut.registerShortcut("subwindow:relations", tr("Toggle: {0}", tr("Relations")),
125 KeyEvent.VK_R, Shortcut.ALT_SHIFT), 150);
126
127 // create the list of relations
128 //
129 DefaultListSelectionModel selectionModel = new DefaultListSelectionModel();
130 model = new RelationListModel(selectionModel);
131 displaylist = new JList(model);
132 displaylist.setSelectionModel(selectionModel);
133 displaylist.setCellRenderer(new OsmPrimitivRenderer() {
134 /**
135 * Don't show the default tooltip in the relation list.
136 */
137 @Override
138 protected String getComponentToolTipText(OsmPrimitive value) {
139 return null;
140 }
141 });
142 displaylist.setSelectionMode(ListSelectionModel.MULTIPLE_INTERVAL_SELECTION);
143 displaylist.addMouseListener(new MouseEventHandler());
144
145 // the new action
146 //
147 newAction = new NewAction();
148
149 filter = setupFilter();
150
151 displaylist.addListSelectionListener(new ListSelectionListener() {
152 @Override
153 public void valueChanged(ListSelectionEvent e) {
154 updateActionsRelationLists();
155 }
156 });
157
158 // Setup popup menu handler
159 setupPopupMenuHandler();
160
161 JPanel pane = new JPanel(new BorderLayout());
162 pane.add(filter, BorderLayout.NORTH);
163 pane.add(new JScrollPane(displaylist), BorderLayout.CENTER);
164 createLayout(pane, false, Arrays.asList(new SideButton[]{
165 new SideButton(newAction, false),
166 new SideButton(editAction, false),
167 new SideButton(duplicateAction, false),
168 new SideButton(deleteRelationsAction, false),
169 new SideButton(selectRelationAction, false)
170 }));
171
172 // activate DEL in the list of relations
173 //displaylist.getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_DELETE,0), "deleteRelation");
174 //displaylist.getActionMap().put("deleteRelation", deleteAction);
175
176 InputMapUtils.unassignCtrlShiftUpDown(displaylist, JComponent.WHEN_FOCUSED);
177
178 // Select relation on Ctrl-Enter
179 InputMapUtils.addEnterAction(displaylist, selectRelationAction);
180
181 // Edit relation on Ctrl-Enter
182 displaylist.getActionMap().put("edit", editAction);
183 displaylist.getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_ENTER, KeyEvent.CTRL_MASK), "edit");
184
185 updateActionsRelationLists();
186 }
187
188 // inform all actions about list of relations they need
189 private void updateActionsRelationLists() {
190 List<Relation> sel = model.getSelectedRelations();
191 popupMenuHandler.setPrimitives(sel);
192
193 Component focused = FocusManager.getCurrentKeyboardFocusManager().getFocusOwner();
194
195 //update highlights
196 if (focused==displaylist && Main.isDisplayingMapView()) {
197 if (highlightHelper.highlightOnly(sel)) {
198 Main.map.mapView.repaint();
199 }
200 }
201 }
202
203 @Override public void showNotify() {
204 MapView.addLayerChangeListener(newAction);
205 newAction.updateEnabledState();
206 DatasetEventManager.getInstance().addDatasetListener(this, FireMode.IN_EDT);
207 DataSet.addSelectionListener(addSelectionToRelations);
208 dataChanged(null);
209 }
210
211 @Override public void hideNotify() {
212 MapView.removeLayerChangeListener(newAction);
213 DatasetEventManager.getInstance().removeDatasetListener(this);
214 DataSet.removeSelectionListener(addSelectionToRelations);
215 }
216
217 private void resetFilter() {
218 filter.setText(null);
219 }
220
221 /**
222 * Initializes the relation list dialog from a layer. If <code>layer</code> is null
223 * or if it isn't an {@link OsmDataLayer} the dialog is reset to an empty dialog.
224 * Otherwise it is initialized with the list of non-deleted and visible relations
225 * in the layer's dataset.
226 *
227 * @param layer the layer. May be null.
228 */
229 protected void initFromLayer(Layer layer) {
230 if (layer == null || ! (layer instanceof OsmDataLayer)) {
231 model.setRelations(null);
232 return;
233 }
234 OsmDataLayer l = (OsmDataLayer)layer;
235 model.setRelations(l.data.getRelations());
236 model.updateTitle();
237 updateActionsRelationLists();
238 }
239
240 /**
241 * @return The selected relation in the list
242 */
243 private Relation getSelected() {
244 if(model.getSize() == 1) {
245 displaylist.setSelectedIndex(0);
246 }
247 return (Relation) displaylist.getSelectedValue();
248 }
249
250 /**
251 * Selects the relation <code>relation</code> in the list of relations.
252 *
253 * @param relation the relation
254 */
255 public void selectRelation(Relation relation) {
256 selectRelations(Collections.singleton(relation));
257 }
258
259 /**
260 * Selects the relations in the list of relations.
261 * @param relations the relations to be selected
262 */
263 public void selectRelations(Collection<Relation> relations) {
264 if (relations == null || relations.isEmpty()) {
265 model.setSelectedRelations(null);
266 } else {
267 model.setSelectedRelations(relations);
268 Integer i = model.getVisibleRelationIndex(relations.iterator().next());
269 if (i != null) { // Not all relations have to be in the list (for example when the relation list is hidden, it's not updated with new relations)
270 displaylist.scrollRectToVisible(displaylist.getCellBounds(i, i));
271 }
272 }
273 }
274
275 private JosmTextField setupFilter() {
276 final JosmTextField f = new DisableShortcutsOnFocusGainedTextField();
277 f.setToolTipText(tr("Relation list filter"));
278 f.getDocument().addDocumentListener(new DocumentListener() {
279
280 private void setFilter() {
281 try {
282 f.setBackground(UIManager.getColor("TextField.background"));
283 f.setToolTipText(tr("Relation list filter"));
284 model.setFilter(SearchCompiler.compile(filter.getText(), false, false));
285 } catch (SearchCompiler.ParseError ex) {
286 f.setBackground(new Color(255, 224, 224));
287 f.setToolTipText(ex.getMessage());
288 model.setFilter(new SearchCompiler.Always());
289 }
290 }
291
292 @Override
293 public void insertUpdate(DocumentEvent e) {
294 setFilter();
295 }
296
297 @Override
298 public void removeUpdate(DocumentEvent e) {
299 setFilter();
300 }
301
302 @Override
303 public void changedUpdate(DocumentEvent e) {
304 setFilter();
305 }
306 });
307 return f;
308 }
309
310 class MouseEventHandler extends PopupMenuLauncher {
311
312 public MouseEventHandler() {
313 super(popupMenu);
314 }
315
316 @Override
317 public void mouseExited(MouseEvent me) {
318 highlightHelper.clear();
319 }
320
321 protected void setCurrentRelationAsSelection() {
322 Main.main.getCurrentDataSet().setSelected((Relation)displaylist.getSelectedValue());
323 }
324
325 protected void editCurrentRelation() {
326 EditRelationAction.launchEditor(getSelected());
327 }
328
329 @Override public void mouseClicked(MouseEvent e) {
330 if (Main.main.getEditLayer() == null) return;
331 if (isDoubleClick(e)) {
332 if (e.isControlDown()) {
333 editCurrentRelation();
334 } else {
335 setCurrentRelationAsSelection();
336 }
337 }
338 }
339 }
340
341 /**
342 * The action for creating a new relation
343 *
344 */
345 static class NewAction extends AbstractAction implements LayerChangeListener{
346 public NewAction() {
347 putValue(SHORT_DESCRIPTION,tr("Create a new relation"));
348 putValue(NAME, tr("New"));
349 putValue(SMALL_ICON, ImageProvider.get("dialogs", "addrelation"));
350 updateEnabledState();
351 }
352
353 public void run() {
354 RelationEditor.getEditor(Main.main.getEditLayer(),null, null).setVisible(true);
355 }
356
357 @Override
358 public void actionPerformed(ActionEvent e) {
359 run();
360 }
361
362 protected void updateEnabledState() {
363 setEnabled(Main.main != null && Main.main.getEditLayer() != null);
364 }
365
366 @Override
367 public void activeLayerChange(Layer oldLayer, Layer newLayer) {
368 updateEnabledState();
369 }
370
371 @Override
372 public void layerAdded(Layer newLayer) {
373 updateEnabledState();
374 }
375
376 @Override
377 public void layerRemoved(Layer oldLayer) {
378 updateEnabledState();
379 }
380 }
381
382 /**
383 * The list model for the list of relations displayed in the relation list
384 * dialog.
385 *
386 */
387 private class RelationListModel extends AbstractListModel {
388 private final ArrayList<Relation> relations = new ArrayList<Relation>();
389 private ArrayList<Relation> filteredRelations;
390 private DefaultListSelectionModel selectionModel;
391 private SearchCompiler.Match filter;
392
393 public RelationListModel(DefaultListSelectionModel selectionModel) {
394 this.selectionModel = selectionModel;
395 }
396
397 public Relation getRelation(int idx) {
398 return relations.get(idx);
399 }
400
401 public void sort() {
402 Collections.sort(
403 relations,
404 DefaultNameFormatter.getInstance().getRelationComparator()
405 );
406 }
407
408 private boolean isValid(Relation r) {
409 return !r.isDeleted() && r.isVisible() && !r.isIncomplete();
410 }
411
412 public void setRelations(Collection<Relation> relations) {
413 List<Relation> sel = getSelectedRelations();
414 this.relations.clear();
415 this.filteredRelations = null;
416 if (relations == null) {
417 selectionModel.clearSelection();
418 fireContentsChanged(this,0,getSize());
419 return;
420 }
421 for (Relation r: relations) {
422 if (isValid(r)) {
423 this.relations.add(r);
424 }
425 }
426 sort();
427 updateFilteredRelations();
428 fireIntervalAdded(this, 0, getSize());
429 setSelectedRelations(sel);
430 }
431
432 /**
433 * Add all relations in <code>addedPrimitives</code> to the model for the
434 * relation list dialog
435 *
436 * @param addedPrimitives the collection of added primitives. May include nodes,
437 * ways, and relations.
438 */
439 public void addRelations(Collection<? extends OsmPrimitive> addedPrimitives) {
440 boolean added = false;
441 for (OsmPrimitive p: addedPrimitives) {
442 if (! (p instanceof Relation)) {
443 continue;
444 }
445
446 Relation r = (Relation)p;
447 if (relations.contains(r)) {
448 continue;
449 }
450 if (isValid(r)) {
451 relations.add(r);
452 added = true;
453 }
454 }
455 if (added) {
456 List<Relation> sel = getSelectedRelations();
457 sort();
458 updateFilteredRelations();
459 fireIntervalAdded(this, 0, getSize());
460 setSelectedRelations(sel);
461 }
462 }
463
464 /**
465 * Removes all relations in <code>removedPrimitives</code> from the model
466 *
467 * @param removedPrimitives the removed primitives. May include nodes, ways,
468 * and relations
469 */
470 public void removeRelations(Collection<? extends OsmPrimitive> removedPrimitives) {
471 if (removedPrimitives == null) return;
472 // extract the removed relations
473 //
474 Set<Relation> removedRelations = new HashSet<Relation>();
475 for (OsmPrimitive p: removedPrimitives) {
476 if (! (p instanceof Relation)) {
477 continue;
478 }
479 removedRelations.add((Relation)p);
480 }
481 if (removedRelations.isEmpty())
482 return;
483 int size = relations.size();
484 relations.removeAll(removedRelations);
485 if (filteredRelations != null) {
486 filteredRelations.removeAll(removedRelations);
487 }
488 if (size != relations.size()) {
489 List<Relation> sel = getSelectedRelations();
490 sort();
491 fireContentsChanged(this, 0, getSize());
492 setSelectedRelations(sel);
493 }
494 }
495
496 private void updateFilteredRelations() {
497 if (filter != null) {
498 filteredRelations = new ArrayList<Relation>(Utils.filter(relations, new Predicate<Relation>() {
499 @Override
500 public boolean evaluate(Relation r) {
501 return filter.match(r);
502 }
503 }));
504 } else if (filteredRelations != null) {
505 filteredRelations = null;
506 }
507 }
508
509 public void setFilter(final SearchCompiler.Match filter) {
510 this.filter = filter;
511 updateFilteredRelations();
512 List<Relation> sel = getSelectedRelations();
513 fireContentsChanged(this, 0, getSize());
514 setSelectedRelations(sel);
515 updateTitle();
516 }
517
518 private List<Relation> getVisibleRelations() {
519 return filteredRelations == null ? relations : filteredRelations;
520 }
521
522 private Relation getVisibleRelation(int index) {
523 if (index < 0 || index >= getVisibleRelations().size()) return null;
524 return getVisibleRelations().get(index);
525 }
526
527 @Override
528 public Object getElementAt(int index) {
529 return getVisibleRelation(index);
530 }
531
532 @Override
533 public int getSize() {
534 return getVisibleRelations().size();
535 }
536
537 /**
538 * Replies the list of selected relations. Empty list,
539 * if there are no selected relations.
540 *
541 * @return the list of selected, non-new relations.
542 */
543 public List<Relation> getSelectedRelations() {
544 ArrayList<Relation> ret = new ArrayList<Relation>();
545 for (int i=0; i<getSize();i++) {
546 if (!selectionModel.isSelectedIndex(i)) {
547 continue;
548 }
549 ret.add(getVisibleRelation(i));
550 }
551 return ret;
552 }
553
554 /**
555 * Sets the selected relations.
556 *
557 * @param sel the list of selected relations
558 */
559 public void setSelectedRelations(Collection<Relation> sel) {
560 selectionModel.clearSelection();
561 if (sel == null || sel.isEmpty())
562 return;
563 if (!getVisibleRelations().containsAll(sel)) {
564 resetFilter();
565 }
566 for (Relation r: sel) {
567 Integer i = getVisibleRelationIndex(r);
568 if (i != null) {
569 selectionModel.addSelectionInterval(i,i);
570 }
571 }
572 }
573
574 /**
575 * Returns the index of the relation
576 * @param rel The relation to look for
577 *
578 * @return index of relation (null if it cannot be found)
579 */
580 public Integer getRelationIndex(Relation rel) {
581 int i = relations.indexOf(rel);
582 if (i<0)
583 return null;
584 return i;
585 }
586
587 private Integer getVisibleRelationIndex(Relation rel) {
588 int i = getVisibleRelations().indexOf(rel);
589 if (i<0)
590 return null;
591 return i;
592 }
593
594 public void updateTitle() {
595 if (relations.size() > 0 && relations.size() != getSize()) {
596 RelationListDialog.this.setTitle(tr("Relations: {0}/{1}", getSize(), relations.size()));
597 } else if (getSize() > 0) {
598 RelationListDialog.this.setTitle(tr("Relations: {0}", getSize()));
599 } else {
600 RelationListDialog.this.setTitle(tr("Relations"));
601 }
602 }
603 }
604
605 private final void setupPopupMenuHandler() {
606
607 // -- select action
608 popupMenuHandler.addAction(selectRelationAction);
609 popupMenuHandler.addAction(addRelationToSelectionAction);
610
611 // -- select members action
612 popupMenuHandler.addAction(selectMembersAction);
613 popupMenuHandler.addAction(addMembersToSelectionAction);
614
615 popupMenuHandler.addSeparator();
616 // -- download members action
617 popupMenuHandler.addAction(downloadMembersAction);
618
619 // -- download incomplete members action
620 popupMenuHandler.addAction(downloadSelectedIncompleteMembersAction);
621
622 popupMenuHandler.addSeparator();
623 popupMenuHandler.addAction(editAction).setVisible(false);
624 popupMenuHandler.addAction(duplicateAction).setVisible(false);
625 popupMenuHandler.addAction(deleteRelationsAction).setVisible(false);
626
627 popupMenuHandler.addAction(addSelectionToRelations);
628 }
629
630 /* ---------------------------------------------------------------------------------- */
631 /* Methods that can be called from plugins */
632 /* ---------------------------------------------------------------------------------- */
633
634 /**
635 * Replies the popup menu handler.
636 * @return The popup menu handler
637 */
638 public PopupMenuHandler getPopupMenuHandler() {
639 return popupMenuHandler;
640 }
641
642 public Collection<Relation> getSelectedRelations() {
643 return model.getSelectedRelations();
644 }
645
646 /* ---------------------------------------------------------------------------------- */
647 /* DataSetListener */
648 /* ---------------------------------------------------------------------------------- */
649
650 @Override
651 public void nodeMoved(NodeMovedEvent event) {/* irrelevant in this context */}
652
653 @Override
654 public void wayNodesChanged(WayNodesChangedEvent event) {/* irrelevant in this context */}
655
656 @Override
657 public void primitivesAdded(final PrimitivesAddedEvent event) {
658 model.addRelations(event.getPrimitives());
659 model.updateTitle();
660 }
661
662 @Override
663 public void primitivesRemoved(final PrimitivesRemovedEvent event) {
664 model.removeRelations(event.getPrimitives());
665 model.updateTitle();
666 }
667
668 @Override
669 public void relationMembersChanged(final RelationMembersChangedEvent event) {
670 List<Relation> sel = model.getSelectedRelations();
671 model.sort();
672 model.setSelectedRelations(sel);
673 displaylist.repaint();
674 }
675
676 @Override
677 public void tagsChanged(TagsChangedEvent event) {
678 OsmPrimitive prim = event.getPrimitive();
679 if (prim == null || ! (prim instanceof Relation))
680 return;
681 // trigger a sort of the relation list because the display name may
682 // have changed
683 //
684 List<Relation> sel = model.getSelectedRelations();
685 model.sort();
686 model.setSelectedRelations(sel);
687 displaylist.repaint();
688 }
689
690 @Override
691 public void dataChanged(DataChangedEvent event) {
692 initFromLayer(Main.main.getEditLayer());
693 }
694
695 @Override
696 public void otherDatasetChange(AbstractDatasetChangedEvent event) {/* ignore */}
697}
Note: See TracBrowser for help on using the repository browser.