source: josm/trunk/src/org/openstreetmap/josm/gui/dialogs/relation/GenericRelationEditor.java@ 9657

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

fix #12410 - new button to refresh relation in relation editor (patch by kolesar, modified for checkstyle, javadoc, unit test)
  • Property svn:eol-style set to native
File size: 36.3 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.dialogs.relation;
3
4import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
5import static org.openstreetmap.josm.tools.I18n.tr;
6
7import java.awt.BorderLayout;
8import java.awt.Dimension;
9import java.awt.FlowLayout;
10import java.awt.GraphicsEnvironment;
11import java.awt.GridBagConstraints;
12import java.awt.GridBagLayout;
13import java.awt.event.ActionEvent;
14import java.awt.event.FocusAdapter;
15import java.awt.event.FocusEvent;
16import java.awt.event.InputEvent;
17import java.awt.event.KeyEvent;
18import java.awt.event.MouseAdapter;
19import java.awt.event.MouseEvent;
20import java.awt.event.WindowAdapter;
21import java.awt.event.WindowEvent;
22import java.util.ArrayList;
23import java.util.Collection;
24import java.util.Collections;
25import java.util.EnumSet;
26import java.util.HashSet;
27import java.util.List;
28import java.util.Set;
29
30import javax.swing.AbstractAction;
31import javax.swing.BorderFactory;
32import javax.swing.InputMap;
33import javax.swing.JButton;
34import javax.swing.JComponent;
35import javax.swing.JLabel;
36import javax.swing.JMenu;
37import javax.swing.JMenuItem;
38import javax.swing.JOptionPane;
39import javax.swing.JPanel;
40import javax.swing.JScrollPane;
41import javax.swing.JSplitPane;
42import javax.swing.JTabbedPane;
43import javax.swing.JToolBar;
44import javax.swing.KeyStroke;
45import javax.swing.event.ChangeEvent;
46import javax.swing.event.ChangeListener;
47import javax.swing.event.ListSelectionEvent;
48import javax.swing.event.ListSelectionListener;
49
50import org.openstreetmap.josm.Main;
51import org.openstreetmap.josm.actions.ExpertToggleAction;
52import org.openstreetmap.josm.actions.JosmAction;
53import org.openstreetmap.josm.command.ChangeCommand;
54import org.openstreetmap.josm.command.Command;
55import org.openstreetmap.josm.data.osm.OsmPrimitive;
56import org.openstreetmap.josm.data.osm.Relation;
57import org.openstreetmap.josm.data.osm.RelationMember;
58import org.openstreetmap.josm.data.osm.Tag;
59import org.openstreetmap.josm.gui.ConditionalOptionPaneUtil;
60import org.openstreetmap.josm.gui.DefaultNameFormatter;
61import org.openstreetmap.josm.gui.MainMenu;
62import org.openstreetmap.josm.gui.SideButton;
63import org.openstreetmap.josm.gui.dialogs.relation.actions.AddSelectedAfterSelection;
64import org.openstreetmap.josm.gui.dialogs.relation.actions.AddSelectedAtEndAction;
65import org.openstreetmap.josm.gui.dialogs.relation.actions.AddSelectedAtStartAction;
66import org.openstreetmap.josm.gui.dialogs.relation.actions.AddSelectedBeforeSelection;
67import org.openstreetmap.josm.gui.dialogs.relation.actions.ApplyAction;
68import org.openstreetmap.josm.gui.dialogs.relation.actions.CancelAction;
69import org.openstreetmap.josm.gui.dialogs.relation.actions.CopyMembersAction;
70import org.openstreetmap.josm.gui.dialogs.relation.actions.DeleteCurrentRelationAction;
71import org.openstreetmap.josm.gui.dialogs.relation.actions.DownloadIncompleteMembersAction;
72import org.openstreetmap.josm.gui.dialogs.relation.actions.DownloadSelectedIncompleteMembersAction;
73import org.openstreetmap.josm.gui.dialogs.relation.actions.DuplicateRelationAction;
74import org.openstreetmap.josm.gui.dialogs.relation.actions.EditAction;
75import org.openstreetmap.josm.gui.dialogs.relation.actions.MoveDownAction;
76import org.openstreetmap.josm.gui.dialogs.relation.actions.MoveUpAction;
77import org.openstreetmap.josm.gui.dialogs.relation.actions.OKAction;
78import org.openstreetmap.josm.gui.dialogs.relation.actions.PasteMembersAction;
79import org.openstreetmap.josm.gui.dialogs.relation.actions.RefreshAction;
80import org.openstreetmap.josm.gui.dialogs.relation.actions.RemoveAction;
81import org.openstreetmap.josm.gui.dialogs.relation.actions.RemoveSelectedAction;
82import org.openstreetmap.josm.gui.dialogs.relation.actions.ReverseAction;
83import org.openstreetmap.josm.gui.dialogs.relation.actions.SelectPrimitivesForSelectedMembersAction;
84import org.openstreetmap.josm.gui.dialogs.relation.actions.SelectedMembersForSelectionAction;
85import org.openstreetmap.josm.gui.dialogs.relation.actions.SetRoleAction;
86import org.openstreetmap.josm.gui.dialogs.relation.actions.SortAction;
87import org.openstreetmap.josm.gui.dialogs.relation.actions.SortBelowAction;
88import org.openstreetmap.josm.gui.help.ContextSensitiveHelpAction;
89import org.openstreetmap.josm.gui.help.HelpUtil;
90import org.openstreetmap.josm.gui.layer.OsmDataLayer;
91import org.openstreetmap.josm.gui.tagging.TagEditorPanel;
92import org.openstreetmap.josm.gui.tagging.ac.AutoCompletingTextField;
93import org.openstreetmap.josm.gui.tagging.ac.AutoCompletionList;
94import org.openstreetmap.josm.gui.tagging.presets.TaggingPreset;
95import org.openstreetmap.josm.gui.tagging.presets.TaggingPresetHandler;
96import org.openstreetmap.josm.gui.tagging.presets.TaggingPresetType;
97import org.openstreetmap.josm.gui.tagging.presets.TaggingPresets;
98import org.openstreetmap.josm.tools.CheckParameterUtil;
99import org.openstreetmap.josm.tools.Shortcut;
100import org.openstreetmap.josm.tools.WindowGeometry;
101
102/**
103 * This dialog is for editing relations.
104 * @since 343
105 */
106public class GenericRelationEditor extends RelationEditor {
107 /** the tag table and its model */
108 private final TagEditorPanel tagEditorPanel;
109 private final ReferringRelationsBrowser referrerBrowser;
110 private final ReferringRelationsBrowserModel referrerModel;
111
112 /** the member table */
113 private MemberTable memberTable;
114 private final MemberTableModel memberTableModel;
115
116 /** the model for the selection table */
117 private SelectionTable selectionTable;
118 private final SelectionTableModel selectionTableModel;
119
120 private AutoCompletingTextField tfRole;
121
122 /** the menu item in the windows menu. Required to properly
123 * hide on dialog close.
124 */
125 private JMenuItem windowMenuItem;
126 /**
127 * Button for performing the {@link org.openstreetmap.josm.gui.dialogs.relation.actions.SortBelowAction}.
128 */
129 private JButton sortBelowButton;
130 /**
131 * Action for performing the {@link RefreshAction}
132 */
133 private RefreshAction refreshAction;
134 /**
135 * Action for performing the {@link ApplyAction}
136 */
137 private ApplyAction applyAction;
138 /**
139 * Action for performing the {@link CancelAction}
140 */
141 private CancelAction cancelAction;
142
143 /**
144 * Creates a new relation editor for the given relation. The relation will be saved if the user
145 * selects "ok" in the editor.
146 *
147 * If no relation is given, will create an editor for a new relation.
148 *
149 * @param layer the {@link OsmDataLayer} the new or edited relation belongs to
150 * @param relation relation to edit, or null to create a new one.
151 * @param selectedMembers a collection of members which shall be selected initially
152 */
153 public GenericRelationEditor(OsmDataLayer layer, Relation relation, Collection<RelationMember> selectedMembers) {
154 super(layer, relation);
155
156 setRememberWindowGeometry(getClass().getName() + ".geometry",
157 WindowGeometry.centerInWindow(Main.parent, new Dimension(700, 650)));
158
159 final TaggingPresetHandler presetHandler = new TaggingPresetHandler() {
160
161 @Override
162 public void updateTags(List<Tag> tags) {
163 tagEditorPanel.getModel().updateTags(tags);
164 }
165
166 @Override
167 public Collection<OsmPrimitive> getSelection() {
168 Relation relation = new Relation();
169 tagEditorPanel.getModel().applyToPrimitive(relation);
170 return Collections.<OsmPrimitive>singletonList(relation);
171 }
172 };
173
174 // init the various models
175 //
176 memberTableModel = new MemberTableModel(relation, getLayer(), presetHandler);
177 memberTableModel.register();
178 selectionTableModel = new SelectionTableModel(getLayer());
179 selectionTableModel.register();
180 referrerModel = new ReferringRelationsBrowserModel(relation);
181
182 tagEditorPanel = new TagEditorPanel(relation, presetHandler);
183 populateModels(relation);
184 tagEditorPanel.getModel().ensureOneTag();
185
186 JSplitPane pane = buildSplitPane();
187 pane.setPreferredSize(new Dimension(100, 100));
188
189 JPanel pnl = new JPanel(new BorderLayout());
190 pnl.add(pane, BorderLayout.CENTER);
191 pnl.setBorder(BorderFactory.createRaisedBevelBorder());
192
193 getContentPane().setLayout(new BorderLayout());
194 JTabbedPane tabbedPane = new JTabbedPane();
195 tabbedPane.add(tr("Tags and Members"), pnl);
196 referrerBrowser = new ReferringRelationsBrowser(getLayer(), referrerModel);
197 tabbedPane.add(tr("Parent Relations"), referrerBrowser);
198 tabbedPane.add(tr("Child Relations"), new ChildRelationBrowser(getLayer(), relation));
199 tabbedPane.addChangeListener(
200 new ChangeListener() {
201 @Override
202 public void stateChanged(ChangeEvent e) {
203 JTabbedPane sourceTabbedPane = (JTabbedPane) e.getSource();
204 int index = sourceTabbedPane.getSelectedIndex();
205 String title = sourceTabbedPane.getTitleAt(index);
206 if (title.equals(tr("Parent Relations"))) {
207 referrerBrowser.init();
208 }
209 }
210 }
211 );
212
213 getContentPane().add(buildToolBar(), BorderLayout.NORTH);
214 getContentPane().add(tabbedPane, BorderLayout.CENTER);
215 getContentPane().add(buildOkCancelButtonPanel(), BorderLayout.SOUTH);
216
217 setSize(findMaxDialogSize());
218
219 setDefaultCloseOperation(DO_NOTHING_ON_CLOSE);
220 addWindowListener(
221 new WindowAdapter() {
222 @Override
223 public void windowOpened(WindowEvent e) {
224 cleanSelfReferences();
225 }
226
227 @Override
228 public void windowClosing(WindowEvent e) {
229 cancel();
230 }
231 }
232 );
233 registerCopyPasteAction(tagEditorPanel.getPasteAction(),
234 "PASTE_TAGS",
235 // CHECKSTYLE.OFF: LineLength
236 Shortcut.registerShortcut("system:pastestyle", tr("Edit: {0}", tr("Paste Tags")), KeyEvent.VK_V, Shortcut.CTRL_SHIFT).getKeyStroke());
237 // CHECKSTYLE.ON: LineLength
238
239 registerCopyPasteAction(new PasteMembersAction(memberTableModel, getLayer(), this) {
240 @Override
241 public void actionPerformed(ActionEvent e) {
242 super.actionPerformed(e);
243 tfRole.requestFocusInWindow();
244 }
245 }, "PASTE_MEMBERS", Shortcut.getPasteKeyStroke());
246
247 registerCopyPasteAction(new CopyMembersAction(memberTableModel, getLayer(), this),
248 "COPY_MEMBERS", Shortcut.getCopyKeyStroke());
249
250 tagEditorPanel.setNextFocusComponent(memberTable);
251 selectionTable.setFocusable(false);
252 memberTableModel.setSelectedMembers(selectedMembers);
253 HelpUtil.setHelpContext(getRootPane(), ht("/Dialog/RelationEditor"));
254 }
255
256 /**
257 * Reloads data from relation.
258 */
259 public void reloadDataFromRelation() {
260 setRelation(getRelation());
261 populateModels(getRelation());
262 refreshAction.updateEnabledState();
263 }
264
265 private void populateModels(Relation relation) {
266 if (relation != null) {
267 tagEditorPanel.getModel().initFromPrimitive(relation);
268 memberTableModel.populate(relation);
269 if (!getLayer().data.getRelations().contains(relation)) {
270 // treat it as a new relation if it doesn't exist in the data set yet.
271 setRelation(null);
272 }
273 } else {
274 tagEditorPanel.getModel().clear();
275 memberTableModel.populate(null);
276 }
277 }
278
279 /**
280 * Apply changes.
281 * @see ApplyAction
282 */
283 public void apply() {
284 applyAction.actionPerformed(null);
285 }
286
287 /**
288 * Cancel changes.
289 * @see CancelAction
290 */
291 public void cancel() {
292 cancelAction.actionPerformed(null);
293 }
294
295 /**
296 * Creates the toolbar
297 *
298 * @return the toolbar
299 */
300 protected JToolBar buildToolBar() {
301 JToolBar tb = new JToolBar();
302 tb.setFloatable(false);
303 refreshAction = new RefreshAction(memberTable, memberTableModel, tagEditorPanel.getModel(), getLayer(), this);
304 applyAction = new ApplyAction(memberTable, memberTableModel, tagEditorPanel.getModel(), getLayer(), this);
305 tb.add(refreshAction);
306 tb.add(applyAction);
307 tb.add(new DuplicateRelationAction(memberTableModel, tagEditorPanel.getModel(), getLayer()));
308 DeleteCurrentRelationAction deleteAction = new DeleteCurrentRelationAction(getLayer(), this);
309 addPropertyChangeListener(deleteAction);
310 tb.add(deleteAction);
311 return tb;
312 }
313
314 /**
315 * builds the panel with the OK and the Cancel button
316 *
317 * @return the panel with the OK and the Cancel button
318 */
319 protected JPanel buildOkCancelButtonPanel() {
320 JPanel pnl = new JPanel(new FlowLayout(FlowLayout.CENTER));
321 pnl.add(new SideButton(new OKAction(memberTable, memberTableModel, tagEditorPanel.getModel(), getLayer(), this, tfRole)));
322 cancelAction = new CancelAction(memberTable, memberTableModel, tagEditorPanel.getModel(), getLayer(), this, tfRole);
323 pnl.add(new SideButton(cancelAction));
324 pnl.add(new SideButton(new ContextSensitiveHelpAction(ht("/Dialog/RelationEditor"))));
325 return pnl;
326 }
327
328 /**
329 * builds the panel with the tag editor
330 *
331 * @return the panel with the tag editor
332 */
333 protected JPanel buildTagEditorPanel() {
334 JPanel pnl = new JPanel(new GridBagLayout());
335
336 GridBagConstraints gc = new GridBagConstraints();
337 gc.gridx = 0;
338 gc.gridy = 0;
339 gc.gridheight = 1;
340 gc.gridwidth = 1;
341 gc.fill = GridBagConstraints.HORIZONTAL;
342 gc.anchor = GridBagConstraints.FIRST_LINE_START;
343 gc.weightx = 1.0;
344 gc.weighty = 0.0;
345 pnl.add(new JLabel(tr("Tags")), gc);
346
347 gc.gridx = 0;
348 gc.gridy = 1;
349 gc.fill = GridBagConstraints.BOTH;
350 gc.anchor = GridBagConstraints.CENTER;
351 gc.weightx = 1.0;
352 gc.weighty = 1.0;
353 pnl.add(tagEditorPanel, gc);
354 return pnl;
355 }
356
357 /**
358 * builds the panel for the relation member editor
359 *
360 * @return the panel for the relation member editor
361 */
362 protected JPanel buildMemberEditorPanel() {
363 final JPanel pnl = new JPanel(new GridBagLayout());
364 // setting up the member table
365 memberTable = new MemberTable(getLayer(), getRelation(), memberTableModel);
366 memberTable.addMouseListener(new MemberTableDblClickAdapter());
367 memberTableModel.addMemberModelListener(memberTable);
368
369 final JScrollPane scrollPane = new JScrollPane(memberTable);
370
371 GridBagConstraints gc = new GridBagConstraints();
372 gc.gridx = 0;
373 gc.gridy = 0;
374 gc.gridwidth = 2;
375 gc.fill = GridBagConstraints.HORIZONTAL;
376 gc.anchor = GridBagConstraints.FIRST_LINE_START;
377 gc.weightx = 1.0;
378 gc.weighty = 0.0;
379 pnl.add(new JLabel(tr("Members")), gc);
380
381 gc.gridx = 0;
382 gc.gridy = 1;
383 gc.gridheight = 2;
384 gc.gridwidth = 1;
385 gc.fill = GridBagConstraints.VERTICAL;
386 gc.anchor = GridBagConstraints.NORTHWEST;
387 gc.weightx = 0.0;
388 gc.weighty = 1.0;
389 pnl.add(buildLeftButtonPanel(), gc);
390
391 gc.gridx = 1;
392 gc.gridy = 1;
393 gc.gridheight = 1;
394 gc.fill = GridBagConstraints.BOTH;
395 gc.anchor = GridBagConstraints.CENTER;
396 gc.weightx = 0.6;
397 gc.weighty = 1.0;
398 pnl.add(scrollPane, gc);
399
400 // --- role editing
401 JPanel p3 = new JPanel(new FlowLayout(FlowLayout.LEFT));
402 p3.add(new JLabel(tr("Apply Role:")));
403 tfRole = new AutoCompletingTextField(10);
404 tfRole.setToolTipText(tr("Enter a role and apply it to the selected relation members"));
405 tfRole.addFocusListener(new FocusAdapter() {
406 @Override
407 public void focusGained(FocusEvent e) {
408 tfRole.selectAll();
409 }
410 });
411 tfRole.setAutoCompletionList(new AutoCompletionList());
412 tfRole.addFocusListener(
413 new FocusAdapter() {
414 @Override
415 public void focusGained(FocusEvent e) {
416 AutoCompletionList list = tfRole.getAutoCompletionList();
417 if (list != null) {
418 list.clear();
419 getLayer().data.getAutoCompletionManager().populateWithMemberRoles(list, getRelation());
420 }
421 }
422 }
423 );
424 tfRole.setText(Main.pref.get("relation.editor.generic.lastrole", ""));
425 p3.add(tfRole);
426 SetRoleAction setRoleAction = new SetRoleAction(memberTable, memberTableModel, tfRole);
427 memberTableModel.getSelectionModel().addListSelectionListener(setRoleAction);
428 tfRole.getDocument().addDocumentListener(setRoleAction);
429 tfRole.addActionListener(setRoleAction);
430 memberTableModel.getSelectionModel().addListSelectionListener(
431 new ListSelectionListener() {
432 @Override
433 public void valueChanged(ListSelectionEvent e) {
434 tfRole.setEnabled(memberTable.getSelectedRowCount() > 0);
435 }
436 }
437 );
438 tfRole.setEnabled(memberTable.getSelectedRowCount() > 0);
439 SideButton btnApply = new SideButton(setRoleAction);
440 btnApply.setPreferredSize(new Dimension(20, 20));
441 btnApply.setText("");
442 p3.add(btnApply);
443
444 gc.gridx = 1;
445 gc.gridy = 2;
446 gc.fill = GridBagConstraints.HORIZONTAL;
447 gc.anchor = GridBagConstraints.LAST_LINE_START;
448 gc.weightx = 1.0;
449 gc.weighty = 0.0;
450 pnl.add(p3, gc);
451
452 JPanel pnl2 = new JPanel(new GridBagLayout());
453
454 gc.gridx = 0;
455 gc.gridy = 0;
456 gc.gridheight = 1;
457 gc.gridwidth = 3;
458 gc.fill = GridBagConstraints.HORIZONTAL;
459 gc.anchor = GridBagConstraints.FIRST_LINE_START;
460 gc.weightx = 1.0;
461 gc.weighty = 0.0;
462 pnl2.add(new JLabel(tr("Selection")), gc);
463
464 gc.gridx = 0;
465 gc.gridy = 1;
466 gc.gridheight = 1;
467 gc.gridwidth = 1;
468 gc.fill = GridBagConstraints.VERTICAL;
469 gc.anchor = GridBagConstraints.NORTHWEST;
470 gc.weightx = 0.0;
471 gc.weighty = 1.0;
472 pnl2.add(buildSelectionControlButtonPanel(), gc);
473
474 gc.gridx = 1;
475 gc.gridy = 1;
476 gc.weightx = 1.0;
477 gc.weighty = 1.0;
478 gc.fill = GridBagConstraints.BOTH;
479 pnl2.add(buildSelectionTablePanel(), gc);
480
481 final JSplitPane splitPane = new JSplitPane(JSplitPane.HORIZONTAL_SPLIT);
482 splitPane.setLeftComponent(pnl);
483 splitPane.setRightComponent(pnl2);
484 splitPane.setOneTouchExpandable(false);
485 addWindowListener(new WindowAdapter() {
486 @Override
487 public void windowOpened(WindowEvent e) {
488 // has to be called when the window is visible, otherwise
489 // no effect
490 splitPane.setDividerLocation(0.6);
491 }
492 });
493
494 JPanel pnl3 = new JPanel(new BorderLayout());
495 pnl3.add(splitPane, BorderLayout.CENTER);
496
497 return pnl3;
498 }
499
500 /**
501 * builds the panel with the table displaying the currently selected primitives
502 *
503 * @return panel with current selection
504 */
505 protected JPanel buildSelectionTablePanel() {
506 JPanel pnl = new JPanel(new BorderLayout());
507 MemberRoleCellEditor ce = (MemberRoleCellEditor) memberTable.getColumnModel().getColumn(0).getCellEditor();
508 selectionTable = new SelectionTable(selectionTableModel, new SelectionTableColumnModel(memberTableModel));
509 selectionTable.setMemberTableModel(memberTableModel);
510 selectionTable.setRowHeight(ce.getEditor().getPreferredSize().height);
511 pnl.add(new JScrollPane(selectionTable), BorderLayout.CENTER);
512 return pnl;
513 }
514
515 /**
516 * builds the {@link JSplitPane} which divides the editor in an upper and a lower half
517 *
518 * @return the split panel
519 */
520 protected JSplitPane buildSplitPane() {
521 final JSplitPane pane = new JSplitPane(JSplitPane.VERTICAL_SPLIT);
522 pane.setTopComponent(buildTagEditorPanel());
523 pane.setBottomComponent(buildMemberEditorPanel());
524 pane.setOneTouchExpandable(true);
525 addWindowListener(new WindowAdapter() {
526 @Override
527 public void windowOpened(WindowEvent e) {
528 // has to be called when the window is visible, otherwise no effect
529 pane.setDividerLocation(0.3);
530 }
531 });
532 return pane;
533 }
534
535 /**
536 * build the panel with the buttons on the left
537 *
538 * @return left button panel
539 */
540 protected JToolBar buildLeftButtonPanel() {
541 JToolBar tb = new JToolBar();
542 tb.setOrientation(JToolBar.VERTICAL);
543 tb.setFloatable(false);
544
545 // -- move up action
546 MoveUpAction moveUpAction = new MoveUpAction(memberTable, memberTableModel, "moveUp");
547 memberTableModel.getSelectionModel().addListSelectionListener(moveUpAction);
548 tb.add(moveUpAction);
549
550 // -- move down action
551 MoveDownAction moveDownAction = new MoveDownAction(memberTable, memberTableModel, "moveDown");
552 memberTableModel.getSelectionModel().addListSelectionListener(moveDownAction);
553 tb.add(moveDownAction);
554
555 tb.addSeparator();
556
557 // -- edit action
558 EditAction editAction = new EditAction(memberTable, memberTableModel, getLayer());
559 memberTableModel.getSelectionModel().addListSelectionListener(editAction);
560 tb.add(editAction);
561
562 // -- delete action
563 RemoveAction removeSelectedAction = new RemoveAction(memberTable, memberTableModel, "removeSelected");
564 memberTable.getSelectionModel().addListSelectionListener(removeSelectedAction);
565 tb.add(removeSelectedAction);
566
567 tb.addSeparator();
568 // -- sort action
569 SortAction sortAction = new SortAction(memberTable, memberTableModel);
570 memberTableModel.addTableModelListener(sortAction);
571 tb.add(sortAction);
572 final SortBelowAction sortBelowAction = new SortBelowAction(memberTable, memberTableModel);
573 memberTableModel.addTableModelListener(sortBelowAction);
574 memberTableModel.getSelectionModel().addListSelectionListener(sortBelowAction);
575 sortBelowButton = tb.add(sortBelowAction);
576
577 // -- reverse action
578 ReverseAction reverseAction = new ReverseAction(memberTable, memberTableModel);
579 memberTableModel.addTableModelListener(reverseAction);
580 tb.add(reverseAction);
581
582 tb.addSeparator();
583
584 // -- download action
585 DownloadIncompleteMembersAction downloadIncompleteMembersAction = new DownloadIncompleteMembersAction(
586 memberTable, memberTableModel, "downloadIncomplete", getLayer(), this);
587 memberTable.getModel().addTableModelListener(downloadIncompleteMembersAction);
588 tb.add(downloadIncompleteMembersAction);
589
590 // -- download selected action
591 DownloadSelectedIncompleteMembersAction downloadSelectedIncompleteMembersAction = new DownloadSelectedIncompleteMembersAction(
592 memberTable, memberTableModel, null, getLayer(), this);
593 memberTable.getModel().addTableModelListener(downloadSelectedIncompleteMembersAction);
594 memberTable.getSelectionModel().addListSelectionListener(downloadSelectedIncompleteMembersAction);
595 tb.add(downloadSelectedIncompleteMembersAction);
596
597 InputMap inputMap = memberTable.getInputMap(MemberTable.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT);
598 inputMap.put((KeyStroke) removeSelectedAction.getValue(AbstractAction.ACCELERATOR_KEY), "removeSelected");
599 inputMap.put((KeyStroke) moveUpAction.getValue(AbstractAction.ACCELERATOR_KEY), "moveUp");
600 inputMap.put((KeyStroke) moveDownAction.getValue(AbstractAction.ACCELERATOR_KEY), "moveDown");
601 inputMap.put((KeyStroke) downloadIncompleteMembersAction.getValue(AbstractAction.ACCELERATOR_KEY), "downloadIncomplete");
602
603 return tb;
604 }
605
606 /**
607 * build the panel with the buttons for adding or removing the current selection
608 *
609 * @return control buttons panel for selection/members
610 */
611 protected JToolBar buildSelectionControlButtonPanel() {
612 JToolBar tb = new JToolBar(JToolBar.VERTICAL);
613 tb.setFloatable(false);
614
615 // -- add at start action
616 AddSelectedAtStartAction addSelectionAction = new AddSelectedAtStartAction(
617 memberTableModel, selectionTableModel, this);
618 selectionTableModel.addTableModelListener(addSelectionAction);
619 tb.add(addSelectionAction);
620
621 // -- add before selected action
622 AddSelectedBeforeSelection addSelectedBeforeSelectionAction = new AddSelectedBeforeSelection(
623 memberTableModel, selectionTableModel, this);
624 selectionTableModel.addTableModelListener(addSelectedBeforeSelectionAction);
625 memberTableModel.getSelectionModel().addListSelectionListener(addSelectedBeforeSelectionAction);
626 tb.add(addSelectedBeforeSelectionAction);
627
628 // -- add after selected action
629 AddSelectedAfterSelection addSelectedAfterSelectionAction = new AddSelectedAfterSelection(
630 memberTableModel, selectionTableModel, this);
631 selectionTableModel.addTableModelListener(addSelectedAfterSelectionAction);
632 memberTableModel.getSelectionModel().addListSelectionListener(addSelectedAfterSelectionAction);
633 tb.add(addSelectedAfterSelectionAction);
634
635 // -- add at end action
636 AddSelectedAtEndAction addSelectedAtEndAction = new AddSelectedAtEndAction(
637 memberTableModel, selectionTableModel, this);
638 selectionTableModel.addTableModelListener(addSelectedAtEndAction);
639 tb.add(addSelectedAtEndAction);
640
641 tb.addSeparator();
642
643 // -- select members action
644 SelectedMembersForSelectionAction selectMembersForSelectionAction = new SelectedMembersForSelectionAction(
645 memberTableModel, selectionTableModel, getLayer());
646 selectionTableModel.addTableModelListener(selectMembersForSelectionAction);
647 memberTableModel.addTableModelListener(selectMembersForSelectionAction);
648 tb.add(selectMembersForSelectionAction);
649
650 // -- select action
651 SelectPrimitivesForSelectedMembersAction selectAction = new SelectPrimitivesForSelectedMembersAction(
652 memberTable, memberTableModel, getLayer());
653 memberTable.getSelectionModel().addListSelectionListener(selectAction);
654 tb.add(selectAction);
655
656 tb.addSeparator();
657
658 // -- remove selected action
659 RemoveSelectedAction removeSelectedAction = new RemoveSelectedAction(memberTableModel, selectionTableModel, getLayer());
660 selectionTableModel.addTableModelListener(removeSelectedAction);
661 tb.add(removeSelectedAction);
662
663 return tb;
664 }
665
666 @Override
667 protected Dimension findMaxDialogSize() {
668 return new Dimension(700, 650);
669 }
670
671 @Override
672 public void setVisible(boolean visible) {
673 if (visible) {
674 tagEditorPanel.initAutoCompletion(getLayer());
675 }
676 super.setVisible(visible);
677 if (visible) {
678 sortBelowButton.setVisible(ExpertToggleAction.isExpert());
679 RelationDialogManager.getRelationDialogManager().positionOnScreen(this);
680 if (windowMenuItem == null) {
681 addToWindowMenu();
682 }
683 tagEditorPanel.requestFocusInWindow();
684 } else {
685 // make sure all registered listeners are unregistered
686 //
687 memberTable.stopHighlighting();
688 selectionTableModel.unregister();
689 memberTableModel.unregister();
690 memberTable.unlinkAsListener();
691 if (windowMenuItem != null) {
692 Main.main.menu.windowMenu.remove(windowMenuItem);
693 windowMenuItem = null;
694 }
695 dispose();
696 }
697 }
698
699 /** adds current relation editor to the windows menu (in the "volatile" group) o*/
700 protected void addToWindowMenu() {
701 String name = getRelation() == null ? tr("New Relation") : getRelation().getLocalName();
702 final String tt = tr("Focus Relation Editor with relation ''{0}'' in layer ''{1}''",
703 name, getLayer().getName());
704 name = tr("Relation Editor: {0}", name == null ? getRelation().getId() : name);
705 final JMenu wm = Main.main.menu.windowMenu;
706 final JosmAction focusAction = new JosmAction(name, "dialogs/relationlist", tt, null, false, false) {
707 @Override
708 public void actionPerformed(ActionEvent e) {
709 final RelationEditor r = (RelationEditor) getValue("relationEditor");
710 r.setVisible(true);
711 }
712 };
713 focusAction.putValue("relationEditor", this);
714 windowMenuItem = MainMenu.add(wm, focusAction, MainMenu.WINDOW_MENU_GROUP.VOLATILE);
715 }
716
717 /**
718 * checks whether the current relation has members referring to itself. If so,
719 * warns the users and provides an option for removing these members.
720 *
721 */
722 protected void cleanSelfReferences() {
723 List<OsmPrimitive> toCheck = new ArrayList<>();
724 toCheck.add(getRelation());
725 if (memberTableModel.hasMembersReferringTo(toCheck)) {
726 int ret = ConditionalOptionPaneUtil.showOptionDialog(
727 "clean_relation_self_references",
728 Main.parent,
729 tr("<html>There is at least one member in this relation referring<br>"
730 + "to the relation itself.<br>"
731 + "This creates circular dependencies and is discouraged.<br>"
732 + "How do you want to proceed with circular dependencies?</html>"),
733 tr("Warning"),
734 JOptionPane.YES_NO_OPTION,
735 JOptionPane.WARNING_MESSAGE,
736 new String[]{tr("Remove them, clean up relation"), tr("Ignore them, leave relation as is")},
737 tr("Remove them, clean up relation")
738 );
739 switch(ret) {
740 case ConditionalOptionPaneUtil.DIALOG_DISABLED_OPTION:
741 case JOptionPane.CLOSED_OPTION:
742 case JOptionPane.NO_OPTION:
743 return;
744 case JOptionPane.YES_OPTION:
745 memberTableModel.removeMembersReferringTo(toCheck);
746 break;
747 }
748 }
749 }
750
751 private void registerCopyPasteAction(AbstractAction action, Object actionName, KeyStroke shortcut) {
752 int mods = shortcut.getModifiers();
753 int code = shortcut.getKeyCode();
754 if (code != KeyEvent.VK_INSERT && (mods == 0 || mods == InputEvent.SHIFT_DOWN_MASK)) {
755 Main.info(tr("Sorry, shortcut \"{0}\" can not be enabled in Relation editor dialog"), shortcut);
756 return;
757 }
758 getRootPane().getActionMap().put(actionName, action);
759 getRootPane().getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(shortcut, actionName);
760 // Assign also to JTables because they have their own Copy&Paste implementation
761 // (which is disabled in this case but eats key shortcuts anyway)
762 memberTable.getInputMap(JComponent.WHEN_FOCUSED).put(shortcut, actionName);
763 memberTable.getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT).put(shortcut, actionName);
764 memberTable.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(shortcut, actionName);
765 selectionTable.getInputMap(JComponent.WHEN_FOCUSED).put(shortcut, actionName);
766 selectionTable.getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT).put(shortcut, actionName);
767 selectionTable.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(shortcut, actionName);
768 }
769
770 /**
771 * Exception thrown when user aborts add operation.
772 */
773 public static class AddAbortException extends Exception {
774 }
775
776 /**
777 * Asks confirmationbefore adding a primitive.
778 * @param primitive primitive to add
779 * @return {@code true} is user confirms the operation, {@code false} otherwise
780 * @throws AddAbortException if user aborts operation
781 */
782 public static boolean confirmAddingPrimitive(OsmPrimitive primitive) throws AddAbortException {
783 String msg = tr("<html>This relation already has one or more members referring to<br>"
784 + "the object ''{0}''<br>"
785 + "<br>"
786 + "Do you really want to add another relation member?</html>",
787 primitive.getDisplayName(DefaultNameFormatter.getInstance())
788 );
789 int ret = ConditionalOptionPaneUtil.showOptionDialog(
790 "add_primitive_to_relation",
791 Main.parent,
792 msg,
793 tr("Multiple members referring to same object."),
794 JOptionPane.YES_NO_CANCEL_OPTION,
795 JOptionPane.WARNING_MESSAGE,
796 null,
797 null
798 );
799 switch(ret) {
800 case ConditionalOptionPaneUtil.DIALOG_DISABLED_OPTION:
801 case JOptionPane.YES_OPTION:
802 return true;
803 case JOptionPane.NO_OPTION:
804 case JOptionPane.CLOSED_OPTION:
805 return false;
806 case JOptionPane.CANCEL_OPTION:
807 default:
808 throw new AddAbortException();
809 }
810 }
811
812 /**
813 * Warn about circular references.
814 * @param primitive the concerned primitive
815 */
816 public static void warnOfCircularReferences(OsmPrimitive primitive) {
817 String msg = tr("<html>You are trying to add a relation to itself.<br>"
818 + "<br>"
819 + "This creates circular references and is therefore discouraged.<br>"
820 + "Skipping relation ''{0}''.</html>",
821 primitive.getDisplayName(DefaultNameFormatter.getInstance()));
822 JOptionPane.showMessageDialog(
823 Main.parent,
824 msg,
825 tr("Warning"),
826 JOptionPane.WARNING_MESSAGE);
827 }
828
829 /**
830 * Adds primitives to a given relation.
831 * @param orig The relation to modify
832 * @param primitivesToAdd The primitives to add as relation members
833 * @return The resulting command
834 * @throws IllegalArgumentException if orig is null
835 */
836 public static Command addPrimitivesToRelation(final Relation orig, Collection<? extends OsmPrimitive> primitivesToAdd) {
837 CheckParameterUtil.ensureParameterNotNull(orig, "orig");
838 try {
839 final Collection<TaggingPreset> presets = TaggingPresets.getMatchingPresets(
840 EnumSet.of(TaggingPresetType.forPrimitive(orig)), orig.getKeys(), false);
841 Relation relation = new Relation(orig);
842 boolean modified = false;
843 for (OsmPrimitive p : primitivesToAdd) {
844 if (p instanceof Relation && orig.equals(p)) {
845 if (!GraphicsEnvironment.isHeadless()) {
846 warnOfCircularReferences(p);
847 }
848 continue;
849 } else if (MemberTableModel.hasMembersReferringTo(relation.getMembers(), Collections.singleton(p))
850 && !confirmAddingPrimitive(p)) {
851 continue;
852 }
853 final Set<String> roles = findSuggestedRoles(presets, p);
854 relation.addMember(new RelationMember(roles.size() == 1 ? roles.iterator().next() : "", p));
855 modified = true;
856 }
857 return modified ? new ChangeCommand(orig, relation) : null;
858 } catch (AddAbortException ign) {
859 return null;
860 }
861 }
862
863 protected static Set<String> findSuggestedRoles(final Collection<TaggingPreset> presets, OsmPrimitive p) {
864 final Set<String> roles = new HashSet<>();
865 for (TaggingPreset preset : presets) {
866 String role = preset.suggestRoleForOsmPrimitive(p);
867 if (role != null && !role.isEmpty()) {
868 roles.add(role);
869 }
870 }
871 return roles;
872 }
873
874 class MemberTableDblClickAdapter extends MouseAdapter {
875 @Override
876 public void mouseClicked(MouseEvent e) {
877 if (e.getButton() == MouseEvent.BUTTON1 && e.getClickCount() == 2) {
878 new EditAction(memberTable, memberTableModel, getLayer()).actionPerformed(null);
879 }
880 }
881 }
882}
Note: See TracBrowser for help on using the repository browser.