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

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

see #7846 - Large code refactorization in management of popup menus to simplify interactions with plugins (needed at least for imagery-xml-bounds and tag2link plugins)
  • Property svn:eol-style set to native
File size: 25.1 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.Point;
9import java.awt.event.ActionEvent;
10import java.awt.event.KeyEvent;
11import java.awt.event.MouseAdapter;
12import java.awt.event.MouseEvent;
13import java.util.ArrayList;
14import java.util.Arrays;
15import java.util.Collection;
16import java.util.Collections;
17import java.util.HashSet;
18import java.util.List;
19import java.util.Set;
20
21import javax.swing.AbstractAction;
22import javax.swing.AbstractListModel;
23import javax.swing.DefaultListSelectionModel;
24import javax.swing.JComponent;
25import javax.swing.JList;
26import javax.swing.JPanel;
27import javax.swing.JPopupMenu;
28import javax.swing.JScrollPane;
29import javax.swing.JTextField;
30import javax.swing.KeyStroke;
31import javax.swing.ListSelectionModel;
32import javax.swing.SwingUtilities;
33import javax.swing.UIManager;
34import javax.swing.event.DocumentEvent;
35import javax.swing.event.DocumentListener;
36import javax.swing.event.ListSelectionEvent;
37import javax.swing.event.ListSelectionListener;
38
39import org.openstreetmap.josm.Main;
40import org.openstreetmap.josm.actions.relation.AddSelectionToRelations;
41import org.openstreetmap.josm.actions.relation.DeleteRelationsAction;
42import org.openstreetmap.josm.actions.relation.DownloadMembersAction;
43import org.openstreetmap.josm.actions.relation.DownloadSelectedIncompleteMembersAction;
44import org.openstreetmap.josm.actions.relation.DuplicateRelationAction;
45import org.openstreetmap.josm.actions.relation.EditRelationAction;
46import org.openstreetmap.josm.actions.relation.SelectMembersAction;
47import org.openstreetmap.josm.actions.relation.SelectRelationAction;
48import org.openstreetmap.josm.actions.search.SearchCompiler;
49import org.openstreetmap.josm.data.osm.DataSet;
50import org.openstreetmap.josm.data.osm.OsmPrimitive;
51import org.openstreetmap.josm.data.osm.Relation;
52import org.openstreetmap.josm.data.osm.event.AbstractDatasetChangedEvent;
53import org.openstreetmap.josm.data.osm.event.DataChangedEvent;
54import org.openstreetmap.josm.data.osm.event.DataSetListener;
55import org.openstreetmap.josm.data.osm.event.DatasetEventManager;
56import org.openstreetmap.josm.data.osm.event.DatasetEventManager.FireMode;
57import org.openstreetmap.josm.data.osm.event.NodeMovedEvent;
58import org.openstreetmap.josm.data.osm.event.PrimitivesAddedEvent;
59import org.openstreetmap.josm.data.osm.event.PrimitivesRemovedEvent;
60import org.openstreetmap.josm.data.osm.event.RelationMembersChangedEvent;
61import org.openstreetmap.josm.data.osm.event.TagsChangedEvent;
62import org.openstreetmap.josm.data.osm.event.WayNodesChangedEvent;
63import org.openstreetmap.josm.gui.DefaultNameFormatter;
64import org.openstreetmap.josm.gui.MapView;
65import org.openstreetmap.josm.gui.MapView.LayerChangeListener;
66import org.openstreetmap.josm.gui.OsmPrimitivRenderer;
67import org.openstreetmap.josm.gui.PopupMenuHandler;
68import org.openstreetmap.josm.gui.SideButton;
69import org.openstreetmap.josm.gui.dialogs.relation.RelationEditor;
70import org.openstreetmap.josm.gui.layer.Layer;
71import org.openstreetmap.josm.gui.layer.OsmDataLayer;
72import org.openstreetmap.josm.gui.widgets.DisableShortcutsOnFocusGainedTextField;
73import org.openstreetmap.josm.tools.ImageProvider;
74import org.openstreetmap.josm.tools.InputMapUtils;
75import org.openstreetmap.josm.tools.Predicate;
76import org.openstreetmap.josm.tools.Shortcut;
77import org.openstreetmap.josm.tools.Utils;
78
79/**
80 * A dialog showing all known relations, with buttons to add, edit, and
81 * delete them.
82 *
83 * We don't have such dialogs for nodes, segments, and ways, because those
84 * objects are visible on the map and can be selected there. Relations are not.
85 */
86public class RelationListDialog extends ToggleDialog implements DataSetListener {
87 /** The display list. */
88 private final JList displaylist;
89 /** the list model used */
90 private final RelationListModel model;
91
92 private final NewAction newAction;
93
94 /** the popup menu and its handler */
95 private final JPopupMenu popupMenu = new JPopupMenu();
96 private final PopupMenuHandler popupMenuHandler = new PopupMenuHandler(popupMenu);
97
98 private final JTextField filter;
99
100 // Actions
101 /** the edit action */
102 private final EditRelationAction editAction = new EditRelationAction();
103 /** the delete action */
104 private final DeleteRelationsAction deleteRelationsAction = new DeleteRelationsAction();
105 /** the duplicate action */
106 private final DuplicateRelationAction duplicateAction = new DuplicateRelationAction();
107 private final DownloadMembersAction downloadMembersAction = new DownloadMembersAction();
108 private final DownloadSelectedIncompleteMembersAction downloadSelectedIncompleteMembersAction = new DownloadSelectedIncompleteMembersAction();
109 private final SelectMembersAction selectMembersAction = new SelectMembersAction(false);
110 private final SelectMembersAction addMembersToSelectionAction = new SelectMembersAction(true);
111 private final SelectRelationAction selectRelationAction = new SelectRelationAction(false);
112 private final SelectRelationAction addRelationToSelectionAction = new SelectRelationAction(true);
113 /** add all selected primitives to the given relations */
114 private final AddSelectionToRelations addSelectionToRelations = new AddSelectionToRelations();
115
116 /**
117 * Constructs <code>RelationListDialog</code>
118 */
119 public RelationListDialog() {
120 super(tr("Relations"), "relationlist", tr("Open a list of all relations."),
121 Shortcut.registerShortcut("subwindow:relations", tr("Toggle: {0}", tr("Relations")),
122 KeyEvent.VK_R, Shortcut.ALT_SHIFT), 150);
123
124 // create the list of relations
125 //
126 DefaultListSelectionModel selectionModel = new DefaultListSelectionModel();
127 model = new RelationListModel(selectionModel);
128 displaylist = new JList(model);
129 displaylist.setSelectionModel(selectionModel);
130 displaylist.setCellRenderer(new OsmPrimitivRenderer() {
131 /**
132 * Don't show the default tooltip in the relation list.
133 */
134 @Override
135 protected String getComponentToolTipText(OsmPrimitive value) {
136 return null;
137 }
138 });
139 displaylist.setSelectionMode(ListSelectionModel.MULTIPLE_INTERVAL_SELECTION);
140 displaylist.addMouseListener(new MouseEventHandler());
141
142 // the new action
143 //
144 newAction = new NewAction();
145
146 filter = setupFilter();
147
148 displaylist.addListSelectionListener(new ListSelectionListener() {
149 @Override
150 public void valueChanged(ListSelectionEvent e) {
151 updateActionsRelationLists();
152 }
153 });
154
155 // Setup popup menu handler
156 setupPopupMenuHandler();
157
158 JPanel pane = new JPanel(new BorderLayout());
159 pane.add(filter, BorderLayout.NORTH);
160 pane.add(new JScrollPane(displaylist), BorderLayout.CENTER);
161 createLayout(pane, false, Arrays.asList(new SideButton[]{
162 new SideButton(newAction, false),
163 new SideButton(editAction, false),
164 new SideButton(duplicateAction, false),
165 new SideButton(deleteRelationsAction, false),
166 new SideButton(selectRelationAction, false)
167 }));
168
169 // activate DEL in the list of relations
170 //displaylist.getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_DELETE,0), "deleteRelation");
171 //displaylist.getActionMap().put("deleteRelation", deleteAction);
172
173 InputMapUtils.unassignCtrlShiftUpDown(displaylist, JComponent.WHEN_FOCUSED);
174
175 // Select relation on Ctrl-Enter
176 InputMapUtils.addEnterAction(displaylist, selectRelationAction);
177
178 // Edit relation on Ctrl-Enter
179 displaylist.getActionMap().put("edit", editAction);
180 displaylist.getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_ENTER, KeyEvent.CTRL_MASK), "edit");
181
182 updateActionsRelationLists();
183 }
184
185 // inform all actions about list of relations they need
186 private void updateActionsRelationLists() {
187 popupMenuHandler.setPrimitives(model.getSelectedRelations());
188 }
189
190 @Override public void showNotify() {
191 MapView.addLayerChangeListener(newAction);
192 newAction.updateEnabledState();
193 DatasetEventManager.getInstance().addDatasetListener(this, FireMode.IN_EDT);
194 DataSet.addSelectionListener(addSelectionToRelations);
195 dataChanged(null);
196 }
197
198 @Override public void hideNotify() {
199 MapView.removeLayerChangeListener(newAction);
200 DatasetEventManager.getInstance().removeDatasetListener(this);
201 DataSet.removeSelectionListener(addSelectionToRelations);
202 }
203
204 private void resetFilter() {
205 filter.setText(null);
206 }
207
208 /**
209 * Initializes the relation list dialog from a layer. If <code>layer</code> is null
210 * or if it isn't an {@link OsmDataLayer} the dialog is reset to an empty dialog.
211 * Otherwise it is initialized with the list of non-deleted and visible relations
212 * in the layer's dataset.
213 *
214 * @param layer the layer. May be null.
215 */
216 protected void initFromLayer(Layer layer) {
217 if (layer == null || ! (layer instanceof OsmDataLayer)) {
218 model.setRelations(null);
219 return;
220 }
221 OsmDataLayer l = (OsmDataLayer)layer;
222 model.setRelations(l.data.getRelations());
223 model.updateTitle();
224 updateActionsRelationLists();
225 }
226
227 /**
228 * @return The selected relation in the list
229 */
230 private Relation getSelected() {
231 if(model.getSize() == 1) {
232 displaylist.setSelectedIndex(0);
233 }
234 return (Relation) displaylist.getSelectedValue();
235 }
236
237 /**
238 * Selects the relation <code>relation</code> in the list of relations.
239 *
240 * @param relation the relation
241 */
242 public void selectRelation(Relation relation) {
243 selectRelations(Collections.singleton(relation));
244 }
245
246 /**
247 * Selects the relations in the list of relations.
248 * @param relations the relations to be selected
249 */
250 public void selectRelations(Collection<Relation> relations) {
251 if (relations == null || relations.isEmpty()) {
252 model.setSelectedRelations(null);
253 } else {
254 model.setSelectedRelations(relations);
255 Integer i = model.getVisibleRelationIndex(relations.iterator().next());
256 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)
257 displaylist.scrollRectToVisible(displaylist.getCellBounds(i, i));
258 }
259 }
260 }
261
262 private JTextField setupFilter() {
263 final JTextField f = new DisableShortcutsOnFocusGainedTextField();
264 f.setToolTipText(tr("Relation list filter"));
265 f.getDocument().addDocumentListener(new DocumentListener() {
266
267 private void setFilter() {
268 try {
269 f.setBackground(UIManager.getColor("TextField.background"));
270 f.setToolTipText(tr("Relation list filter"));
271 model.setFilter(SearchCompiler.compile(filter.getText(), false, false));
272 } catch (SearchCompiler.ParseError ex) {
273 f.setBackground(new Color(255, 224, 224));
274 f.setToolTipText(ex.getMessage());
275 model.setFilter(new SearchCompiler.Always());
276 }
277 }
278
279 @Override
280 public void insertUpdate(DocumentEvent e) {
281 setFilter();
282 }
283
284 @Override
285 public void removeUpdate(DocumentEvent e) {
286 setFilter();
287 }
288
289 @Override
290 public void changedUpdate(DocumentEvent e) {
291 setFilter();
292 }
293 });
294 return f;
295 }
296
297 class MouseEventHandler extends MouseAdapter {
298 protected void setCurrentRelationAsSelection() {
299 Main.main.getCurrentDataSet().setSelected((Relation)displaylist.getSelectedValue());
300 }
301
302 protected void editCurrentRelation() {
303 EditRelationAction.launchEditor(getSelected());
304 }
305
306 @Override public void mouseClicked(MouseEvent e) {
307 if (Main.main.getEditLayer() == null) return;
308 if (e.getClickCount() == 2 && SwingUtilities.isLeftMouseButton(e)) {
309 if (e.isControlDown()) {
310 editCurrentRelation();
311 } else {
312 setCurrentRelationAsSelection();
313 }
314 }
315 }
316 private void openPopup(MouseEvent e) {
317 Point p = e.getPoint();
318 int index = displaylist.locationToIndex(p);
319 if (index < 0) return;
320 if (!displaylist.getCellBounds(index, index).contains(e.getPoint()))
321 return;
322 if (! displaylist.isSelectedIndex(index)) {
323 displaylist.setSelectedIndex(index);
324 }
325 popupMenu.show(displaylist, p.x, p.y-3);
326 }
327 @Override public void mousePressed(MouseEvent e) {
328 if (Main.main.getEditLayer() == null) return;
329 if (e.isPopupTrigger()) {
330 openPopup(e);
331 }
332 }
333 @Override public void mouseReleased(MouseEvent e) {
334 if (Main.main.getEditLayer() == null) return;
335 if (e.isPopupTrigger()) {
336 openPopup(e);
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 // -- download members action
608 popupMenuHandler.addAction(downloadMembersAction);
609
610 // -- download incomplete members action
611 popupMenuHandler.addAction(downloadSelectedIncompleteMembersAction);
612
613 popupMenuHandler.addSeparator();
614
615 // -- select members action
616 popupMenuHandler.addAction(selectMembersAction);
617 popupMenuHandler.addAction(addMembersToSelectionAction);
618
619 // -- select action
620 popupMenuHandler.addAction(selectRelationAction);
621 popupMenuHandler.addAction(addRelationToSelectionAction);
622
623 popupMenuHandler.addSeparator();
624
625 popupMenuHandler.addAction(addSelectionToRelations);
626 }
627
628 /* ---------------------------------------------------------------------------------- */
629 /* Methods that can be called from plugins */
630 /* ---------------------------------------------------------------------------------- */
631
632 /**
633 * Replies the popup menu handler.
634 * @return The popup menu handler
635 */
636 public PopupMenuHandler getPopupMenuHandler() {
637 return popupMenuHandler;
638 }
639
640 public Collection<Relation> getSelectedRelations() {
641 return model.getSelectedRelations();
642 }
643
644 /* ---------------------------------------------------------------------------------- */
645 /* DataSetListener */
646 /* ---------------------------------------------------------------------------------- */
647
648 @Override
649 public void nodeMoved(NodeMovedEvent event) {/* irrelevant in this context */}
650
651 @Override
652 public void wayNodesChanged(WayNodesChangedEvent event) {/* irrelevant in this context */}
653
654 @Override
655 public void primitivesAdded(final PrimitivesAddedEvent event) {
656 model.addRelations(event.getPrimitives());
657 model.updateTitle();
658 }
659
660 @Override
661 public void primitivesRemoved(final PrimitivesRemovedEvent event) {
662 model.removeRelations(event.getPrimitives());
663 model.updateTitle();
664 }
665
666 @Override
667 public void relationMembersChanged(final RelationMembersChangedEvent event) {
668 List<Relation> sel = model.getSelectedRelations();
669 model.sort();
670 model.setSelectedRelations(sel);
671 displaylist.repaint();
672 }
673
674 @Override
675 public void tagsChanged(TagsChangedEvent event) {
676 OsmPrimitive prim = event.getPrimitive();
677 if (prim == null || ! (prim instanceof Relation))
678 return;
679 // trigger a sort of the relation list because the display name may
680 // have changed
681 //
682 List<Relation> sel = model.getSelectedRelations();
683 model.sort();
684 model.setSelectedRelations(sel);
685 displaylist.repaint();
686 }
687
688 @Override
689 public void dataChanged(DataChangedEvent event) {
690 initFromLayer(Main.main.getEditLayer());
691 }
692
693 @Override
694 public void otherDatasetChange(AbstractDatasetChangedEvent event) {/* ignore */}
695}
Note: See TracBrowser for help on using the repository browser.